Function __global->edit_calendar_event
Definitions
sources/calendar2.php
- Edit a calendar event.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the event |
| $type | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The event type (null: default) |
| $recurrence | SHORT_TEXT | No | No | required parameter | N/A | N/A | The recurrence code |
| $recurrences | ?integer | No | No | required parameter | N/A | N/A | The number of recurrences (null: none/infinite) |
| $seg_recurrences | BINARY | No | No | required parameter | N/A | N/A | Whether to segregate the comment-topics/rating/trackbacks per-recurrence |
| $title | SHORT_TEXT | No | No | required parameter | N/A | N/A | The title of the event |
| $content | LONG_TEXT | No | No | required parameter | N/A | N/A | The full text describing the event |
| $priority | integer | No | No | required parameter | N/A | 1 5 | The priority |
| $start_year | integer | No | No | required parameter | N/A | N/A | The year the event starts at |
| $start_month | integer | No | No | required parameter | N/A | N/A | The month the event starts at |
| $start_day | integer | No | No | required parameter | N/A | N/A | The day the event starts at |
| $start_monthly_spec_type | ID_TEXT | No | No | required parameter | day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards | N/A | In-month specification type for start date |
| $start_hour | ?integer | No | No | required parameter | N/A | N/A | The hour the event starts at (null: all day) |
| $start_minute | ?integer | No | No | required parameter | N/A | N/A | The minute the event starts at (null: all day) |
| $end_year | ?integer | No | No | required parameter | N/A | N/A | The year the event ends at (null: not a multi day event) |
| $end_month | ?integer | No | No | required parameter | N/A | N/A | The month the event ends at (null: not a multi day event) |
| $end_day | ?integer | No | No | required parameter | N/A | N/A | The day the event ends at (null: not a multi day event) |
| $end_monthly_spec_type | ID_TEXT | No | No | required parameter | day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards | N/A | In-month specification type for end date |
| $end_hour | ?integer | No | No | required parameter | N/A | N/A | The hour the event ends at (null: not a multi day event) |
| $end_minute | ?integer | No | No | required parameter | N/A | N/A | The minute the event ends at (null: not a multi day event) |
| $timezone | ?ID_TEXT | No | No | required parameter | N/A | N/A | The timezone for the event (null: current user's timezone) |
| $do_timezone_conv | BINARY | No | No | required parameter | N/A | N/A | Whether the time should be presented in the viewer's own timezone |
| $member_calendar | ?MEMBER | No | No | required parameter | N/A | N/A | The member's calendar it will be on (null: not on a specific member's calendar) |
| $meta_keywords | SHORT_TEXT | No | No | required parameter | N/A | N/A | Meta keywords |
| $meta_description | LONG_TEXT | No | No | required parameter | N/A | N/A | Meta description |
Preview
Code (PHP)
/**
* Edit a calendar event.
*
* @param AUTO_LINK $id The ID of the event
* @param ?AUTO_LINK $type The event type (null: default)
* @param SHORT_TEXT $recurrence The recurrence code
* @param ?integer $recurrences The number of recurrences (null: none/infinite)
* @param BINARY $seg_recurrences Whether to segregate the comment-topics/rating/trackbacks per-recurrence
* @param SHORT_TEXT $title The title of the event
* @param LONG_TEXT $content The full text describing the event
* @param integer $priority The priority
* @range 1 5
* @param integer $start_year The year the event starts at
* @param integer $start_month The month the event starts at
* @param integer $start_day The day the event starts at
* @param ID_TEXT $start_monthly_spec_type In-month specification type for start date
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $start_hour The hour the event starts at (null: all day)
* @param ?integer $start_minute The minute the event starts at (null: all day)
* @param ?integer $end_year The year the event ends at (null: not a multi day event)
* @param ?integer $end_month The month the event ends at (null: not a multi day event)
* @param ?integer $end_day The day the event ends at (null: not a multi day event)
* @param ID_TEXT $end_monthly_spec_type In-month specification type for end date
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $end_hour The hour the event ends at (null: not a multi day event)
* @param ?integer $end_minute The minute the event ends at (null: not a multi day event)
* @param ?ID_TEXT $timezone The timezone for the event (null: current user's timezone)
* @param BINARY $do_timezone_conv Whether the time should be presented in the viewer's own timezone
* @param ?MEMBER $member_calendar The member's calendar it will be on (null: not on a specific member's calendar)
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
*/
function edit_calendar_event(int $id, ?int $type, string $recurrence, ?int $recurrences, int $seg_recurrences, string $title, string $content, int $priority, int $start_year, int $start_month, int $start_day, string $start_monthly_spec_type, ?int $start_hour, ?int $start_minute, ?int $end_year, ?int $end_month, ?int $end_day, string $end_monthly_spec_type, ?int $end_hour, ?int $end_minute, ?string $timezone, int $do_timezone_conv, ?int $member_calendar, string $meta_keywords, string $meta_description)
* Edit a calendar event.
*
* @param AUTO_LINK $id The ID of the event
* @param ?AUTO_LINK $type The event type (null: default)
* @param SHORT_TEXT $recurrence The recurrence code
* @param ?integer $recurrences The number of recurrences (null: none/infinite)
* @param BINARY $seg_recurrences Whether to segregate the comment-topics/rating/trackbacks per-recurrence
* @param SHORT_TEXT $title The title of the event
* @param LONG_TEXT $content The full text describing the event
* @param integer $priority The priority
* @range 1 5
* @param integer $start_year The year the event starts at
* @param integer $start_month The month the event starts at
* @param integer $start_day The day the event starts at
* @param ID_TEXT $start_monthly_spec_type In-month specification type for start date
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $start_hour The hour the event starts at (null: all day)
* @param ?integer $start_minute The minute the event starts at (null: all day)
* @param ?integer $end_year The year the event ends at (null: not a multi day event)
* @param ?integer $end_month The month the event ends at (null: not a multi day event)
* @param ?integer $end_day The day the event ends at (null: not a multi day event)
* @param ID_TEXT $end_monthly_spec_type In-month specification type for end date
* @set day_of_month day_of_month_backwards dow_of_month dow_of_month_backwards
* @param ?integer $end_hour The hour the event ends at (null: not a multi day event)
* @param ?integer $end_minute The minute the event ends at (null: not a multi day event)
* @param ?ID_TEXT $timezone The timezone for the event (null: current user's timezone)
* @param BINARY $do_timezone_conv Whether the time should be presented in the viewer's own timezone
* @param ?MEMBER $member_calendar The member's calendar it will be on (null: not on a specific member's calendar)
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
*/
function edit_calendar_event(int $id, ?int $type, string $recurrence, ?int $recurrences, int $seg_recurrences, string $title, string $content, int $priority, int $start_year, int $start_month, int $start_day, string $start_monthly_spec_type, ?int $start_hour, ?int $start_minute, ?int $end_year, ?int $end_month, ?int $end_day, string $end_monthly_spec_type, ?int $end_hour, ?int $end_minute, ?string $timezone, int $do_timezone_conv, ?int $member_calendar, string $meta_keywords, string $meta_description)
