Function Module_cms_calendar->get_form_fields

Definitions

cms/pages/modules/cms_calendar.php

  • Get the form fields for an event input form.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$id ?AUTO_LINK Null N/A N/A The event ID (null: new)
$type ?AUTO_LINK Null N/A N/A The event type (null: default)
$start_year ?integer Null N/A N/A The year the event starts at (null: default)
$start_month ?integer Null N/A N/A The month the event starts at (null: default)
$start_day ?integer Null N/A N/A The day the event starts at (null: default)
$start_monthly_spec_type ID_TEXT day_of_month N/A N/A In-month specification type for start date
$start_hour ?integer Null N/A N/A The hour the event starts at (null: default)
$start_minute ?integer Null N/A N/A The minute the event starts at (null: default)
$title SHORT_TEXT Blank (empty string) N/A N/A The title of the event
$content LONG_TEXT Blank (empty string) N/A N/A The full text describing the event
$recurrence SHORT_TEXT none N/A N/A The recurrence code
$recurrences ?integer Null N/A N/A The number of recurrences (null: none/infinite)
$seg_recurrences BINARY 0 N/A N/A Whether to segregate the comment-topics/rating/trackbacks per-recurrence
$priority integer 3 N/A N/A The priority
$end_year ?integer Null N/A N/A The year the event ends at (null: not a multi day event)
$end_month ?integer Null N/A N/A The month the event ends at (null: not a multi day event)
$end_day ?integer Null N/A N/A The day the event ends at (null: not a multi day event)
$end_monthly_spec_type ID_TEXT day_of_month N/A N/A In-month specification type for end date
$end_hour ?integer Null N/A N/A The hour the event ends at (null: not a multi day event)
$end_minute ?integer Null N/A N/A The minute the event ends at (null: not a multi day event)
$timezone ?ID_TEXT Null N/A N/A The timezone for the event (null: current user's timezone)
$do_timezone_conv BINARY 0 N/A N/A Whether the time should be presented in the viewer's own timezone
$member_calendar ?MEMBER Null N/A N/A The member's calendar it will be on (null: not on a specific member's calendar)
$validated BINARY 1 N/A N/A Whether the event is validated
$allow_rating ?BINARY Null N/A N/A Whether rating is allowed (null: decide statistically, based on existing choices)
$allow_comments ?SHORT_INTEGER Null N/A N/A Whether comments are allowed (0=no, 1=yes, 2=review style) (null: decide statistically, based on existing choices)
$allow_trackbacks ?BINARY Null N/A N/A Whether trackbacks are allowed (null: decide statistically, based on existing choices)
$notes LONG_TEXT Blank (empty string) N/A N/A Notes
$regions array [] N/A N/A The regions (empty: not region-limited)

Return

  • A tuple: The input fields, Hidden fields, ...
  • Type: array
  • Set: N/A
  • Range: N/A