• Home
• Habari
• ACL

PHP Class Habari\ACL

The default Habari ACL class implements groups, and group permissions Users are assigned to one or more groups. Groups are assigned one or more permissions. Membership in any group that grants a permission means you have that permission. Membership in any group that denies that permission denies the user that permission, even if another group grants that permission. Show file Open project: habari/system

Public Methods

Method	Description
__static ( )	Register plugin hooks
_filter_permission_display ( $permission ) : string	function _filter_permission_display Filter to localize permission names
_filter_token_description_display ( $token ) : string	function _filter_token_description_display Filter to localize token descriptions
_filter_token_group_display ( $group ) : string	function _filter_token_group_display Filter to localize token group name
access_check ( Bitmask $bitmask, mixed $access ) : boolean	Check a permission bitmask for a particular access type.
access_names ( ) : array	Obtain the list of access names (CRUD) to use for permissions.
all_tokens ( string $order = 'id' ) : array	Get an array of QueryRecord objects containing all permission tokens
clear_caches ( )	Clears all caches used to hold permissions
create_default_tokens ( )	Creates the default set of permissions.
create_token ( string $name, string $description, string $group, boolean $crud = false ) : mixed	Create a new permission token, and save it to the permission tokens table
deny_group ( integer $group_id, mixed $token_id ) : Result	Deny permission to a group
deny_user ( integer $user_id, mixed $token_id ) : Result	Deny permission to a user
destroy_token ( $token ) : boolean	Remove a permission token, and any assignments of it
get_bitmask ( integer $mask ) : Bitmask	Get a Bitmask object representing the supplied access integer
get_group_token_access ( integer $group, mixed $token_id ) : an	Get the access bitmask of a group for a specific permission token
get_user_token_access ( User | integer $user, string | integer $token ) : Bitmask	Return the access bitmask to a specific token for a specific user
grant_group ( integer $group_id, mixed $token_id, string $access = 'full' ) : Result	Grant a permission to a group
grant_user ( integer $user_id, integer $token_id, string $access = 'full' ) : Result	Grant a permission to a user
group_can ( mixed $group, mixed $token_id, string $access = 'full' ) : boolean	Determine whether a group can perform a specific action
group_cannot ( $group, mixed $token_id ) : boolean	Determine whether a group is explicitly denied permission to perform a specific action This function does not return true if the group is merely not granted a permission
normalize_token ( string $name ) : string	Convert a token name into a valid format
rebuild_permissions ( $user = null )	Reset premissions to their default state
revoke_group_token ( integer $group_id, mixed $token_id ) : the	Remove a permission token from the group permissions table
revoke_user_token ( integer $user_id, mixed $token_id ) : the	Remove a permission token from the user permissions table
token_description ( mixed $permission ) : string	Fetch a permission token's description from the DB
token_exists ( mixed $permission ) : boolean	Determine whether a permission token exists
token_id ( string $name ) : integer	Get a permission token's ID by its name
token_name ( integer $id ) : string	Get a permission token's name by its ID
user_can ( mixed $user, mixed $token_id, string $access = 'full' ) : boolean	Determine whether a user can perform a specific action
user_cannot ( mixed $user, mixed $token_id ) : boolean	Determine whether a user is explicitly denied permission to perform a specific action This function does not return true if the user is merely not granted a permission
user_tokens ( mixed $user, string $access = 'full', $posts_only = false ) : array	Get all the tokens for a given user with a particular kind of access

Private Methods

Method	Description
cache_tokens ( ) : array	Get an associative array of token ids and their name.

Method Details