# Abstract Class yii\rbac\BaseManager

Inheritance | yii\rbac\BaseManager » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\rbac\ManagerInterface
Subclasses | yii\mongodb\rbac\MongoDbManager, yii\rbac\DbManager, yii\rbac\PhpManager
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/rbac/BaseManager.php

BaseManager is a base class implementing yii\rbac\ManagerInterface for RBAC management.

For more details and usage information on DbManager, see the guide article on security authorization.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component
$defaultRoleInstances | yii\rbac\Role[] | Default roles. | yii\rbac\BaseManager
$defaultRoles | array | A list of role names that are assigned to every user automatically without calling assign(). | yii\rbac\BaseManager
$permissions | yii\rbac\Permission[] | All permissions in the system. | yii\rbac\BaseManager
$roles | yii\rbac\Role[] | All roles in the system. | yii\rbac\BaseManager
$rules | yii\rbac\Rule[] | The rules indexed by the rule names | yii\rbac\ManagerInterface

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
add() | Adds a role, permission or rule to the RBAC system. | yii\rbac\BaseManager
addChild() | Adds an item as a child of another item. | yii\rbac\ManagerInterface
assign() | Assigns a role to a user. | yii\rbac\ManagerInterface
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canAddChild() | Checks the possibility of adding a child to parent. | yii\rbac\ManagerInterface
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
createPermission() | Creates a new Permission object. | yii\rbac\BaseManager
createRole() | Creates a new Role object. | yii\rbac\BaseManager
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getAssignment() | Returns the assignment information regarding a role and a user. | yii\rbac\ManagerInterface
getAssignments() | Returns all role assignment information for the specified user. | yii\rbac\ManagerInterface
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getChildRoles() | Returns child roles of the role specified. Depth isn't limited. | yii\rbac\ManagerInterface
getChildren() | Returns the child permissions and/or roles. | yii\rbac\ManagerInterface
getDefaultRoleInstances() | Returns defaultRoles as array of Role objects. | yii\rbac\BaseManager
getDefaultRoles() | Get default roles | yii\rbac\BaseManager
getPermission() | Returns the named permission. | yii\rbac\BaseManager
getPermissions() | Returns all permissions in the system. | yii\rbac\BaseManager
getPermissionsByRole() | Returns all permissions that the specified role represents. | yii\rbac\ManagerInterface
getPermissionsByUser() | Returns all permissions that the user has. | yii\rbac\ManagerInterface
getRole() | Returns the named role. | yii\rbac\BaseManager
getRoles() | Returns all roles in the system. | yii\rbac\BaseManager
getRolesByUser() | Returns the roles that are assigned to the user via assign(). | yii\rbac\ManagerInterface
getRule() | Returns the rule of the specified name. | yii\rbac\ManagerInterface
getRules() | Returns all rules available in the system. | yii\rbac\ManagerInterface
getUserIdsByRole() | Returns all user IDs assigned to the role specified. | yii\rbac\ManagerInterface
hasChild() | Returns a value indicating whether the child already exists for the parent. | yii\rbac\ManagerInterface
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\BaseObject
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
remove() | Removes a role, permission or rule from the RBAC system. | yii\rbac\BaseManager
removeAll() | Removes all authorization data, including roles, permissions, rules, and assignments. | yii\rbac\ManagerInterface
removeAllAssignments() | Removes all role assignments. | yii\rbac\ManagerInterface
removeAllPermissions() | Removes all permissions. | yii\rbac\ManagerInterface
removeAllRoles() | Removes all roles. | yii\rbac\ManagerInterface
removeAllRules() | Removes all rules. | yii\rbac\ManagerInterface
removeChild() | Removes a child from its parent. | yii\rbac\ManagerInterface
removeChildren() | Removed all children form their parent. | yii\rbac\ManagerInterface
revoke() | Revokes a role from a user. | yii\rbac\ManagerInterface
revokeAll() | Revokes all roles from a user. | yii\rbac\ManagerInterface
setDefaultRoles() | Set default roles | yii\rbac\BaseManager
trigger() | Triggers an event. | yii\base\Component
update() | Updates the specified role, permission or rule in the system. | yii\rbac\BaseManager

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
addItem() | Adds an auth item to the RBAC system. | yii\rbac\BaseManager
addRule() | Adds a rule to the RBAC system. | yii\rbac\BaseManager
executeRule() | Executes the rule associated with the specified auth item. | yii\rbac\BaseManager
getItem() | Returns the named auth item. | yii\rbac\BaseManager
getItems() | Returns the items of the specified type. | yii\rbac\BaseManager
hasNoAssignments() | Checks whether array of $assignments is empty and $defaultRoles property is empty as well. | yii\rbac\BaseManager
removeItem() | Removes an auth item from the RBAC system. | yii\rbac\BaseManager
removeRule() | Removes a rule from the RBAC system. | yii\rbac\BaseManager
updateItem() | Updates an auth item in the RBAC system. | yii\rbac\BaseManager
updateRule() | Updates a rule to the RBAC system. | yii\rbac\BaseManager

