Docs For Class Module_cms

Description

Module page class.

copyright: ocProducts Ltd

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

standard_aed_module
   |
   --Module_cms_quiz

Variable Summary

mixed $archive_entry_point

mixed $award_type

mixed $donext_type

mixed $javascript

mixed $lang_type

mixed $menu_label

mixed $permissions_require

mixed $select_name

mixed $seo_type

mixed $user_facing

mixed $view_entry_point

Method Summary

ID_TEXT add_actualisation ()

void delete_actualisation (ID_TEXT $_id)

void edit_actualisation (ID_TEXT $_id)

tempcode fill_in_edit_form (ID_TEXT $_id)

?array get_entry_points ()

tempcode get_form_fields ([SHORT_TEXT $name = ''], [?integer $timeout = NULL], [LONG_TEXT $start_text = ''], [LONG_TEXT $end_text = ''], [LONG_TEXT $end_text_fail = ''], [LONG_TEXT $notes = ''], [integer $percentage = 70], [?TIME $open_time = NULL], [?TIME $close_time = NULL], [integer $num_winners = 2], [integer $redo_time = 96], [ID_TEXT $type = 'COMPETITION'], [BINARY $validated = 1], [?string $text = NULL], [integer $points_for_passing = 0], [?AUTO_LINK $tied_newsletter = NULL])

array get_sp_overrides ()

array get_submitter (ID_TEXT $id)

tempcode misc ()

tempcode nice_get_entries ()

tempcode run_start (ID_TEXT $type)

Variables

mixed $archive_entry_point = '_SEARCH:quiz:type=misc' (line 35)

Redefinition of:

standard_aed_module::$archive_entry_point

mixed $award_type = 'quiz' (line 33)

Redefinition of:

standard_aed_module::$award_type

mixed $donext_type = NULL (line 39)

mixed $javascript = 'var hide_func=function () { var ob=document.getElementById(\'type\'); if (ob.value==\'TEST\') { document.getElementById(\'percentage\').disabled=false; document.getElementById(\'num_winners\').disabled=true; } if (ob.value==\'COMPETITION\') { document.getElementById(\'num_winners\').disabled=false; document.getElementById(\'percentage\').disabled=true; } if (ob.value==\'SURVEY\') { document.getElementById(\'num_winners\').disabled=true; document.getElementById(\'percentage\').disabled=true; } }; document.getElementById(\'type\').onchange=hide_func; hide_func();' (line 36)

Redefinition of:

standard_aed_module::$javascript

mixed $lang_type = 'QUIZ' (line 28)

mixed $menu_label = 'QUIZZES' (line 37)

Redefinition of:

standard_aed_module::$menu_label

mixed $permissions_require = 'high' (line 30)

Redefinition of:

standard_aed_module::$permissions_require

mixed $select_name = 'NAME' (line 29)

mixed $seo_type = 'quiz' (line 32)

Redefinition of:

standard_aed_module::$seo_type

mixed $user_facing = true (line 31)

Redefinition of:

standard_aed_module::$user_facing

mixed $view_entry_point = '_SEARCH:quiz:type=do:id=_ID' (line 34)

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::$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
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::$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::$upload

Methods

add_actualisation (line 255)

Standard aed_module add actualiser.

return: The ID of the new entry

ID_TEXT add_actualisation ()

delete_actualisation (line 290)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $_id)

ID_TEXT $_id: The entry being deleted

edit_actualisation (line 272)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $_id)

ID_TEXT $_id: The entry being edited

fill_in_edit_form (line 218)

Standard aed_module edit form filler.

return: The fields

tempcode fill_in_edit_form (ID_TEXT $_id)

ID_TEXT $_id: The entry being edited

get_entry_points (line 57)

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

Get tempcode for a adding/editing form.

return: The form fields

tempcode get_form_fields ([SHORT_TEXT $name = ''], [?integer $timeout = NULL], [LONG_TEXT $start_text = ''], [LONG_TEXT $end_text = ''], [LONG_TEXT $end_text_fail = ''], [LONG_TEXT $notes = ''], [integer $percentage = 70], [?TIME $open_time = NULL], [?TIME $close_time = NULL], [integer $num_winners = 2], [integer $redo_time = 96], [ID_TEXT $type = 'COMPETITION'], [BINARY $validated = 1], [?string $text = NULL], [integer $points_for_passing = 0], [?AUTO_LINK $tied_newsletter = NULL])

SHORT_TEXT $name: The name of the quiz
?integer $timeout: The number of minutes allowed for completion (NULL: NA)
LONG_TEXT $start_text: The text shown at the start of the quiz
LONG_TEXT $end_text: The text shown at the end of the quiz
LONG_TEXT $end_text_fail: The text shown at the end of the quiz on failure
LONG_TEXT $notes: Notes
integer $percentage: Percentage correctness required for competition
?TIME $open_time: The time the quiz is opened (NULL: now)
?TIME $close_time: The time the quiz is closed (NULL: never)
integer $num_winners: The number of winners for this if it is a competition
integer $redo_time: The minimum number of hours between attempts
ID_TEXT $type: The type
BINARY $validated: Whether this is validated
?string $text: Text for questions (NULL: default)
integer $points_for_passing: The number of points awarded for completing/passing the quiz/test
?AUTO_LINK $tied_newsletter: Newsletter for which a member must be on to enter (NULL: none)

get_sp_overrides (line 46)

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

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

misc (line 85)

The do-next manager for before content management.

return: The UI

tempcode misc ()

nice_get_entries (line 109)

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

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_cms_quiz

Inherited Variables

Inherited Methods