PHP Class auth_admin

Inheritance: extends CI_Controller
Show file Open project: phpbb/phpbb Class Usage Examples

Public Methods

Method Description
acl_add_option ( $options ) NOTE: this function is not in use atm Add a new option to the list .
acl_delete ( $mode, $ug_id = false, $forum_id = false, $permission_type = false ) Remove local permission
acl_set ( $ug_type, $forum_id, $ug_id, $auth, $role_id, $clear_prefetch = true ) Set a user or group ACL record
acl_set_role ( $role_id, $auth ) Set a role-specific ACL record
assign_cat_array ( &$category_array, $tpl_cat, $tpl_mask, $ug_id, $forum_id, $s_view, $show_trace = false ) Assign category to template used by display_mask()
auth_admin ( ) Init auth settings
build_permission_array ( &$permission_row, &$content_array, &$categories, $key_sort_array ) Building content array from permission rows with explicit key ordering used by display_mask()
display_mask ( $mode, $permission_type, &$hold_ary, $user_mode = 'user', $local = false, $group_display = true ) Display permission mask (assign to template)
display_role_mask ( &$hold_ary ) Display permission mask for roles
get_mask ( set | view $mode, mixed $user_id = false, mixed $group_id = false, mixed $forum_id = false, string $auth_option = false, local | global $scope = false, ACL_NEVER | ACL_NO | ACL_YES $acl_fill = ACL_NEVER ) Get permission mask This function only supports getting permissions of one type (for example a_)
get_role_mask ( $role_id ) Get permission mask for roles This function only supports getting masks for one role
ghost_permissions ( $from_user_id, $to_user_id ) Use permissions from another user. This transferes a permission set from one user to another.

Method Details

acl_add_option() public method

.. $options is a hash of form -> $options = array( 'local' => array('option1', 'option2', ...), 'global' => array('optionA', 'optionB', ...) );
public acl_add_option ( $options )

acl_delete() public method

Remove local permission
public acl_delete ( $mode, $ug_id = false, $forum_id = false, $permission_type = false )

acl_set() public method

Set a user or group ACL record
public acl_set ( $ug_type, $forum_id, $ug_id, $auth, $role_id, $clear_prefetch = true )

acl_set_role() public method

Set a role-specific ACL record
public acl_set_role ( $role_id, $auth )

assign_cat_array() public method

Assign category to template used by display_mask()
public assign_cat_array ( &$category_array, $tpl_cat, $tpl_mask, $ug_id, $forum_id, $s_view, $show_trace = false )

auth_admin() public method

Init auth settings
public auth_admin ( )

build_permission_array() public method

Building content array from permission rows with explicit key ordering used by display_mask()
public build_permission_array ( &$permission_row, &$content_array, &$categories, $key_sort_array )

display_mask() public method

Display permission mask (assign to template)
public display_mask ( $mode, $permission_type, &$hold_ary, $user_mode = 'user', $local = false, $group_display = true )

display_role_mask() public method

Display permission mask for roles
public display_role_mask ( &$hold_ary )

get_mask() public method

Get permission mask This function only supports getting permissions of one type (for example a_)
public get_mask ( set | view $mode, mixed $user_id = false, mixed $group_id = false, mixed $forum_id = false, string $auth_option = false, local | global $scope = false, ACL_NEVER | ACL_NO | ACL_YES $acl_fill = ACL_NEVER )
$mode set | view defines the permissions we get, view gets effective permissions (checking user AND group permissions), set only gets the user or group permission set alone
$user_id mixed user ids to search for (a user_id or a group_id has to be specified at least)
$group_id mixed group ids to search for, return group related settings (a user_id or a group_id has to be specified at least)
$forum_id mixed forum_ids to search for. Defining a forum id also means getting local settings
$auth_option string the auth_option defines the permission setting to look for (a_ for example)
$scope local | global the scope defines the permission scope. If local, a forum_id is additionally required
$acl_fill ACL_NEVER | ACL_NO | ACL_YES defines the mode those permissions not set are getting filled with

get_role_mask() public method

Get permission mask for roles This function only supports getting masks for one role
public get_role_mask ( $role_id )

ghost_permissions() public method

The other user is always able to revert back to his permission set. This function does not check for lower/higher permissions, it is possible for the user to gain "more" permissions by this. Admin permissions will not be copied.
public ghost_permissions ( $from_user_id, $to_user_id )