## Property Details

Hide inherited properties

$defaultRoleInstances public property

Default roles. The array is indexed by the role names.

public yii\rbac\Role[] $defaultRoleInstances = null
$defaultRoles protected property

A list of role names that are assigned to every user automatically without calling assign(). Note that these roles are applied to users, regardless of their state of authentication.

protected array $defaultRoles = []
$permissions public read-only property

All permissions in the system. The array is indexed by the permission names.

public yii\rbac\Permission[] getPermissions ( )
$roles public read-only property

All roles in the system. The array is indexed by the role names.

public yii\rbac\Role[] getRoles ( )

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

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.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $object) {
            if ($object->hasMethod($name)) {
                return call_user_func_array([$object, $name], $params);
            }
        }
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__clone() public method

Defined in: yii\base\Component::__clone()

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

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

public void __clone ( )

Source code

                    public function __clone()
    {
        $this->_events = [];
        $this->_eventWildcards = [];
        $this->_behaviors = null;
    }

__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

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.

public void __construct ( $config = [] )
$config | array | Name-value pairs that will be used to initialize the object properties

Source code

                    public function __construct($config = [])
    {
        if (!empty($config)) {
            Yii::configure($this, $config);
        }
        $this->init();
    }

__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

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;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value or the value of a behavior's property
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only.

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            // read property, e.g. getName()
            return $this->$getter();
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name;
            }
        }
        if (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\Component::__isset()

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

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)`.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name !== null;
            }
        }
        return false;
    }

__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

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;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only.

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            // set property
            $this->$setter($value);
            return;
        } elseif (strncmp($name, 'on ', 3) === 0) {
            // on event: attach event handler
            $this->on(trim(substr($name, 3)), $value);
            return;
        } elseif (strncmp($name, 'as ', 3) === 0) {
            // as behavior: attach behavior
            $name = trim(substr($name, 3));
            $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = $value;
                return;
            }
        }
        if (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }

__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

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)`.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = null;
                return;
            }
        }
        throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
    }

add() public method

Adds a role, permission or rule to the RBAC system.

public boolean add ( $object )
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the role, permission or rule is successfully added to the system
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    public function add($object)
    {
        if ($object instanceof Item) {
            if ($object->ruleName && $this->getRule($object->ruleName) === null) {
                $rule = \Yii::createObject($object->ruleName);
                $rule->name = $object->ruleName;
                $this->addRule($rule);
            }
            return $this->addItem($object);
        } elseif ($object instanceof Rule) {
            return $this->addRule($object);
        }
        throw new InvalidArgumentException('Adding unsupported object type.');
    }

addChild() public abstract method

Defined in: yii\rbac\ManagerInterface::addChild()

Adds an item as a child of another item.

