Docs For Class Module_cms_galleries

Description

Module page class.

copyright: ocProducts Ltd

Located in /cms/pages/modules/cms_galleries.php (line 1052)

standard_aed_module
   |
   --Module_cms_galleries_alt

Variable Summary

mixed $award_type

mixed $donext_type

mixed $javascript

mixed $lang_type

mixed $menu_label

mixed $permissions_cat_name

mixed $permissions_cat_require

mixed $permissions_require

mixed $select_name

mixed $seo_type

mixed $upload

mixed $user_facing

Method Summary

ID_TEXT add_actualisation ()

?integer check_videos_allowed (ID_TEXT $cat, [boolean $tolerate_non_exist = false])

void delete_actualisation (ID_TEXT $_id)

tempcode do_next_manager (tempcode $title, tempcode $description, ?AUTO_LINK $id)

void edit_actualisation (ID_TEXT $_id)

array fill_in_edit_form (ID_TEXT $_id)

mixed get_cat (AUTO_LINK $id)

array get_form_fields ([ID_TEXT $cat = ''], [LONG_TEXT $comments = ''], [URLPATH $url = ''], [URLPATH $thumb_url = ''], [BINARY $validated = 1], [BINARY $allow_rating = 1], [SHORT_INTEGER $allow_comments = 1], [BINARY $allow_trackbacks = 1], [LONG_TEXT $notes = ''], [?integer $video_length = NULL], [?integer $video_width = NULL], [?integer $video_height = NULL])

array get_special_video_info ()

array get_submitter (ID_TEXT $id)

tempcode nice_get_ajax_tree ()

Variables

mixed $award_type = 'video' (line 1063)

Redefinition of:

standard_aed_module::$award_type

mixed $donext_type = NULL (line 1066)

mixed $javascript = 'standardAlternateFields(\'file\',\'url\'); standardAlternateFields(\'file2\',\'thumb_url\');' (line 1062)

Redefinition of:

standard_aed_module::$javascript

mixed $lang_type = 'VIDEO' (line 1054)

mixed $menu_label = 'GALLERIES' (line 1064)

Redefinition of:

standard_aed_module::$menu_label

mixed $permissions_cat_name = 'cat' (line 1058)

Redefinition of:

standard_aed_module::$permissions_cat_name

mixed $permissions_cat_require = 'galleries' (line 1057)

Redefinition of:

standard_aed_module::$permissions_cat_require

mixed $permissions_require = 'mid' (line 1056)

Redefinition of:

standard_aed_module::$permissions_require

mixed $select_name = 'NAME' (line 1055)

mixed $seo_type = 'video' (line 1060)

Redefinition of:

standard_aed_module::$seo_type

mixed $upload = 'file' (line 1061)

Redefinition of:

standard_aed_module::$upload

mixed $user_facing = true (line 1059)

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::$array_key
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::$code_require
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_require
standard_aed_module::$module_type
standard_aed_module::$new_id
standard_aed_module::$non_integer_id
standard_aed_module::$no_blank_ids
standard_aed_module::$orderer
standard_aed_module::$organisation
standard_aed_module::$output_of_action_is_confirmation
standard_aed_module::$permissions_cat_name_b
standard_aed_module::$permissions_cat_require_b
standard_aed_module::$permission_module
standard_aed_module::$permission_page
standard_aed_module::$possibly_some_kind_of_upload
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
standard_aed_module::$table_prefix
standard_aed_module::$title_is_multi_lang
standard_aed_module::$type_code
standard_aed_module::$view_entry_point

Methods

add_actualisation (line 1284)

Standard aed_module add actualiser.

return: The ID of the entry added

ID_TEXT add_actualisation ()

check_videos_allowed (line 1075)

Kills ocPortal if someone is trying to add a video to a gallery that does not support videos.

return: Number allowed remaining (NULL: no limit)

?integer check_videos_allowed (ID_TEXT $cat, [boolean $tolerate_non_exist = false])

ID_TEXT $cat: The gallery
boolean $tolerate_non_exist: Whether to tolerate the non-existance of the gallery

delete_actualisation (line 1367)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $_id)

ID_TEXT $_id: The entry being deleted

do_next_manager (line 1386)

The do-next manager for after content management.

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 1321)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $_id)

ID_TEXT $_id: The entry being edited

fill_in_edit_form (line 1251)

Standard aed_module edit form filler.

return: A tuple of lots of info

array fill_in_edit_form (ID_TEXT $_id)

ID_TEXT $_id: The entry being edited

get_cat (line 1238)

Standard aed_module cat getter.

return: The cat

mixed get_cat (AUTO_LINK $id)

AUTO_LINK $id: The entry for which the cat is sought

get_form_fields (line 1186)

Get tempcode for a video adding/editing form.

return: A pair: the tempcode for the visible fields, and the tempcode for the hidden fields

array get_form_fields ([ID_TEXT $cat = ''], [LONG_TEXT $comments = ''], [URLPATH $url = ''], [URLPATH $thumb_url = ''], [BINARY $validated = 1], [BINARY $allow_rating = 1], [SHORT_INTEGER $allow_comments = 1], [BINARY $allow_trackbacks = 1], [LONG_TEXT $notes = ''], [?integer $video_length = NULL], [?integer $video_width = NULL], [?integer $video_height = NULL])

ID_TEXT $cat: The gallery
LONG_TEXT $comments: The video description
URLPATH $url: The URL to the video file (blank: not yet added)
URLPATH $thumb_url: The URL to the thumbnail
BINARY $validated: Video validation status
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 for the video
?integer $video_length: The length of the video (NULL: not yet added, so not yet known)
?integer $video_width: The width of the video (NULL: not yet added, so not yet known)
?integer $video_height: The height of the video (NULL: not yet added, so not yet known)

get_special_video_info (line 1113)

Extract video meta info from any uploaded video.

return: A triplet of 3 "?integer"'s: video width, video height, video length

array get_special_video_info ()

get_submitter (line 1225)

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

nice_get_ajax_tree (line 1163)

Standard aed_module list function.

return: The tree field

tempcode nice_get_ajax_tree ()

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()

Class Module_cms_galleries_alt

Inherited Variables

Inherited Methods