Class Module_admin_ocf_groups

Description
Description | Vars (details) | Methods (details)

Module page class.

  • copyright: ocProducts Ltd

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

standard_aed_module
   |
   --Module_admin_ocf_groups
Variable Summary
Description | Vars (details) | Methods (details)
mixed $archive_entry_point
mixed $archive_label
mixed $award_type
mixed $do_preview
mixed $javascript
mixed $lang_type
mixed $menu_label
mixed $output_of_action_is_confirmation
mixed $possibly_some_kind_of_upload
mixed $select_name
mixed $view_entry_point
Method Summary
Description | Vars (details) | Methods (details)
ID_TEXT add_actualisation ()
void copy_members_into (GROUP $g)
void delete_actualisation (ID_TEXT $id)
?tempcode edit_actualisation (ID_TEXT $id)
array fill_in_edit_form (ID_TEXT $id)
?array get_entry_points ()
array get_form_fields ([?GROUP $id = NULL], [SHORT_TEXT $name = ''], [BINARY $is_default = 0], [BINARY $is_super_admin = 0], [BINARY $is_super_moderator = 0], [ID_TEXT $group_leader = ''], [SHORT_TEXT $title = ''], [URLPATH $rank_image = ''], [?GROUP $promotion_target = NULL], [?integer $promotion_threshold = NULL], [integer $flood_control_submit_secs = 0], [integer $flood_control_access_secs = 0], [integer $gift_points_base = 25], [integer $gift_points_per_day = 1], [integer $max_daily_upload_mb = 5], [integer $max_attachments_per_post = 20], [integer $max_avatar_width = 80], [integer $max_avatar_height = 80], [integer $max_post_length_comcode = 40000], [integer $max_sig_length_comcode = 1000], [BINARY $enquire_on_new_ips = 0], [BINARY $is_presented_at_install = 0], [BINARY $group_is_hidden = 0], [?integer $order = NULL], [BINARY $rank_image_pri_only = 1], [BINARY $open_membership = 0], [BINARY $is_private_club = 0])
boolean may_delete_this (ID_TEXT $id)
tempcode misc ()
tempcode nice_get_entries ()
array read_in_data ()
tempcode run_start (ID_TEXT $type)
Variables
Description | Vars (details) | Methods (details)
mixed $archive_entry_point = '_SEARCH:groups' (line 35)
Redefinition of:
standard_aed_module::$archive_entry_point
mixed $archive_label = 'USERGROUPS' (line 36)
Redefinition of:
standard_aed_module::$archive_label
mixed $award_type = 'group' (line 31)
Redefinition of:
standard_aed_module::$award_type
mixed $do_preview = NULL (line 34)
Redefinition of:
standard_aed_module::$do_preview
mixed $javascript = 'standardAlternateFields(\'file\',\'theme_img_code*\',null,true); if (document.getElementById(\'delete\')) { var form=document.getElementById(\'delete\').form; var crf=function() { if (form.elements[\'new_usergroup\']) form.elements[\'new_usergroup\'].disabled=(!form.elements[\'delete\'].checked); }; crf(); form.elements[\'delete\'].onchange=crf; } if (document.getElementById(\'is_presented_at_install\')) { var form=document.getElementById(\'is_presented_at_install\').form; var crf2=function() { if (form.elements[\'is_default\']) form.elements[\'is_default\'].disabled=(form.elements[\'is_presented_at_install\'].checked); if (form.elements[\'is_presented_at_install\'].checked) form.elements[\'is_default\'].checked=false; }; crf2(); form.elements[\'is_presented_at_install\'].onchange=crf2; }' (line 30)
Redefinition of:
standard_aed_module::$javascript
mixed $lang_type = 'GROUP' (line 28)
mixed $menu_label = 'USERGROUPS' (line 38)
Redefinition of:
standard_aed_module::$menu_label
mixed $output_of_action_is_confirmation = true (line 33)
Redefinition of:
standard_aed_module::$output_of_action_is_confirmation
mixed $possibly_some_kind_of_upload = true (line 32)
Redefinition of:
standard_aed_module::$possibly_some_kind_of_upload
mixed $select_name = 'NAME' (line 29)
mixed $view_entry_point = '_SEARCH:groups:view:id=_ID' (line 37)
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::$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::$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
Methods
Description | Vars (details) Methods (details)
add_actualisation (line 387)

Standard aed_module add actualiser.

  • return: The entry added
ID_TEXT add_actualisation ()
copy_members_into (line 338)

Handle the "copy members from" feature.

