Docs For Class Module_cms

Class Module_cms_banners

Description

Module page class.

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

standard_aed_module
   |
   --Module_cms_banners

Variable Summary

mixed $do_next_type

mixed $javascript

mixed $lang_type

mixed $menu_label

mixed $non_integer_id

mixed $permissions_require

mixed $permission_module

mixed $select_name

mixed $select_name_description

mixed $upload

mixed $user_facing

mixed $view_entry_point

Method Summary

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

?array get_entry_points ()

array get_form_fields ([ID_TEXT $name = ''], [URLPATH $image_url = ''], [URLPATH $site_url = ''], [SHORT_TEXT $caption = ''], [LONG_TEXT $notes = ''], [integer $importancemodulus = 3], [?integer $campaignremaining = 50], [SHORT_INTEGER $the_type = 1], [?TIME $expiry_date = NULL], [?MEMBER $submitter = NULL], [BINARY $validated = 1], [ID_TEXT $b_type = ''], [SHORT_TEXT $title_text = ''])

array get_sp_overrides ()

array get_submitter (ID_TEXT $id)

tempcode misc ()

tempcode nice_get_entries ()

tempcode run_start (ID_TEXT $type)

Variables

mixed $do_next_type = NULL (line 40)

mixed $javascript = 'standardAlternateFields(\'file\',\'image_url\',null,true); var form=document.getElementById(\'campaignremaining\').form; var crf=function() { form.elements[\'campaignremaining\'].disabled=(!form.elements[\'the_type\'][1].checked); }; crf(); form.elements[\'the_type\'][0].onclick=crf; form.elements[\'the_type\'][1].onclick=crf; form.elements[\'the_type\'][2].onclick=crf;' (line 37)

Redefinition of:

standard_aed_module::$javascript

mixed $lang_type = 'BANNER' (line 28)

mixed $menu_label = 'BANNERS' (line 38)

Redefinition of:

standard_aed_module::$menu_label

mixed $non_integer_id = true (line 35)

Redefinition of:

standard_aed_module::$non_integer_id

mixed $permissions_require = 'mid' (line 31)

Redefinition of:

standard_aed_module::$permissions_require

mixed $permission_module = 'banners' (line 36)

Redefinition of:

standard_aed_module::$permission_module

mixed $select_name = 'NAME' (line 32)

mixed $select_name_description = 'DESCRIPTION_BANNER_NAME' (line 33)

Redefinition of:

standard_aed_module::$select_name_description

mixed $upload = 'image' (line 34)

Redefinition of:

standard_aed_module::$upload

mixed $user_facing = true (line 30)

Redefinition of:

standard_aed_module::$user_facing

mixed $view_entry_point = '_SEARCH:banners:type=view:source=_ID' (line 29)

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_entry_point
standard_aed_module::$archive_label
standard_aed_module::$array_key
standard_aed_module::$author
standard_aed_module::$award_type
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::$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_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::$send_validation_request
standard_aed_module::$seo_type
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

Methods

add_actualisation (line 232)

Standard aed_module add actualiser.

return: A pair: The entry added, Description about usage

array add_actualisation ()

delete_actualisation (line 306)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

do_next_manager (line 322)

The do-next manager for after banner content management (banners 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 277)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being edited

fill_in_edit_form (line 215)

Standard aed_module edit form filler.

return: Bits

array fill_in_edit_form (ID_TEXT $id)

ID_TEXT $id: The entry being edited

get_entry_points (line 105)

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

Get the tempcode for the form to add a banner, with the information passed along to it via the parameters already added in.

return: Bits

ID_TEXT $name: The name of the banner
URLPATH $image_url: The URL to the banner image
URLPATH $site_url: The URL to the site the banner leads to
SHORT_TEXT $caption: The caption of the banner
LONG_TEXT $notes: Any notes associated with the banner
integer $importancemodulus: The banners "importance modulus"
?integer $campaignremaining: The number of hits the banner may have (NULL: not applicable for this banner type)
SHORT_INTEGER $the_type: The type of banner (0=permanent, 1=campaign, 2=default)
?TIME $expiry_date: The banner expiry date (NULL: never expires)
?MEMBER $submitter: The banners submitter (NULL: current member)
BINARY $validated: Whether the banner has been validated
ID_TEXT $b_type: The banner type (can be anything, where blank means 'normal')
SHORT_TEXT $title_text: The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)

get_sp_overrides (line 115)

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

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

The do-next manager for before content management.

return: The UI

tempcode misc ()

nice_get_entries (line 152)

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

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

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