Docs For Class Module_admin_ocf

Description

Module page class.

copyright: ocProducts Ltd

Located in /adminzone/pages/modules/admin_ocf_forums.php (line 26)

standard_aed_module
   |
   --Module_admin_ocf_forums

Variable Summary

mixed $archive_entry_point

mixed $archive_label

mixed $award_type

mixed $do_preview

mixed $javascript

mixed $lang_type

mixed $menu_label

mixed $permission_module

mixed $permission_page

mixed $protect_first

mixed $select_name

mixed $special_edit_frontend

mixed $view_entry_point

Method Summary

ID_TEXT add_actualisation ()

void delete_actualisation (ID_TEXT $id)

tempcode ed ()

void edit_actualisation (ID_TEXT $id)

array fill_in_edit_form (ID_TEXT $id)

?array get_entry_points ()

array get_form_fields ([?AUTO_LINK $id = NULL], [SHORT_TEXT $name = ''], [LONG_TEXT $description = ''], [?AUTO_LINK $category_id = NULL], [?AUTO_LINK $parent_forum = NULL], [?integer $position = NULL], [BINARY $post_count_increment = 1], [BINARY $order_sub_alpha = 0], [LONG_TEXT $intro_question = ''], [LONG_TEXT $intro_answer = ''], [SHORT_TEXT $redirection = ''], [ID_TEXT $order = 'last_post'])

tempcode get_forum_tree (AUTO_LINK $id, SHORT_TEXT $forum, array &$all_forums, [integer $position = 0], [integer $sub_num_in_parent_category = 1], [?BINARY $order_sub_alpha = NULL], [?BINARY $parent_order_sub_alpha = NULL], [boolean $huge = false])

boolean may_delete_this (ID_TEXT $_id)

tempcode misc ()

tempcode reorder ()

tempcode run_start (ID_TEXT $type)

Variables

mixed $archive_entry_point = '_SEARCH:forumview' (line 31)

Redefinition of:

standard_aed_module::$archive_entry_point

mixed $archive_label = 'SECTION_FORUMS' (line 32)

Redefinition of:

standard_aed_module::$archive_label

mixed $award_type = 'forum' (line 37)

Redefinition of:

standard_aed_module::$award_type

mixed $do_preview = NULL (line 40)

Redefinition of:

standard_aed_module::$do_preview

mixed $javascript = 'if (document.getElementById(\'delete\')) { var form=document.getElementById(\'delete\').form; var crf=function() { form.elements[\'target_forum\'].disabled=(!form.elements[\'delete\'].checked); form.elements[\'delete_topics\'].disabled=(!form.elements[\'delete\'].checked); }; crf(); form.elements[\'delete\'].onchange=crf; }' (line 38)

Redefinition of:

standard_aed_module::$javascript

mixed $lang_type = 'FORUM' (line 28)

mixed $menu_label = 'SECTION_FORUMS' (line 39)

Redefinition of:

standard_aed_module::$menu_label

mixed $permission_module = 'forums' (line 36)

Redefinition of:

standard_aed_module::$permission_module

mixed $permission_page = 'topics' (line 35)

Redefinition of:

standard_aed_module::$permission_page

mixed $protect_first = 1 (line 30)

Redefinition of:

standard_aed_module::$protect_first

mixed $select_name = 'NAME' (line 29)

mixed $special_edit_frontend = true (line 34)

Redefinition of:

standard_aed_module::$special_edit_frontend

mixed $view_entry_point = '_SEARCH:forumview:id=_ID' (line 33)

Redefinition of:

standard_aed_module::$view_entry_point

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::$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::$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
standard_aed_module::$permissions_cat_name_b
standard_aed_module::$permissions_cat_require
standard_aed_module::$permissions_cat_require_b
standard_aed_module::$permissions_require
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::$redirect_type
standard_aed_module::$second_stage_preview
standard_aed_module::$select_name_description
standard_aed_module::$send_validation_request
standard_aed_module::$seo_type
standard_aed_module::$skip_validation
standard_aed_module::$table
standard_aed_module::$table_prefix
standard_aed_module::$title_is_multi_lang
standard_aed_module::$type_code
standard_aed_module::$upload
standard_aed_module::$user_facing