void copy_members_into (GROUP $g)
  • GROUP $g: The usergroup to copy members from
delete_actualisation (line 453)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $id)
  • ID_TEXT $id: The entry being deleted
edit_actualisation (line 419)

Standard aed_module edit actualiser.

  • return: Confirm message (NULL: continue)
?tempcode edit_actualisation (ID_TEXT $id)
  • ID_TEXT $id: The entry being edited
fill_in_edit_form (line 281)

Standard aed_module edit form filler.

  • return: A triple: fields, hidden-fields, delete-fields
array fill_in_edit_form (ID_TEXT $id)
  • ID_TEXT $id: The entry being edited
get_entry_points (line 45)

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

Get tempcode for a adding/editing form.

  • return: A pair: The input fields, Hidden fields
array get_form_fields ([?GROUP $id = NULL], [SHORT_TEXT $name = ''], [BINARY $is_default = 0], [BINARY $is_super_admin = 0], [BINARY $is_super_moderator = 0], [ID_TEXT $group_leader = ''], [SHORT_TEXT $title = ''], [URLPATH $rank_image = ''], [?GROUP $promotion_target = NULL], [?integer $promotion_threshold = NULL], [integer $flood_control_submit_secs = 0], [integer $flood_control_access_secs = 0], [integer $gift_points_base = 25], [integer $gift_points_per_day = 1], [integer $max_daily_upload_mb = 5], [integer $max_attachments_per_post = 20], [integer $max_avatar_width = 80], [integer $max_avatar_height = 80], [integer $max_post_length_comcode = 40000], [integer $max_sig_length_comcode = 1000], [BINARY $enquire_on_new_ips = 0], [BINARY $is_presented_at_install = 0], [BINARY $group_is_hidden = 0], [?integer $order = NULL], [BINARY $rank_image_pri_only = 1], [BINARY $open_membership = 0], [BINARY $is_private_club = 0])
  • ?GROUP $id: The usergroup being edited (NULL: adding, not editing)
  • SHORT_TEXT $name: The usergroup name
  • BINARY $is_default: Whether this is a default usergroup
  • BINARY $is_super_admin: Whether members of the usergroup are super-administrators
  • BINARY $is_super_moderator: Whether members of the usergroup are super-moderators
  • ID_TEXT $group_leader: The username of the usergroup leader
  • SHORT_TEXT $title: The default title for members with this as their primary usergroup
  • URLPATH $rank_image: The usergroup rank image
  • ?GROUP $promotion_target: The target for promotion from this usergroup (NULL: no promotion prospects)
  • ?integer $promotion_threshold: The point threshold upon which promotion occurs (NULL: no promotion prospects)
  • integer $flood_control_submit_secs: The number of seconds between submission flood controls
  • integer $flood_control_access_secs: The number of seconds between access flood controls
  • integer $gift_points_base: The number of gift points members of this usergroup get when they start
  • integer $gift_points_per_day: The number of gift points members of this usergroup get per-day
  • integer $max_daily_upload_mb: The number of megabytes members can upload per day
  • integer $max_attachments_per_post: The maximum number of attachments members of this usergroup may have per post
  • integer $max_avatar_width: The maximum avatar width members of this usergroup may have
  • integer $max_avatar_height: The maximum avatar height members of this usergroup may have
  • integer $max_post_length_comcode: The maximum post length members of this usergroup may have
  • integer $max_sig_length_comcode: The maximum signature length members of this usergroup may have
  • BINARY $enquire_on_new_ips: Whether to lock out unverified IP addresses until e-mail confirmation
  • BINARY $is_presented_at_install: Whether the usergroup is presented for joining at joining (implies anyone may be in the usergroup, but only choosable at joining)
  • BINARY $group_is_hidden: Whether the name and membership of the usergroup is hidden
  • ?integer $order: The display order this usergroup will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups (NULL: last).
  • BINARY $rank_image_pri_only: Whether the rank image will not be shown for secondary membership
  • BINARY $open_membership: Whether members may join this usergroup without requiring any special permission
  • BINARY $is_private_club: Whether this usergroup is a private club. Private clubs may be managed in the CMS zone, and do not have any special permissions - except over their own associated forum.
may_delete_this (line 270)

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

The do-next manager for before content management.

  • return: The UI
tempcode misc ()
nice_get_entries (line 241)

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.
read_in_data (line 365)

Read in data posted by an add/edit form

  • return: A triplet of integers: (group leader, promotion target, promotion threshold)
array read_in_data ()
run_start (line 56)

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:07:39 +0000 by phpDocumentor 1.4.3