HumHub Documentation (unofficial)

PermissionManager extends Component
in package

Application

Description of PermissionManager

Properties

$behaviors : array<string|int, Behavior>
$subject : User: User identity.
$_access : array<string|int, mixed>: Permission access cache.
$_groupPermissions : array<string|int, mixed>: Cache for permission group states, array is divided into sub array for easier access map: [{group_id} => [GroupPermission, ...]]
$permissions : array<string|int, mixed>: Cached Permission array.
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
can() : bool: Verifies a given $permission or $permission array for a permission subject.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
clear() : mixed: Clears access cache
createPermissionArray() : array<string|int, mixed>: Returns Permission Array
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
findUsersByPermission() : ActiveQueryUser: Returns a query for users which are granted given permission
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getById() : BasePermission|null: Returns a BasePermission by Id
getGroupState() : int: Returns the group permission state of the given group or goups.
getPermissions() : array<string|int, mixed>: Returns a list of all Permission objects
handlePermissionStateChange() : array<string|int, mixed>|null
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
setGroupState() : mixed: Sets the state for a given groupId.
trigger() : mixed: Triggers an event.
createPermissionRecord() : ActiveRecord: Creates a Permission Database record
getGroupStateRecord() : array<string|int, mixed>|null|ActiveRecord: Not used anymore, permissions are now prefetched into $_groupPermissions array
getModulePermissions() : array<string|int, mixed>: Returns permissions provided by a module
getPrefetchedStateRecord() : GroupPermission|null: Try to get permission from prefetched array
getQuery() : ActiveQuery: Creates a Permission Database Query
getSingleGroupDefaultState() : string|int: Returns the group default state
getSubject() : User: Returns the permission subject identity.
prefetchGatherGroupIds() : array<string|int, mixed>|int: Gets ids from groups array (or string) for query, prefetched groups ignored and not wil not be included in array
prefetchGroups() : mixed: Prefetch permissions for groups, use getPrefetchedStateRecord to get prefetched permission
verify() : bool: Verifies a single permission for a given permission subject.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
getSingleGroupState() : string|int: Returns the group state
isVerifyAll() : bool: Return boolean for verifyAll

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$subject

User identity.


    public
        User
    $subject

$_access

Permission access cache.


    protected
        array<string|int, mixed>
    $_access
     = []

$_groupPermissions

Cache for permission group states, array is divided into sub array for easier access map: [{group_id} => [GroupPermission, ...]]


    protected
        array<string|int, mixed>
    $_groupPermissions
     = []

$permissions

Cached Permission array.


    protected
        array<string|int, mixed>
    $permissions
     = null

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

can()

Verifies a given $permission or $permission array for a permission subject.


    public
                    can(string|array<string|int, mixed>|BasePermission $permission[, array<string|int, mixed> $params = [] ][, bool $allowCaching = true ]) : bool

If $params['strict'] is set to true and a $permission array is given all given permissions have to be granted otherwise (default) only one permission test has to pass.

Parameters

$permission : string|array<string|int, mixed>|BasePermission
$params : array<string|int, mixed> = []
$allowCaching : bool = true

Return values

bool

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

clear()

Clears access cache


    public
                    clear() : mixed

createPermissionArray()

Returns Permission Array


    public
                    createPermissionArray(int $groupId[, bool $returnOnlyChangeable = false ]) : array<string|int, mixed>

Parameters

$groupId : int: id of the group
$returnOnlyChangeable : bool = false

Return values

array<string|int, mixed> —

the permission array

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

findUsersByPermission()

Returns a query for users which are granted given permission


    public
            static        findUsersByPermission(BasePermission $permission) : ActiveQueryUser

Parameters

$permission : BasePermission

Return values

ActiveQueryUser

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getById()

Returns a BasePermission by Id


    public
                    getById(string $permissionId, string $moduleId) : BasePermission|null

Parameters

$permissionId : string
$moduleId : string

Return values

BasePermission|null

getGroupState()

Returns the group permission state of the given group or goups.


    public
                    getGroupState(mixed $groups, BasePermission $permission[, int $returnDefaultState = 1 ]) : int