Methods

add_actualisation (line 442)

Standard aed_module add actualiser.

return: The entry added

ID_TEXT add_actualisation ()

delete_actualisation (line 543)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

ed (line 313)

The UI to choose a forum to edit (relies on get_forum_tree to do almost all the work).

return: The UI

tempcode ed ()

Redefinition of:

standard_aed_module::ed(): Standard modular UI to choose an entry to edit.

edit_actualisation (line 500)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being edited

fill_in_edit_form (line 416)

Standard aed_module edit form filler.

return: A tuple: fields, hidden-fields, delete-fields, N/A, N/A, N/A, action fields

array fill_in_edit_form (ID_TEXT $id)

ID_TEXT $id: The entry being edited

get_entry_points (line 47)

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_form_fields (line 117)

Get tempcode for a forum adding/editing form.

return: A pair: The input fields, Hidden fields

array get_form_fields ([?AUTO_LINK $id = NULL], [SHORT_TEXT $name = ''], [LONG_TEXT $description = ''], [?AUTO_LINK $category_id = NULL], [?AUTO_LINK $parent_forum = NULL], [?integer $position = NULL], [BINARY $post_count_increment = 1], [BINARY $order_sub_alpha = 0], [LONG_TEXT $intro_question = ''], [LONG_TEXT $intro_answer = ''], [SHORT_TEXT $redirection = ''], [ID_TEXT $order = 'last_post'])

?AUTO_LINK $id: The ID of the forum being edited (NULL: adding, not editing)
SHORT_TEXT $name: The name of the forum
LONG_TEXT $description: The description of the forum
?AUTO_LINK $category_id: The ID of the category for the forum (NULL: first)
?AUTO_LINK $parent_forum: The parent forum (NULL: root)
?integer $position: The position (NULL: next)
BINARY $post_count_increment: Whether post counts are incremented in this forum
BINARY $order_sub_alpha: Whether subforums are ordered alphabetically (instead of manually)
LONG_TEXT $intro_question: Introductory question posed to all newcomers to the forum
LONG_TEXT $intro_answer: Answer to the introductory question (or blank if it was just an 'ok')
SHORT_TEXT $redirection: Redirection code (blank implies a normal forum, not a redirector)
ID_TEXT $order: The order the topics are shown in, by default.

get_forum_tree (line 179)

Get a UI to choose a forum to edit.

return: The UI

tempcode get_forum_tree (AUTO_LINK $id, SHORT_TEXT $forum, array &$all_forums, [integer $position = 0], [integer $sub_num_in_parent_category = 1], [?BINARY $order_sub_alpha = NULL], [?BINARY $parent_order_sub_alpha = NULL], [boolean $huge = false])

AUTO_LINK $id: The ID of the forum we are generating the tree below (start recursion with db_get_first_id())
SHORT_TEXT $forum: The name of the forum $id
array &$all_forums: A list of rows of all forums, or array() if the function is to get the list itself
integer $position: The relative position of this forum wrt the others on the same level/branch in the UI
integer $sub_num_in_parent_category: The number of forums in the parent category
?BINARY $order_sub_alpha: Whether to order own subcategories alphabetically (NULL: ask the DB)
?BINARY $parent_order_sub_alpha: Whether to order subcategories alphabetically (NULL: ask the DB)
boolean $huge: Whether we are dealing with a huge forum structure

may_delete_this (line 386)

Standard aed_module delete possibility checker.

return: Whether it may be deleted

boolean may_delete_this (ID_TEXT $_id)

ID_TEXT $_id: The entry being potentially deleted

misc (line 85)

The do-next manager for before content management.

return: The UI

tempcode misc ()

reorder (line 338)

The actualiser to reorder forums.

return: The UI

tempcode reorder ()

run_start (line 58)

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

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_admin_ocf_forums

Inherited Variables

Inherited Methods