Docs For Class Module_admin_ocf

Description

Module page class.

copyright: ocProducts Ltd

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

standard_aed_module
   |
   --Module_admin_ocf_customprofilefields

Variable Summary

mixed $lang_type

mixed $menu_label

mixed $select_name

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

array get_form_fields ([SHORT_TEXT $name = ''], [LONG_TEXT $description = ''], [LONG_TEXT $default = ''], [BINARY $public_view = 1], [BINARY $owner_view = 1], [BINARY $owner_set = 1], [BINARY $encrypted = 0], [ID_TEXT $type = 'long_text'], [BINARY $required = 0], [BINARY $show_on_join_form = 0], [BINARY $show_in_posts = 0], [BINARY $show_in_post_previews = 0], [?integer $order = NULL], [LONG_TEXT $only_group = ''], [BINARY $locked = 0])

boolean may_delete_this (ID_TEXT $_id)

tempcode misc ()

tempcode nice_get_choose_table (array $url_map)

tempcode run_start (ID_TEXT $type)

tempcode stats ()

tempcode _stats ()

Variables

mixed $lang_type = 'CUSTOM_PROFILE_FIELD' (line 28)

mixed $menu_label = 'CUSTOM_PROFILE_FIELDS' (line 30)

Redefinition of:

standard_aed_module::$menu_label

mixed $select_name = 'NAME' (line 29)

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

Methods

add_actualisation (line 336)

Standard aed_module add actualiser.

return: The entry added

ID_TEXT add_actualisation ()

delete_actualisation (line 361)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being deleted

edit_actualisation (line 350)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $id)

ID_TEXT $id: The entry being edited

fill_in_edit_form (line 288)

Standard aed_module edit form filler.

return: The edit form

tempcode fill_in_edit_form (ID_TEXT $id)

ID_TEXT $id: The entry being edited

get_entry_points (line 37)

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

Get tempcode for adding/editing form.

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

array get_form_fields ([SHORT_TEXT $name = ''], [LONG_TEXT $description = ''], [LONG_TEXT $default = ''], [BINARY $public_view = 1], [BINARY $owner_view = 1], [BINARY $owner_set = 1], [BINARY $encrypted = 0], [ID_TEXT $type = 'long_text'], [BINARY $required = 0], [BINARY $show_on_join_form = 0], [BINARY $show_in_posts = 0], [BINARY $show_in_post_previews = 0], [?integer $order = NULL], [LONG_TEXT $only_group = ''], [BINARY $locked = 0])

SHORT_TEXT $name: The name of the custom profile field
LONG_TEXT $description: The description of the field
LONG_TEXT $default: The default value of the field
BINARY $public_view: Whether the field is publically viewable
BINARY $owner_view: Whether the field may be viewed by the owner
BINARY $owner_set: Whether the owner may set the value of the field
BINARY $encrypted: Whether the field is encrypted
ID_TEXT $type: The type of the field
BINARY $required: Whether the field is required to be filled in
BINARY $show_on_join_form: Whether the field is to be shown on the join form
BINARY $show_in_posts: Whether the field is shown in posts
BINARY $show_in_post_previews: Whether the field is shown in post previews
?integer $order: The order the field is given relative to the order of the other custom profile fields (NULL: last)
LONG_TEXT $only_group: The usergroups that this field is confined to (comma-separated list).
BINARY $locked: Whether the field is locked

may_delete_this (line 275)

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

The do-next manager for before content management.

return: The UI

tempcode misc ()

nice_get_choose_table (line 196)

Standard aed_module table function.

return: The choose table.

tempcode nice_get_choose_table (array $url_map)

array $url_map: Details to go to build_url for link to the next screen.

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

stats (line 371)

Show value statistics for a custom profile field (choose).

return: The UI

tempcode stats ()

_stats (line 405)

Show value statistics for a custom profile field (show).

return: The statistics

tempcode _stats ()

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_customprofilefields

Inherited Variables

Inherited Methods