If the provided $group is an array we check if one of the group states is a BasePermission::STATE_ALLOW and return this state.

Parameters

$groups : mixed: either an array of groups or group ids or an single group or goup id
$permission : BasePermission
$returnDefaultState : int = 1

Return values

int

getPermissions()

Returns a list of all Permission objects


    public
                    getPermissions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of BasePermissions

handlePermissionStateChange()


    public
                    handlePermissionStateChange(int|string $groupId) : array<string|int, mixed>|null

Parameters

$groupId : int|string

Return values

array<string|int, mixed>|null

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

setGroupState()

Sets the state for a given groupId.


    public
                    setGroupState(string $groupId, string|BasePermission $permission, string $state) : mixed

Parameters

$groupId : string
$permission : string|BasePermission: either permission class or instance
$state : string

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

createPermissionRecord()

Creates a Permission Database record


    protected
                    createPermissionRecord() : ActiveRecord

Return values

ActiveRecord

getGroupStateRecord()

Not used anymore, permissions are now prefetched into $_groupPermissions array


    protected
                    getGroupStateRecord(mixed $groupId, BasePermission $permission) : array<string|int, mixed>|null|ActiveRecord

Parameters

$groupId : mixed
$permission : BasePermission

Return values

array<string|int, mixed>|null|ActiveRecord

getModulePermissions()

Returns permissions provided by a module


    protected
                    getModulePermissions(Module $module) : array<string|int, mixed>

Parameters

$module : Module

Return values

array<string|int, mixed> —

of BasePermissions

getPrefetchedStateRecord()

Try to get permission from prefetched array


    protected
                    getPrefetchedStateRecord(mixed $groupId, BasePermission $permission) : GroupPermission|null

Parameters

$groupId : mixed
$permission : BasePermission

Return values

GroupPermission|null

getQuery()

Creates a Permission Database Query


    protected
                    getQuery() : ActiveQuery

Return values

ActiveQuery

getSingleGroupDefaultState()

Returns the group default state


    protected
                    getSingleGroupDefaultState(string $groupId, BasePermission $permission) : string|int

Parameters

$groupId : string
$permission : BasePermission

Return values

string|int —

the state

getSubject()

Returns the permission subject identity.


    protected
                    getSubject() : User

If the permission objects $subject property is not set this method returns the currently logged in user identity.

Return values

User

prefetchGatherGroupIds()

Gets ids from groups array (or string) for query, prefetched groups ignored and not wil not be included in array


    protected
                    prefetchGatherGroupIds(mixed $groups[, array<string|int, mixed> $ids = [] ]) : array<string|int, mixed>|int

Parameters

$groups : mixed
$ids : array<string|int, mixed> = []

Return values

array<string|int, mixed>|int

prefetchGroups()

Prefetch permissions for groups, use getPrefetchedStateRecord to get prefetched permission


    protected
                    prefetchGroups(mixed $groups) : mixed

Parameters

$groups : mixed

verify()

Verifies a single permission for a given permission subject.


    protected
                    verify(BasePermission $permission) : bool

Parameters

$permission : BasePermission

Return values

bool

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

getSingleGroupState()

Returns the group state


    private
                    getSingleGroupState(string $groupId, BasePermission $permission[, bool $returnDefaultState = true ]) : string|int

Parameters

$groupId : string
$permission : BasePermission
$returnDefaultState : bool = true

Return values

string|int —

the state

isVerifyAll()

Return boolean for verifyAll


    private
                    isVerifyAll([array<string|int, mixed> $params = [] ]) : bool

Parameters

$params : array<string|int, mixed> = []

Return values

bool

PermissionManager extends Component in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$subject

$_access

$_groupPermissions

$permissions

$_behaviors

$_events

$_eventWildcards

Tags

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

can()

Parameters

Tags

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

clear()

createPermissionArray()

Parameters

Tags

Return values

detachBehavior()

Parameters

Return values

detachBehaviors()

ensureBehaviors()

findUsersByPermission()

Parameters

PermissionManager extends Component
in package

Application