Class Module_cms_calendar

Description
Description | Vars (details) | Methods (details)

Module page class.

  • copyright: ocProducts Ltd

Located in /cms/pages/modules/cms_calendar.php (line 26) 

standard_aed_module
   |
   --Module_cms_calendar
Variable Summary
Description | Vars (details) | Methods (details)
mixed $array_key
mixed $award_type
mixed $code_require
mixed $donext_date
mixed $donext_type
mixed $lang_type
mixed $menu_label
mixed $non_integer_id
mixed $orderer
mixed $permissions_require
mixed $possibly_some_kind_of_upload
mixed $select_name
mixed $seo_type
mixed $table
mixed $title_is_multi_lang
mixed $user_facing
Method Summary
Description | Vars (details) | Methods (details)
array add_actualisation ()
void delete_actualisation (ID_TEXT $_id)
tempcode do_next_manager (tempcode $title, tempcode $description, ?AUTO_LINK $id)
tempcode edit_actualisation (ID_TEXT $_id)
tempcode export_ical ()
array fill_in_edit_form (ID_TEXT $id)
?array get_entry_points ()
array get_event_parameters ()
array get_form_fields ([?AUTO_LINK $type = NULL], [?integer $start_year = NULL], [?integer $start_month = NULL], [?integer $start_day = NULL], [?integer $start_hour = NULL], [?integer $start_minute = NULL], [SHORT_TEXT $title = ''], [LONG_TEXT $content = ''], [SHORT_TEXT $geo_position = ''], [SHORT_TEXT $recurrence = 'none'], [?integer $recurrences = NULL], [BINARY $seg_recurrences = 0], [BINARY $is_public = 1], [SHORT_TEXT $groups_access = ''], [SHORT_TEXT $groups_modify = ''], [integer $priority = 3], [?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 = ''])
array get_sp_overrides ()
array get_submitter (ID_TEXT $id)
tempcode import_ical ()
tempcode misc ()
tempcode nice_get_entries ()
tempcode run_start (ID_TEXT $type)
void _export_ical ()
tempcode _import_ical ()
Variables
Description | Vars (details) | Methods (details)
mixed $array_key = 'id' (line 31)
Redefinition of:
standard_aed_module::$array_key
mixed $award_type = 'event' (line 39)
Redefinition of:
standard_aed_module::$award_type
mixed $code_require = 'calendar' (line 35)
Redefinition of:
standard_aed_module::$code_require
mixed $donext_date = NULL (line 45)
mixed $donext_type = NULL (line 44)
mixed $lang_type = 'CALENDAR_EVENT' (line 28)
mixed $menu_label = 'CALENDAR' (line 41)
Redefinition of:
standard_aed_module::$menu_label
mixed $non_integer_id = false (line 33)
Redefinition of:
standard_aed_module::$non_integer_id
mixed $orderer = 'id' (line 30)
Redefinition of:
standard_aed_module::$orderer
mixed $permissions_require = 'low' (line 36)
Redefinition of:
standard_aed_module::$permissions_require
mixed $possibly_some_kind_of_upload = true (line 40)
Redefinition of:
standard_aed_module::$possibly_some_kind_of_upload
mixed $select_name = 'TITLE' (line 29)
mixed $seo_type = 'event' (line 38)
Redefinition of:
standard_aed_module::$seo_type
mixed $table = 'calendar_events' (line 34)
Redefinition of:
standard_aed_module::$table
mixed $title_is_multi_lang = true (line 32)
Redefinition of:
standard_aed_module::$title_is_multi_lang
mixed $user_facing = true (line 37)
Redefinition of:
standard_aed_module::$user_facing

Inherited Variables

Inherited from standard_aed_module

standard_aed_module::$add_one_cat_label
 standard_aed_module::$add_one_label
 standard_aed_module::$add_submit_name
 standard_aed_module::$add_text
 standard_aed_module::$alt_aed_module
 standard_aed_module::$appended_actions_already
 standard_aed_module::$archive_entry_point
 standard_aed_module::$archive_label
 standard_aed_module::$author
 standard_aed_module::$care_please
 standard_aed_module::$catalogue
 standard_aed_module::$cat_aed_module
 standard_aed_module::$check_validation
 standard_aed_module::$default_type
 standard_aed_module::$do_next_description
 standard_aed_module::$do_next_editing_categories
 standard_aed_module::$do_preview
 standard_aed_module::$edit_one_cat_label
 standard_aed_module::$edit_one_label
 standard_aed_module::$edit_submit_name
 standard_aed_module::$edit_text
 standard_aed_module::$edit_this_cat_label
 standard_aed_module::$edit_this_label
 standard_aed_module::$extra_donext_categories
 standard_aed_module::$extra_donext_entries
 standard_aed_module::$extra_donext_whatever
 standard_aed_module::$extra_donext_whatever_title
 standard_aed_module::$javascript
 standard_aed_module::$javascript_require
 standard_aed_module::$module_type
 standard_aed_module::$new_id
 standard_aed_module::$no_blank_ids
 standard_aed_module::$organisation
 standard_aed_module::$output_of_action_is_confirmation
 standard_aed_module::$permissions_cat_name
 standard_aed_module::$permissions_cat_name_b
 standard_aed_module::$permissions_cat_require
 standard_aed_module::$permissions_cat_require_b
 standard_aed_module::$permission_module
 standard_aed_module::$permission_page
 standard_aed_module::$posting_form_text
 standard_aed_module::$posting_form_text_parsed
 standard_aed_module::$posting_form_title
 standard_aed_module::$protect_first
 standard_aed_module::$redirect_type
 standard_aed_module::$second_stage_preview
 standard_aed_module::$select_name_description
 standard_aed_module::$send_validation_request
 standard_aed_module::$skip_validation
 standard_aed_module::$special_edit_frontend
 standard_aed_module::$table_prefix
 standard_aed_module::$type_code
 standard_aed_module::$upload
 standard_aed_module::$view_entry_point
