ocf_add_member_to_group (line 269)
Add a member to a certain.
void
ocf_add_member_to_group
(MEMBER $member_id, GROUP $id, [BINARY $validated = 1])
-
MEMBER
$member_id: The member.
-
GROUP
$id: The usergroup.
-
BINARY
$validated: Whether the member is validated into the usergroup.
ocf_delete_group (line 149)
Delete a usergroup.
void
ocf_delete_group
(AUTO_LINK $group_id, [?GROUP $target_group = NULL])
-
AUTO_LINK
$group_id: The ID of the usergroup to delete.
-
?GROUP
$target_group: The usergroup to move primary members to (NULL: main members).
ocf_edit_group (line 94)
Edit a usergroup.
void
ocf_edit_group
(AUTO_LINK $group_id, ?SHORT_TEXT $name, ?BINARY $is_default, ?BINARY $is_super_admin, ?BINARY $is_super_moderator, ?SHORT_TEXT $title, ?URLPATH $rank_image, ?GROUP $promotion_target, ?integer $promotion_threshold, ?MEMBER $group_leader, ?integer $flood_control_submit_secs, ?integer $flood_control_access_secs, ?integer $max_daily_upload_mb, ?integer $max_attachments_per_post, ?integer $max_avatar_width, ?integer $max_avatar_height, ?integer $max_post_length_comcode, ?integer $max_sig_length_comcode, ?integer $gift_points_base, ?integer $gift_points_per_day, ?BINARY $enquire_on_new_ips, ?BINARY $is_presented_at_install, ?BINARY $hidden, ?integer $order, ?BINARY $rank_image_pri_only, ?BINARY $open_membership, ?BINARY $is_private_club)
-
AUTO_LINK
$group_id: The ID of the usergroup to edit.
-
?SHORT_TEXT
$name: The name of the usergroup. (NULL: do not change)
-
?BINARY
$is_default: Whether members are automatically put into the when they join. (NULL: do not change)
-
?BINARY
$is_super_admin: Whether members of this usergroup are all super administrators. (NULL: do not change)
-
?BINARY
$is_super_moderator: Whether members of this usergroup are all super moderators. (NULL: do not change)
-
?SHORT_TEXT
$title: The title for primary members of this usergroup that don't have their own title. (NULL: do not change)
-
?URLPATH
$rank_image: The rank image for this. (NULL: do not change)
-
?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). (NULL: do not change)
-
?integer
$flood_control_access_secs: The number of seconds that members of this usergroup must endure between accesses (group 'best of' applies). (NULL: do not change)
-
?integer
$max_daily_upload_mb: The number of megabytes that members of this usergroup may attach per day (group 'best of' applies). (NULL: do not change)
-
?integer
$max_attachments_per_post: The number of attachments that members of this usergroup may attach to something (group 'best of' applies). (NULL: do not change)
-
?integer
$max_avatar_width: The maximum avatar width that members of this usergroup may have (group 'best of' applies). (NULL: do not change)
-
?integer
$max_avatar_height: The maximum avatar height that members of this usergroup may have (group 'best of' applies). (NULL: do not change)
-
?integer
$max_post_length_comcode: The maximum post length that members of this usergroup may make (group 'best of' applies). (NULL: do not change)
-
?integer
$max_sig_length_comcode: The maximum signature length that members of this usergroup may make (group 'best of' applies). (NULL: do not change)
-
?integer
$gift_points_base: The number of gift points that members of this usergroup start with (group 'best of' applies). (NULL: do not change)
-
?integer
$gift_points_per_day: The number of gift points that members of this usergroup get per day (group 'best of' applies). (NULL: do not change)
-
?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). (NULL: do not change)
-
?BINARY
$is_presented_at_install: Whether the is presented for joining at joining (implies anyone may be in the, but only choosable at joining) (NULL: do not change)
-
?BINARY
$hidden: Whether the name and membership of the is hidden (NULL: do not change)
-
?integer
$order: The display order this will be given, relative to other usergroups. Lower numbered usergroups display before higher numbered usergroups. (NULL: do not change)
-
?BINARY
$rank_image_pri_only: Whether the rank image will not be shown for secondary membership (NULL: do not change)
-
?BINARY
$open_membership: Whether members may join this usergroup without requiring any special permission (NULL: do not change)
-
?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. (NULL: do not change)
ocf_group_absorb_privileges_of (line 335)
Copy permissions relating to one, to another.
void
ocf_group_absorb_privileges_of
(GROUP $to, GROUP $from)
-
GROUP
$to: The that is having it's permissions replaced.
-
GROUP
$from: The that the permissions are being drawn from.
ocf_may_control_group (line 56)
Find whether a certain member may control a certain usergroup.
boolean
ocf_may_control_group
(GROUP $group_id, MEMBER $member_id)
-
GROUP
$group_id: The usergroup.
-
MEMBER
$member_id: The member.
ocf_member_ask_join_group (line 191)
Mark a member as applying to be in a certain, and inform the leader.
void
ocf_member_ask_join_group
(GROUP $group_id, [?MEMBER $member_id = NULL])
-
GROUP
$group_id: The usergroup to apply to.
-
?MEMBER
$member_id: The member applying (NULL: current member).
ocf_member_leave_group (line 247)
Remove a member from a certain.
void
ocf_member_leave_group
(GROUP $group_id, [?MEMBER $member_id = NULL])
-
GROUP
$group_id: The usergroup to remove from.
-
?MEMBER
$member_id: The member leaving (NULL: current member).
ocf_member_validate_into_group (line 291)
Set whether a member that has applied to be in a, may be in it, and inform them of the decision.
void
ocf_member_validate_into_group
(GROUP $group_id, MEMBER $prospective_member_id, [boolean $decline = false], [string $reason = ''])
-
GROUP
$group_id: The usergroup.
-
MEMBER
$prospective_member_id: The prospective member.
-
boolean
$decline: Whether the member is being declined membership.
-
string
$reason: The reason given for declining.
ocf_update_member_tracking_group_change (line 26)
If a members membership change, it is crucial that they're tracking options are updated - lest they might find confidential information e-mailed to them when people reply to tracked topics.
void
ocf_update_member_tracking_group_change
(MEMBER $member_id)
-
MEMBER
$member_id: The ID of the member who's tracking needs updating.
_ocf_group_absorb_privileges_of (line 352)
Helper function, for copy permissions relating to one, to another.
void
_ocf_group_absorb_privileges_of
(GROUP $to, GROUP $from, ID_TEXT $table, [ID_TEXT $id = 'group_id'], [boolean $ocf = false])
-
GROUP
$to: The that is having it's permissions replaced.
-
GROUP
$from: The that the permissions are being drawn from.
-
ID_TEXT
$table: The table holding the permissions.
-
ID_TEXT
$id: The name of the field in the table that holds the ID.
-
boolean
$ocf: Whether the operation is being carried out over the OCF driver.