public abstract boolean addChild ( $parent, $child )
$parent | yii\rbac\Item |
$child | yii\rbac\Item |
return | boolean | Whether the child successfully added
throws | yii\base\Exception | if the parent-child relationship already exists or if a loop has been detected.

Source code

                    public function addChild($parent, $child);

addItem() protected abstract method

Adds an auth item to the RBAC system.

protected abstract boolean addItem ( $item )
$item | yii\rbac\Item | The item to add
return | boolean | Whether the auth item is successfully added to the system
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    abstract protected function addItem($item);

addRule() protected abstract method

Adds a rule to the RBAC system.

protected abstract boolean addRule ( $rule )
$rule | yii\rbac\Rule | The rule to add
return | boolean | Whether the rule is successfully added to the system
throws | Exception | if data validation or saving fails (such as the name of the rule is not unique)

Source code

                    abstract protected function addRule($rule);

assign() public abstract method

Defined in: yii\rbac\ManagerInterface::assign()

Assigns a role to a user.

public abstract yii\rbac\Assignment assign ( $role, $userId )
$role | yii\rbac\Role|yii\rbac\Permission |
$userId | string|integer | The user ID (see yii\web\User::$id)
return | yii\rbac\Assignment | The role assignment information.
throws | Exception | if the role has already been assigned to the user

Source code

                    public function assign($role, $userId);

attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

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 yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name | string | The name of the behavior.

$behavior

string|array|yii\base\Behavior

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

- a yii\base\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 | yii\base\Behavior | The behavior object

Source code

                    public function attachBehavior($name, $behavior)
    {
        $this->ensureBehaviors();
        return $this->attachBehaviorInternal($name, $behavior);
    }

attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

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

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors | array | List of behaviors to be attached to the component

Source code

                    public function attachBehaviors($behaviors)
    {
        $this->ensureBehaviors();
        foreach ($behaviors as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }

behaviors() public method

Defined in: yii\base\Component::behaviors()

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

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 yii\base\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).

public array behaviors ( )
return | array | The behavior configurations.

Source code

                    public function behaviors()
    {
        return [];
    }

canAddChild() public abstract method (available since version 2.0.8)

Defined in: yii\rbac\ManagerInterface::canAddChild()

Checks the possibility of adding a child to parent.

public abstract boolean canAddChild ( $parent, $child )
$parent | yii\rbac\Item | The parent item
$child | yii\rbac\Item | The child item to be added to the hierarchy
return | boolean | Possibility of adding

Source code

                    public function canAddChild($parent, $child);

canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

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).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canGetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

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).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canSetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

createPermission() public method

Creates a new Permission object.

Note that the newly created permission is not added to the RBAC system yet. You must fill in the needed data and call add() to add it to the system.

public yii\rbac\Permission createPermission ( $name )
$name | string | The permission name
return | yii\rbac\Permission | The new Permission object

Source code

                    public function createPermission($name)
    {
        $permission = new Permission();
        $permission->name = $name;
        return $permission;
    }

createRole() public method

Creates a new Role object.

Note that the newly created role is not added to the RBAC system yet. You must fill in the needed data and call add() to add it to the system.

public yii\rbac\Role createRole ( $name )
$name | string | The role name
return | yii\rbac\Role | The new Role object

Source code

                    public function createRole($name)
    {
        $role = new Role();
        $role->name = $name;
        return $role;
    }

detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name | string | The behavior's name.
return | yii\base\Behavior|null | The detached behavior. Null if the behavior does not exist.

Source code

                    public function detachBehavior($name)
    {
        $this->ensureBehaviors();
        if (isset($this->_behaviors[$name])) {
            $behavior = $this->_behaviors[$name];
            unset($this->_behaviors[$name]);
            $behavior->detach();
            return $behavior;
        }
        return null;
    }

detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

Source code

                    public function detachBehaviors()
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $name => $behavior) {
            $this->detachBehavior($name);
        }
    }

ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

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

