add_calendar_event (line 58)
Add a calendar event.
AUTO_LINK
add_calendar_event
(SHORT_TEXT $geo_position, SHORT_TEXT $groups_access, SHORT_TEXT $groups_modify, AUTO_LINK $type, SHORT_TEXT $recurrence, ?integer $recurrences, BINARY $seg_recurrences, SHORT_TEXT $title, LONG_TEXT $content, integer $priority, BINARY $is_public, ?integer $start_year, ?integer $start_month, ?integer $start_day, ?integer $start_hour, ?integer $start_minute, [?integer $end_year = NULL], [?integer $end_month = NULL], [?integer $end_day = NULL], [?integer $end_hour = NULL], [?integer $end_minute = NULL], [BINARY $validated = 1], [BINARY $allow_rating = 1], [SHORT_INTEGER $allow_comments = 1], [BINARY $allow_trackbacks = 1], [LONG_TEXT $notes = ''], [?MEMBER $submitter = NULL], [integer $views = 0], [?TIME $add_date = NULL], [?TIME $edit_date = NULL], [?AUTO_LINK $id = NULL])
-
SHORT_TEXT
$geo_position: A geopositioning code for where the event is happening (not currently used by ocPortal - may be removed)
-
SHORT_TEXT
$groups_access: A comma-separated list of usergroups that have access (not currently used by ocPortal - may be removed)
-
SHORT_TEXT
$groups_modify: A comma-separated list of usergroups that have write access (not currently used by ocPortal - may be removed)
-
AUTO_LINK
$type: The event type
-
SHORT_TEXT
$recurrence: The recurrence code (set to 'none' for no recurrences: blank means infinite and will basically time-out ocPortal)
-
?integer
$recurrences: The number of recurrences (NULL: none/infinite)
-
BINARY
$seg_recurrences: Whether to segregate the comment-topics/rating/trackbacks per-recurrence
-
SHORT_TEXT
$title: The title of the event
-
LONG_TEXT
$content: The full text describing the event
-
integer
$priority: The priority
-
BINARY
$is_public: Whether it is a public event
-
?integer
$start_year: The year the event starts at (NULL: default)
-
?integer
$start_month: The month the event starts at (NULL: default)
-
?integer
$start_day: The day the event starts at (NULL: default)
-
?integer
$start_hour: The hour the event starts at (NULL: default)
-
?integer
$start_minute: The minute the event starts at (NULL: default)
-
?integer
$end_year: The year the event ends at (NULL: not a multi day event)
-
?integer
$end_month: The month the event ends at (NULL: not a multi day event)
-
?integer
$end_day: The day the event ends at (NULL: not a multi day event)
-
?integer
$end_hour: The hour the event ends at (NULL: not a multi day event)
-
?integer
$end_minute: The minute the event ends at (NULL: not a multi day event)
-
BINARY
$validated: Whether the event has been validated
-
BINARY
$allow_rating: Whether the event may be rated
-
SHORT_INTEGER
$allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
-
BINARY
$allow_trackbacks: Whether the event may be trackbacked
-
LONG_TEXT
$notes: Hidden notes pertaining to the download
-
?MEMBER
$submitter: The event submitter (NULL: current member)
-
integer
$views: The number of views so far
-
?TIME
$add_date: The add time (NULL: now)
-
?TIME
$edit_date: The edit time (NULL: never)
-
?AUTO_LINK
$id: Force an ID (NULL: don't force an ID)
add_event_type (line 388)
Add a calendar event type.
AUTO_LINK
add_event_type
(SHORT_TEXT $title, ID_TEXT $logo)
-
SHORT_TEXT
$title: The title of the event type
-
ID_TEXT
$logo: The theme image code
delete_calendar_event (line 232)
Delete a calendar event.
void
delete_calendar_event
(AUTO_LINK $id)
-
AUTO_LINK
$id: The ID of the event
delete_event_type (line 431)
Delete a calendar event type.
void
delete_event_type
(AUTO_LINK $id)
-
AUTO_LINK
$id: The ID of the event type
edit_calendar_event (line 164)
Edit a calendar event.
void
edit_calendar_event
(AUTO_LINK $id, SHORT_TEXT $geo_position, SHORT_TEXT $groups_access, SHORT_TEXT $groups_modify, ?AUTO_LINK $type, SHORT_TEXT $recurrence, ?integer $recurrences, BINARY $seg_recurrences, SHORT_TEXT $title, LONG_TEXT $content, integer $priority, BINARY $is_public, ?integer $start_year, ?integer $start_month, ?integer $start_day, ?integer $start_hour, ?integer $start_minute, ?integer $end_year, ?integer $end_month, ?integer $end_day, ?integer $end_hour, ?integer $end_minute, SHORT_TEXT $meta_keywords, LONG_TEXT $meta_description, BINARY $validated, BINARY $allow_rating, SHORT_INTEGER $allow_comments, BINARY $allow_trackbacks, LONG_TEXT $notes)
-
AUTO_LINK
$id: The ID of the event
-
SHORT_TEXT
$geo_position: A geopositioning code for where the event is happening
-
SHORT_TEXT
$groups_access: A comma-separated list of usergroups that have access
-
SHORT_TEXT
$groups_modify: A comma-separated list of usergroups that have write access
-
?AUTO_LINK
$type: The event type (NULL: default)
-
SHORT_TEXT
$recurrence: The recurrence code
-
?integer
$recurrences: The number of recurrences (NULL: none/infinite)
-
BINARY
$seg_recurrences: Whether to segregate the comment-topics/rating/trackbacks per-recurrence
-
SHORT_TEXT
$title: The title of the event
-
LONG_TEXT
$content: The full text describing the event
-
integer
$priority: The priority
-
BINARY
$is_public: Whether it is a public event
-
?integer
$start_year: The year the event starts at (NULL: default)
-
?integer
$start_month: The month the event starts at (NULL: default)
-
?integer
$start_day: The day the event starts at (NULL: default)
-
?integer
$start_hour: The hour the event starts at (NULL: default)
-
?integer
$start_minute: The minute the event starts at (NULL: default)
-
?integer
$end_year: The year the event ends at (NULL: not a multi day event)
-
?integer
$end_month: The month the event ends at (NULL: not a multi day event)
-
?integer
$end_day: The day the event ends at (NULL: not a multi day event)
-
?integer
$end_hour: The hour the event ends at (NULL: not a multi day event)
-
?integer
$end_minute: The minute the event ends at (NULL: not a multi day event)
-
SHORT_TEXT
$meta_keywords: Meta keywords
-
LONG_TEXT
$meta_description: Meta description
-
BINARY
$validated: Whether the download has been validated
-
BINARY
$allow_rating: Whether the download may be rated
-
SHORT_INTEGER
$allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
-
BINARY
$allow_trackbacks: Whether the download may be trackbacked
-
LONG_TEXT
$notes: Hidden notes pertaining to the download
edit_event_type (line 406)
Edit a calendar event type.
void
edit_event_type
(AUTO_LINK $id, SHORT_TEXT $title, ID_TEXT $logo)
-
AUTO_LINK
$id: The ID of the event type
-
SHORT_TEXT
$title: The title of the event type
-
ID_TEXT
$logo: The theme image code
facebook_wall_event_update (line 321)
Update new event to facebook wall
boolean
facebook_wall_event_update
(AUTO_LINK $id, SHORT_TEXT $title, SHORT_TEXT $message, BINARY $validated, AUTO_LINK $type, [boolean $update = true])
-
AUTO_LINK
$id: The ID of the event
-
SHORT_TEXT
$title: Event title
-
SHORT_TEXT
$message: Event description
-
BINARY
$validated: Whether the event has been validated
-
AUTO_LINK
$type: Event type
-
boolean
$update: Current process indication. If it is update, need to check it's old "validated" state
twitter_event_update (line 269)
Update new event to twitter
boolean
twitter_event_update
(AUTO_LINK $id, SHORT_TEXT $message, BINARY $validated, [boolean $update = true])
-
AUTO_LINK
$id: The ID of the event
-
SHORT_TEXT
$message: Event description
-
BINARY
$validated: Whether the event has been validated
-
boolean
$update: Current process indication. If it is update, need to check it's old "validated" state