/sources/ocf_groups_action.php

Description
Functions
ocf_make_group (line 52)

Add a usergroup.

  • return: The ID of the new.
AUTO_LINK ocf_make_group (SHORT_TEXT $name, BINARY $is_default, BINARY $is_super_admin, BINARY $is_super_moderator, SHORT_TEXT $title, [URLPATH $rank_image = ''], [?GROUP $promotion_target = NULL], [?integer $promotion_threshold = NULL], [?MEMBER $group_leader = NULL], [integer $flood_control_submit_secs = 5], [integer $flood_control_access_secs = 0], [integer $max_daily_upload_mb = 70], [integer $max_attachments_per_post = 50], [integer $max_avatar_width = 100], [integer $max_avatar_height = 100], [integer $max_post_length_comcode = 30000], [integer $max_sig_length_comcode = 700], [integer $gift_points_base = 25], [integer $gift_points_per_day = 1], [BINARY $enquire_on_new_ips = 0], [BINARY $is_presented_at_install = 0], [BINARY $hidden = 0], [?integer $order = NULL], [BINARY $rank_image_pri_only = 1], [BINARY $open_membership = 0], [BINARY $is_private_club = 0])
  • SHORT_TEXT $name: The name of the usergroup.
  • BINARY $is_default: Whether members are automatically put into the when they join.
  • BINARY $is_super_admin: Whether members of this usergroup are all super administrators.
  • BINARY $is_super_moderator: Whether members of this usergroup are all super moderators.
  • SHORT_TEXT $title: The title for primary members of this usergroup that don't have their own title.
  • URLPATH $rank_image: The rank image for this.
  • ?GROUP $promotion_target: The that members of this usergroup get promoted to at point threshold (NULL: no promotion prospects).
  • ?integer $promotion_threshold: The point threshold for promotion (NULL: no promotion prospects).
  • ?MEMBER $group_leader: The leader of this usergroup (NULL: none).
  • integer $flood_control_submit_secs: The number of seconds that members of this usergroup must endure between submits (group 'best of' applies).
  • integer $flood_control_access_secs: The number of seconds that members of this usergroup must endure between accesses (group 'best of' applies).
  • integer $max_daily_upload_mb: The number of megabytes that members of this usergroup may attach per day (group 'best of' applies).
  • integer $max_attachments_per_post: The number of attachments that members of this usergroup may attach to something (group 'best of' applies).
  • integer $max_avatar_width: The maximum avatar width that members of this usergroup may have (group 'best of' applies).
  • integer $max_avatar_height: The maximum avatar height that members of this usergroup may have (group 'best of' applies).
  • integer $max_post_length_comcode: The maximum post length that members of this usergroup may make (group 'best of' applies).
  • integer $max_sig_length_comcode: The maximum signature length that members of this usergroup may make (group 'best of' applies).
  • integer $gift_points_base: The number of gift points that members of this usergroup start with (group 'best of' applies).
  • integer $gift_points_per_day: The number of gift points that members of this usergroup get per day (group 'best of' applies).
  • BINARY $enquire_on_new_ips: Whether e-mail confirmation is needed for new IP addresses seen for any member of this usergroup (group 'best of' applies).
  • BINARY $is_presented_at_install: Whether the usergroup is presented for joining at joining (implies anyone may be in the, but only choosable at joining)
  • BINARY $hidden: Whether the name and membership of the is hidden
  • ?integer $order: The display order this will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups (NULL: next).
  • 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.

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