public void ensureBehaviors ( )

Source code

                    public function ensureBehaviors()
    {
        if ($this->_behaviors === null) {
            $this->_behaviors = [];
            foreach ($this->behaviors() as $name => $behavior) {
                $this->attachBehaviorInternal($name, $behavior);
            }
        }
    }

executeRule() protected method

Executes the rule associated with the specified auth item.

If the item does not specify a rule, this method will return true. Otherwise, it will return the value of yii\rbac\Rule::execute().

protected boolean executeRule ( $user, $item, $params )
$user | string|integer | The user ID. This should be either an integer or a string representing the unique identifier of a user. See yii\web\User::$id.
$item | yii\rbac\Item | The auth item that needs to execute its rule
$params | array | Parameters passed to yii\rbac\CheckAccessInterface::checkAccess() and will be passed to the rule
return | boolean | The return value of yii\rbac\Rule::execute(). If the auth item does not specify a rule, true will be returned.
throws | yii\base\InvalidConfigException | if the auth item has an invalid rule.

Source code

                    protected function executeRule($user, $item, $params)
    {
        if ($item->ruleName === null) {
            return true;
        }
        $rule = $this->getRule($item->ruleName);
        if ($rule instanceof Rule) {
            return $rule->execute($user, $item, $params);
        }
        throw new InvalidConfigException("Rule not found: {$item->ruleName}");
    }

getAssignment() public abstract method

Defined in: yii\rbac\ManagerInterface::getAssignment()

Returns the assignment information regarding a role and a user.

public abstract yii\rbac\Assignment|null getAssignment ( $roleName, $userId )
$roleName | string | The role name
$userId | string|integer | The user ID (see yii\web\User::$id)
return | yii\rbac\Assignment|null | The assignment information. Null is returned if the role is not assigned to the user.

Source code

                    public function getAssignment($roleName, $userId);

getAssignments() public abstract method

Defined in: yii\rbac\ManagerInterface::getAssignments()

Returns all role assignment information for the specified user.

public abstract yii\rbac\Assignment[] getAssignments ( $userId )
$userId | string|integer | The user ID (see yii\web\User::$id)
return | yii\rbac\Assignment[] | The assignments indexed by role names. An empty array will be returned if there is no role assigned to the user.

Source code

                    public function getAssignments($userId);

getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name | string | The behavior name
return | yii\base\Behavior|null | The behavior object, or null if the behavior does not exist

Source code

                    public function getBehavior($name)
    {
        $this->ensureBehaviors();
        return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
    }

getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return | yii\base\Behavior[] | List of behaviors attached to this component

Source code

                    public function getBehaviors()
    {
        $this->ensureBehaviors();
        return $this->_behaviors;
    }

getChildRoles() public abstract method (available since version 2.0.10)

Defined in: yii\rbac\ManagerInterface::getChildRoles()

Returns child roles of the role specified. Depth isn't limited.

public abstract yii\rbac\Role[] getChildRoles ( $roleName )
$roleName | string | Name of the role to file child roles for
return | yii\rbac\Role[] | Child roles. The array is indexed by the role names. First element is an instance of the parent Role itself.
throws | yii\base\InvalidParamException | if Role was not found that are getting by $roleName

Source code

                    public function getChildRoles($roleName);

getChildren() public abstract method

Defined in: yii\rbac\ManagerInterface::getChildren()

Returns the child permissions and/or roles.

public abstract yii\rbac\Item[] getChildren ( $name )
$name | string | The parent name
return | yii\rbac\Item[] | The child permissions and/or roles

Source code

                    public function getChildren($name);

getDefaultRoleInstances() public method (available since version 2.0.12)

Returns defaultRoles as array of Role objects.

public yii\rbac\Role[] getDefaultRoleInstances ( )
return | yii\rbac\Role[] | Default roles. The array is indexed by the role names

