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 |
|---|---|---|---|---|---|---|---|
| $validated | ?BINARY | No | No | required parameter | N/A | N/A | Whether the event has been validated (null: don't change) |
| $allow_rating | BINARY | No | No | required parameter | N/A | N/A | Whether the event may be rated |
| $allow_comments | SHORT_INTEGER | No | No | required parameter | N/A | N/A | Whether comments are allowed (0=no, 1=yes, 2=review style) |
| $allow_trackbacks | BINARY | No | No | required parameter | N/A | N/A | Whether the event may be trackbacked |
| $notes | LONG_TEXT | No | No | required parameter | N/A | N/A | Hidden notes pertaining to the event |
| $edit_time | ?TIME | No | No | Null | N/A | N/A | Edit time (null: either means current time, or if $null_is_literal, means reset to to null) |
| $add_time | ?TIME | No | No | Null | N/A | N/A | Add time (null: do not change) |
| $views | ?integer | No | No | Null | N/A | N/A | Number of views (null: do not change) |
| $submitter | ?MEMBER | No | No | Null | N/A | N/A | Submitter (null: do not change) |
| $regions | array | No | No | [] | N/A | N/A | The regions (empty: not region-limited) |
| $null_is_literal | boolean | No | No | False | N/A | N/A | Determines whether some nulls passed mean 'use a default' or literally mean 'set to null' |
Preview
Code (PHP)
/**
* Edit a calendar event.
*
* @param ?BINARY $validated Whether the event has been validated (null: don't change)
* @param BINARY $allow_rating Whether the event may be rated
* @param SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style)
* @param BINARY $allow_trackbacks Whether the event may be trackbacked
* @param LONG_TEXT $notes Hidden notes pertaining to the event
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param array $regions The regions (empty: not region-limited)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
*/
function edit_calendar_event(?int $validated, int $allow_rating, int $allow_comments, int $allow_trackbacks, string $notes, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, array $regions = [], bool $null_is_literal = false)
* Edit a calendar event.
*
* @param ?BINARY $validated Whether the event has been validated (null: don't change)
* @param BINARY $allow_rating Whether the event may be rated
* @param SHORT_INTEGER $allow_comments Whether comments are allowed (0=no, 1=yes, 2=review style)
* @param BINARY $allow_trackbacks Whether the event may be trackbacked
* @param LONG_TEXT $notes Hidden notes pertaining to the event
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param array $regions The regions (empty: not region-limited)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
*/
function edit_calendar_event(?int $validated, int $allow_rating, int $allow_comments, int $allow_trackbacks, string $notes, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, array $regions = [], bool $null_is_literal = false)
