Docs For Class Module_cms_catalogues

Description

Module page class.

copyright: ocProducts Ltd

Located in /cms/pages/modules/cms_catalogues.php (line 647)

standard_aed_module
   |
   --Module_cms_catalogues_cat

Variable Summary

mixed $award_type

mixed $catalogue

mixed $donext_catalogue_name

mixed $javascript

mixed $lang_type

mixed $menu_label

mixed $permissions_cat_name

mixed $permissions_cat_require

mixed $permissions_require

mixed $permission_module

mixed $select_name

mixed $seo_type

mixed $upload

Method Summary

AUTO_LINK add_actualisation ()

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)

string get_cat (AUTO_LINK $id)

array get_form_fields ([?ID_TEXT $catalogue_name = NULL], [SHORT_TEXT $title = ''], [LONG_TEXT $description = ''], [LONG_TEXT $notes = ''], [?AUTO_LINK $parent_id = -1], [?AUTO_LINK $id = NULL], [URLPATH $rep_image = ''], [integer $move_days_lower = 30], [integer $move_days_higher = 60], [?AUTO_LINK $move_target = NULL])

tempcode nice_get_ajax_tree ()

Variables

mixed $award_type = 'catalogue_category' (line 657)

Redefinition of:

standard_aed_module::$award_type

mixed $catalogue = true (line 656)

Redefinition of:

standard_aed_module::$catalogue

mixed $donext_catalogue_name (line 662)

mixed $javascript = 'var mt=document.getElementById(\'move_target\'); var form=mt.form; var crf=function() { var s=mt.selectedIndex==0; form.elements[\'move_days_lower\'].disabled=s; form.elements[\'move_days_higher\'].disabled=s; }; crf(); mt.onclick=crf;' (line 659)

Redefinition of:

standard_aed_module::$javascript

mixed $lang_type = 'CATALOGUE_CATEGORY' (line 649)

mixed $menu_label = 'CATALOGUES' (line 660)

Redefinition of:

standard_aed_module::$menu_label

mixed $permissions_cat_name = 'catalogue_name' (line 654)

Redefinition of:

standard_aed_module::$permissions_cat_name

mixed $permissions_cat_require = 'catalogues_catalogue' (line 653)

Redefinition of:

standard_aed_module::$permissions_cat_require

mixed $permissions_require = 'cat_mid' (line 651)

Redefinition of:

standard_aed_module::$permissions_require

mixed $permission_module = 'catalogues_category' (line 652)

Redefinition of:

standard_aed_module::$permission_module

mixed $select_name = 'NAME' (line 650)

mixed $seo_type = 'catalogue_category' (line 655)

Redefinition of:

standard_aed_module::$seo_type

mixed $upload = 'image' (line 658)

Redefinition of:

standard_aed_module::$upload

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::$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_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::$user_facing
standard_aed_module::$view_entry_point

Methods

add_actualisation (line 767)

Standard aed_module add actualiser.

return: The ID of what was added

AUTO_LINK add_actualisation ()

delete_actualisation (line 835)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

do_next_manager (line 852)

The do-next manager for after catalogue 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 catalogue category was just handled (NULL: deleted)

Redefinition of:

standard_aed_module::do_next_manager(): The do-next manager for after content management.

edit_actualisation (line 799)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $_id)

ID_TEXT $_id: The entry being edited

fill_in_edit_form (line 745)

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

Standard aed_module cat getter.

return: The cat

string get_cat (AUTO_LINK $id)

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

get_form_fields (line 690)

Get tempcode for a catalogue category 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 $catalogue_name = NULL], [SHORT_TEXT $title = ''], [LONG_TEXT $description = ''], [LONG_TEXT $notes = ''], [?AUTO_LINK $parent_id = -1], [?AUTO_LINK $id = NULL], [URLPATH $rep_image = ''], [integer $move_days_lower = 30], [integer $move_days_higher = 60], [?AUTO_LINK $move_target = NULL])

?ID_TEXT $catalogue_name: The name of the catalogue the category is in (NULL: detect)
SHORT_TEXT $title: The title of the category
LONG_TEXT $description: Description for the category
LONG_TEXT $notes: Admin notes
?AUTO_LINK $parent_id: The ID of the parent category (NULL: no parent) (-1: arbitrary default)
?AUTO_LINK $id: The ID of this category (NULL: we're adding, not editing)
URLPATH $rep_image: The rep-image for the catalogue category
integer $move_days_lower: The number of days before expiry (lower limit)
integer $move_days_higher: The number of days before expiry (higher limit)
?AUTO_LINK $move_target: The expiry category (NULL: do not expire)

nice_get_ajax_tree (line 669)

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_catalogues_cat

Inherited Variables

Inherited Methods