Source code

                    public function getDefaultRoleInstances()
    {
        $result = [];
        foreach ($this->defaultRoles as $roleName) {
            $result[$roleName] = $this->createRole($roleName);
        }
        return $result;
    }

getDefaultRoles() public method (available since version 2.0.14)

Get default roles

public string[] getDefaultRoles ( )
return | string[] | Default roles

Source code

                    public function getDefaultRoles()
    {
        return $this->defaultRoles;
    }

getItem() protected abstract method

Returns the named auth item.

protected abstract yii\rbac\Item|null getItem ( $name )
$name | string | The auth item name.
return | yii\rbac\Item|null | The auth item corresponding to the specified name. Null is returned if no such item.

Source code

                    abstract protected function getItem($name);

getItems() protected abstract method

Returns the items of the specified type.

protected abstract yii\rbac\Item[] getItems ( $type )
$type | integer | The auth item type (either yii\rbac\Item::TYPE_ROLE or yii\rbac\Item::TYPE_PERMISSION
return | yii\rbac\Item[] | The auth items of the specified type.

Source code

                    abstract protected function getItems($type);

getPermission() public method

Returns the named permission.

public yii\rbac\Permission|null getPermission ( $name )
$name | string | The permission name.
return | yii\rbac\Permission|null | The permission corresponding to the specified name. Null is returned if no such permission.

Source code

                    public function getPermission($name)
    {
        $item = $this->getItem($name);
        return $item instanceof Item && $item->type == Item::TYPE_PERMISSION ? $item : null;
    }

getPermissions() public method

Returns all permissions in the system.

public yii\rbac\Permission[] getPermissions ( )
return | yii\rbac\Permission[] | All permissions in the system. The array is indexed by the permission names.

Source code

                    public function getPermissions()
    {
        return $this->getItems(Item::TYPE_PERMISSION);
    }

getPermissionsByRole() public abstract method

Defined in: yii\rbac\ManagerInterface::getPermissionsByRole()

Returns all permissions that the specified role represents.

public abstract yii\rbac\Permission[] getPermissionsByRole ( $roleName )
$roleName | string | The role name
return | yii\rbac\Permission[] | All permissions that the role represents. The array is indexed by the permission names.

Source code

                    public function getPermissionsByRole($roleName);

getPermissionsByUser() public abstract method

Defined in: yii\rbac\ManagerInterface::getPermissionsByUser()

Returns all permissions that the user has.

public abstract yii\rbac\Permission[] getPermissionsByUser ( $userId )
$userId | string|integer | The user ID (see yii\web\User::$id)
return | yii\rbac\Permission[] | All permissions that the user has. The array is indexed by the permission names.

Source code

                    public function getPermissionsByUser($userId);

getRole() public method

Returns the named role.

public yii\rbac\Role|null getRole ( $name )
$name | string | The role name.
return | yii\rbac\Role|null | The role corresponding to the specified name. Null is returned if no such role.

Source code

                    public function getRole($name)
    {
        $item = $this->getItem($name);
        return $item instanceof Item && $item->type == Item::TYPE_ROLE ? $item : null;
    }

getRoles() public method

Returns all roles in the system.

public yii\rbac\Role[] getRoles ( )
return | yii\rbac\Role[] | All roles in the system. The array is indexed by the role names.

Source code

                    public function getRoles()
    {
        return $this->getItems(Item::TYPE_ROLE);
    }

getRolesByUser() public abstract method

Defined in: yii\rbac\ManagerInterface::getRolesByUser()

Returns the roles that are assigned to the user via assign().

Note that child roles that are not assigned directly to the user will not be returned.

public abstract yii\rbac\Role[] getRolesByUser ( $userId )
$userId | string|integer | The user ID (see yii\web\User::$id)
return | yii\rbac\Role[] | All roles directly assigned to the user. The array is indexed by the role names.

Source code

                    public function getRolesByUser($userId);

getRule() public abstract method

Defined in: yii\rbac\ManagerInterface::getRule()

Returns the rule of the specified name.

public abstract yii\rbac\Rule|null getRule ( $name )
$name | string | The rule name
return | yii\rbac\Rule|null | The rule object, or null if the specified name does not correspond to a rule.

Source code

                    public function getRule($name);

getRules() public abstract method

Defined in: yii\rbac\ManagerInterface::getRules()

Returns all rules available in the system.

public abstract yii\rbac\Rule[] getRules ( )
return | yii\rbac\Rule[] | The rules indexed by the rule names

Source code

                    public function getRules();

getUserIdsByRole() public abstract method (available since version 2.0.7)

Defined in: yii\rbac\ManagerInterface::getUserIdsByRole()

Returns all user IDs assigned to the role specified.

public abstract array getUserIdsByRole ( $roleName )
$roleName | string |
return | array | Array of user ID strings

Source code

                    public function getUserIdsByRole($roleName);

hasChild() public abstract method

Defined in: yii\rbac\ManagerInterface::hasChild()

Returns a value indicating whether the child already exists for the parent.

public abstract boolean hasChild ( $parent, $child )
$parent | yii\rbac\Item |
$child | yii\rbac\Item |
return | boolean | Whether `$child` is already a child of `$parent`

Source code

                    public function hasChild($parent, $child);

hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

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

public boolean hasEventHandlers ( $name )
$name | string | The event name
return | boolean | Whether there is any handler attached to the event.

Source code

                    public function hasEventHandlers($name)
    {
        $this->ensureBehaviors();
        if (!empty($this->_events[$name])) {
            return true;
        }
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
                return true;
            }
        }
        return Event::hasHandlers($this, $name);
    }

hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

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).

public boolean hasMethod ( $name, $checkBehaviors = true )
$name | string | The property name
$checkBehaviors | boolean | Whether to treat behaviors' methods as methods of this component
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name, $checkBehaviors = true)
    {
        if (method_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->hasMethod($name)) {
                    return true;
                }
            }
        }
        return false;
    }

hasNoAssignments() protected method (available since version 2.0.11)

Checks whether array of $assignments is empty and $defaultRoles property is empty as well.

protected boolean hasNoAssignments ( array $assignments )
$assignments | yii\rbac\Assignment[] | Array of user's assignments
return | boolean | Whether array of $assignments is empty and $defaultRoles property is empty as well

Source code

                    protected function hasNoAssignments(array $assignments)
    {
        return empty($assignments) && empty($this->defaultRoles);
    }

hasProperty() public method

Defined in: yii\base\Component::hasProperty()

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

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).

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
    }

init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

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

public void init ( )

Source code

                    public function init()
    {
    }

off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

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.

See also on().

public boolean off ( $name, $handler = null )
$name | string | Event name
$handler | callable|null | The event handler to be removed. If it is null, all handlers attached to the named event will be removed.
return | boolean | If a handler is found and detached

Source code

                    public function off($name, $handler = null)
    {
        $this->ensureBehaviors();
        if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
            return false;
        }
        if ($handler === null) {
            unset($this->_events[$name], $this->_eventWildcards[$name]);
            return true;
        }
        $removed = false;
        // plain event names
        if (isset($this->_events[$name])) {
            foreach ($this->_events[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_events[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_events[$name] = array_values($this->_events[$name]);
                return true;
            }
        }
        // wildcard event names
        if (isset($this->_eventWildcards[$name])) {
            foreach ($this->_eventWildcards[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_eventWildcards[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
                // remove empty wildcards to save future redundant regex checks:
                if (empty($this->_eventWildcards[$name])) {
                    unset($this->_eventWildcards[$name]);
                }
            }
        }
        return $removed;
    }

on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

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 yii\base\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.');
    });

See also off().

public void on ( $name, $handler, $data = null, $append = true )
$name | string | The event name
$handler | callable | The event handler
$data | mixed | 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 yii\base\Event::$data.
$append | boolean | 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.

Source code

                    public function on($name, $handler, $data = null, $append = true)
    {
        $this->ensureBehaviors();
        if (strpos($name, '*') !== false) {
            if ($append || empty($this->_eventWildcards[$name])) {
                $this->_eventWildcards[$name][] = [$handler, $data];
            } else {
                array_unshift($this->_eventWildcards[$name], [$handler, $data]);
            }
            return;
        }
        if ($append || empty($this->_events[$name])) {
            $this->_events[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_events[$name], [$handler, $data]);
        }
    }

remove() public method

Removes a role, permission or rule from the RBAC system.

public boolean remove ( $object )
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the role, permission or rule is successfully removed

Source code

                    public function remove($object)
    {
        if ($object instanceof Item) {
            return $this->removeItem($object);
        } elseif ($object instanceof Rule) {
            return $this->removeRule($object);
        }
        throw new InvalidArgumentException('Removing unsupported object type.');
    }

removeAll() public abstract method

Defined in: yii\rbac\ManagerInterface::removeAll()

Removes all authorization data, including roles, permissions, rules, and assignments.

public abstract void removeAll ( )

Source code

                    public function removeAll();

removeAllAssignments() public abstract method

Defined in: yii\rbac\ManagerInterface::removeAllAssignments()

Removes all role assignments.

public abstract void removeAllAssignments ( )

Source code

                    public function removeAllAssignments();

removeAllPermissions() public abstract method

Defined in: yii\rbac\ManagerInterface::removeAllPermissions()

Removes all permissions.

All parent child relations will be adjusted accordingly.

public abstract void removeAllPermissions ( )

Source code

                    public function removeAllPermissions();

removeAllRoles() public abstract method

Defined in: yii\rbac\ManagerInterface::removeAllRoles()

Removes all roles.

All parent child relations will be adjusted accordingly.

public abstract void removeAllRoles ( )

Source code

                    public function removeAllRoles();

removeAllRules() public abstract method

Defined in: yii\rbac\ManagerInterface::removeAllRules()

Removes all rules.

All roles and permissions which have rules will be adjusted accordingly.

public abstract void removeAllRules ( )

Source code

                    public function removeAllRules();

removeChild() public abstract method

Defined in: yii\rbac\ManagerInterface::removeChild()

Removes a child from its parent.

Note, the child item is not deleted. Only the parent-child relationship is removed.

public abstract boolean removeChild ( $parent, $child )
$parent | yii\rbac\Item |
$child | yii\rbac\Item |
return | boolean | Whether the removal is successful

Source code

                    public function removeChild($parent, $child);

removeChildren() public abstract method

Defined in: yii\rbac\ManagerInterface::removeChildren()

Removed all children form their parent.

Note, the children items are not deleted. Only the parent-child relationships are removed.

public abstract boolean removeChildren ( $parent )
$parent | yii\rbac\Item |
return | boolean | Whether the removal is successful

Source code

                    public function removeChildren($parent);

removeItem() protected abstract method

Removes an auth item from the RBAC system.

protected abstract boolean removeItem ( $item )
$item | yii\rbac\Item | The item to remove
return | boolean | Whether the role or permission is successfully removed
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    abstract protected function removeItem($item);

removeRule() protected abstract method

Removes a rule from the RBAC system.

protected abstract boolean removeRule ( $rule )
$rule | yii\rbac\Rule | The rule to remove
return | boolean | Whether the rule is successfully removed
throws | Exception | if data validation or saving fails (such as the name of the rule is not unique)

Source code

                    abstract protected function removeRule($rule);

revoke() public abstract method

Defined in: yii\rbac\ManagerInterface::revoke()

Revokes a role from a user.

public abstract boolean revoke ( $role, $userId )
$role | yii\rbac\Role|yii\rbac\Permission |
$userId | string|integer | The user ID (see yii\web\User::$id)
return | boolean | Whether the revoking is successful

Source code

                    public function revoke($role, $userId);

revokeAll() public abstract method

Defined in: yii\rbac\ManagerInterface::revokeAll()

Revokes all roles from a user.

public abstract boolean revokeAll ( $userId )
$userId | mixed | The user ID (see yii\web\User::$id)
return | boolean | Whether the revoking is successful

Source code

                    public function revokeAll($userId);

setDefaultRoles() public method (available since version 2.0.14)

Set default roles

public void setDefaultRoles ( $roles )
$roles | string[]|Closure | Either array of roles or a callable returning it
throws | yii\base\InvalidArgumentException | when $roles is neither array nor Closure
throws | yii\base\InvalidValueException | when Closure return is not an array

Source code

                    public function setDefaultRoles($roles)
    {
        if (is_array($roles)) {
            $this->defaultRoles = $roles;
        } elseif ($roles instanceof \Closure) {
            $roles = call_user_func($roles);
            if (!is_array($roles)) {
                throw new InvalidValueException('Default roles closure must return an array');
            }
            $this->defaultRoles = $roles;
        } else {
            throw new InvalidArgumentException('Default roles must be either an array or a callable');
        }
    }

trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

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

public void trigger ( $name, yii\base\Event $event = null )
$name | string | The event name
$event | yii\base\Event|null | The event instance. If not set, a default yii\base\Event object will be created.

Source code

                    public function trigger($name, Event $event = null)
    {
        $this->ensureBehaviors();
        $eventHandlers = [];
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (StringHelper::matchWildcard($wildcard, $name)) {
                $eventHandlers[] = $handlers;
            }
        }
        if (!empty($this->_events[$name])) {
            $eventHandlers[] = $this->_events[$name];
        }
        if (!empty($eventHandlers)) {
            $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
            if ($event === null) {
                $event = new Event();
            }
            if ($event->sender === null) {
                $event->sender = $this;
            }
            $event->handled = false;
            $event->name = $name;
            foreach ($eventHandlers as $handler) {
                $event->data = $handler[1];
                call_user_func($handler[0], $event);
                // stop further handling if the event is handled
                if ($event->handled) {
                    return;
                }
            }
        }
        // invoke class-level attached handlers
        Event::trigger($this, $name, $event);
    }