Methods
Description | Vars (details) Methods (details)
add_actualisation (line 451)

Standard aed_module add actualiser.

  • return: A pair: the entry added, and a description
array add_actualisation ()
delete_actualisation (line 675)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $_id)
  • ID_TEXT $_id: The entry being deleted
do_next_manager (line 696)

The do-next manager for after calendar content management (events only).

  • return: The UI
tempcode do_next_manager (tempcode $title, tempcode $description, ?AUTO_LINK $id)
  • tempcode $title: The title (output of get_page_title)
  • tempcode $description: Some description to show, saying what happened
  • ?AUTO_LINK $id: The ID of whatever was just handled (NULL: N/A)
Redefinition of:
standard_aed_module::do_next_manager()
The do-next manager for after content management.
edit_actualisation (line 545)

Standard aed_module edit actualiser.

  • return: Description shown after editing
tempcode edit_actualisation (ID_TEXT $_id)
  • ID_TEXT $_id: The entry being edited
export_ical (line 767)

UI to display export screen fields

  • return: The UI
tempcode export_ical ()
fill_in_edit_form (line 420)

Standard aed_module edit form filler.

  • return: A tuple of: (fields, hidden-fields, delete-fields, edit-text, whether all delete fields are specified)
array fill_in_edit_form (ID_TEXT $id)
  • ID_TEXT $id: The entry being edited
get_entry_points (line 52)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
Redefinition of:
standard_aed_module::get_entry_points()
Standard modular entry-point finder function.
get_event_parameters (line 332)

Get the form posted parameters specifying an event.

  • return: A list of parameters in a certain order (see the return command to see the order)
array get_event_parameters ()
get_form_fields (line 195)

Get the form fields for an event input form.

  • return: A pair: fields, hidden fields
array get_form_fields ([?AUTO_LINK $type = NULL], [?integer $start_year = NULL], [?integer $start_month = NULL], [?integer $start_day = NULL], [?integer $start_hour = NULL], [?integer $start_minute = NULL], [SHORT_TEXT $title = ''], [LONG_TEXT $content = ''], [SHORT_TEXT $geo_position = ''], [SHORT_TEXT $recurrence = 'none'], [?integer $recurrences = NULL], [BINARY $seg_recurrences = 0], [BINARY $is_public = 1], [SHORT_TEXT $groups_access = ''], [SHORT_TEXT $groups_modify = ''], [integer $priority = 3], [?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 = ''])
  • ?AUTO_LINK $type: The event type (NULL: default)
  • ?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)
  • SHORT_TEXT $title: The title of the event
  • LONG_TEXT $content: The full text describing the event
  • SHORT_TEXT $geo_position: A geopositioning code for where the event is happening
  • 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
  • BINARY $is_public: Whether it is a public event
  • 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
  • integer $priority: The priority
  • ?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 is validated
  • BINARY $allow_rating: Whether rating is allowed
  • SHORT_INTEGER $allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
  • BINARY $allow_trackbacks: Whether trackbacks are allowed
  • LONG_TEXT $notes: Notes
get_sp_overrides (line 62)

Standard modular specific-permission-overide finder function.

  • return: A map of specific-permissions that are overridable; sp to 0 or 1. 0 means "not category overridable". 1 means "category overridable".
array get_sp_overrides ()
get_submitter (line 407)

Standard aed_module submitter getter.

  • return: The submitter, and the time of submission (null submission time implies no known submission time)
array get_submitter (ID_TEXT $id)
  • ID_TEXT $id: The entry for which the submitter is sought
import_ical (line 706)

The UI to import ical for calendar

  • return: The UI
tempcode import_ical ()
misc (line 135)

The do-next manager for before content management.

  • return: The UI
tempcode misc ()
nice_get_entries (line 157)

Standard aed_module list function.

  • return: The selection list
tempcode nice_get_entries ()
Redefinition of:
standard_aed_module::nice_get_entries()
Standard modular entry list fetcher.
run_start (line 74)

Standard aed_module run_start.

  • return: The output of the run
tempcode run_start (ID_TEXT $type)
  • ID_TEXT $type: The type of module execution
_export_ical (line 787)

The actualiser to export ical

void _export_ical ()
_import_ical (line 737)

The actualiser to import ical for calendar

  • return: The UI
tempcode _import_ical ()

Inherited Methods

Inherited From standard_aed_module

standard_aed_module::ad()
standard_aed_module::choose_catalogue()
standard_aed_module::do_next_manager()
standard_aed_module::ed()
standard_aed_module::get_entry_points()
standard_aed_module::get_permission_fields()
standard_aed_module::handle_confirmations()
standard_aed_module::info()
standard_aed_module::nice_get_entries()
standard_aed_module::preview_intercept()
standard_aed_module::run()
standard_aed_module::set_permissions()
standard_aed_module::_ad()
standard_aed_module::_ed()
standard_aed_module::__ed()

Documentation generated on Sun, 02 Jan 2011 23:11:06 +0000 by phpDocumentor 1.4.3