update() public method

Updates the specified role, permission or rule in the system.

public boolean update ( $name, $object )
$name | string | The old name of the role, permission or rule
$object | yii\rbac\Role|yii\rbac\Permission|yii\rbac\Rule |
return | boolean | Whether the update is successful
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    public function update($name, $object)
    {
        if ($object instanceof Item) {
            if ($object->ruleName && $this->getRule($object->ruleName) === null) {
                $rule = \Yii::createObject($object->ruleName);
                $rule->name = $object->ruleName;
                $this->addRule($rule);
            }
            return $this->updateItem($name, $object);
        } elseif ($object instanceof Rule) {
            return $this->updateRule($name, $object);
        }
        throw new InvalidArgumentException('Updating unsupported object type.');
    }

updateItem() protected abstract method

Updates an auth item in the RBAC system.

protected abstract boolean updateItem ( $name, $item )
$name | string | The name of the item being updated
$item | yii\rbac\Item | The updated item
return | boolean | Whether the auth item is successfully updated
throws | Exception | if data validation or saving fails (such as the name of the role or permission is not unique)

Source code

                    abstract protected function updateItem($name, $item);

updateRule() protected abstract method

Updates a rule to the RBAC system.

protected abstract boolean updateRule ( $name, $rule )
$name | string | The name of the rule being updated
$rule | yii\rbac\Rule | The updated rule
return | boolean | Whether the rule is successfully updated
throws | Exception | if data validation or saving fails (such as the name of the rule is not unique)

Source code

                    abstract protected function updateRule($name, $rule);