HumHub Documentation (unofficial)

BaseManager extends Component
in package

Application

implements ManagerInterface

AbstractYes

BaseManager is a base class implementing [[ManagerInterface]] for RBAC management.

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

Interfaces

ManagerInterface: For more details and usage information on ManagerInterface, see the [guide article on security authorization](guide:security-authorization).

Properties

$behaviors : array<string|int, Behavior>
$defaultRoleInstances : array<string|int, Role>
$defaultRoles : array<string|int, string>
$defaultRoles : array<string|int, mixed>
$_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.
add() : bool: Adds a role, permission or rule to the RBAC system.
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.
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.
createPermission() : Permission: Creates a new Permission object.
createRole() : Role: Creates a new Role object.
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.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getDefaultRoleInstances() : array<string|int, Role>: Returns defaultRoles as array of Role objects.
getDefaultRoles() : array<string|int, string>: Get default roles
getPermission() : Permission|null: Returns the named permission.
getPermissions() : array<string|int, Permission>: Returns all permissions in the system.
getRole() : Role|null: Returns the named role.
getRoles() : array<string|int, Role>: Returns all roles in the system.
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.
remove() : bool: Removes a role, permission or rule from the RBAC system.
setDefaultRoles() : mixed: Set default roles
trigger() : mixed: Triggers an event.
update() : bool: Updates the specified role, permission or rule in the system.
addItem() : bool: Adds an auth item to the RBAC system.
addRule() : bool: Adds a rule to the RBAC system.
executeRule() : bool: Executes the rule associated with the specified auth item.
getItem() : Item|null: Returns the named auth item.
getItems() : array<string|int, Item>: Returns the items of the specified type.
hasNoAssignments() : bool: Checks whether array of $assignments is empty and [[defaultRoles]] property is empty as well.
removeItem() : bool: Removes an auth item from the RBAC system.
removeRule() : bool: Removes a rule from the RBAC system.
updateItem() : bool: Updates an auth item in the RBAC system.
updateRule() : bool: Updates a rule to the RBAC system.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$defaultRoleInstances read-only


    public
        array<string|int, Role>
    $defaultRoleInstances

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

$defaultRoles


    public
        array<string|int, string>
    $defaultRoles

Default roles. Note that the type of this property differs in getter and setter. See [[getDefaultRoles()]] and [[setDefaultRoles()]] for details.

$defaultRoles


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

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.

$_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

add()

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


    public
                    add(mixed $object) : bool

Parameters

$object : mixed

Return values

bool —

whether the role, permission or rule is successfully added to the system

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.

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.

createPermission()

Creates a new Permission object.


    public
                    createPermission(mixed $name) : Permission

Parameters

$name : mixed: the permission name

Return values

Permission —

the new Permission object

createRole()

Creates a new Role object.


    public
                    createRole(mixed $name) : Role

Parameters

$name : mixed: the role name

Return values

Role —

the new Role object

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

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

getDefaultRoleInstances()

Returns defaultRoles as array of Role objects.


    public
                    getDefaultRoleInstances() : array<string|int, Role>

Return values

array<string|int, Role> —

default roles. The array is indexed by the role names

getDefaultRoles()

Get default roles


    public
                    getDefaultRoles() : array<string|int, string>

Return values

array<string|int, string> —

default roles

getPermission()

Returns the named permission.


    public
                    getPermission(mixed $name) : Permission|null

Parameters

$name : mixed: the permission name.

Return values

Permission|null —

the permission corresponding to the specified name. Null is returned if no such permission.

getPermissions()

Returns all permissions in the system.


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

Return values

array<string|int, Permission> —

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

getRole()

Returns the named role.


    public
                    getRole(mixed $name) : Role|null

Parameters

$name : mixed: the role name.

Return values

Role|null —

the role corresponding to the specified name. Null is returned if no such role.

getRoles()

Returns all roles in the system.


    public
                    getRoles() : array<string|int, Role>

Return values

array<string|int, Role> —

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

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.

remove()

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


    public
                    remove(mixed $object) : bool

Parameters

$object : mixed

Return values

bool —

whether the role, permission or rule is successfully removed

setDefaultRoles()

Set default roles


    public
                    setDefaultRoles(array<string|int, string>|Closure $roles) : mixed

Parameters

$roles : array<string|int, string>|Closure: either array of roles or a callable returning it

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.

update()

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


    public
                    update(mixed $name, mixed $object) : bool

Parameters

$name : mixed: the old name of the role, permission or rule
$object : mixed

Return values

bool —

whether the update is successful

addItem()

Adds an auth item to the RBAC system.


    protected
    abstract                addItem(Item $item) : bool

Parameters

$item : Item: the item to add

Return values

bool —

whether the auth item is successfully added to the system

addRule()

Adds a rule to the RBAC system.


    protected
    abstract                addRule(Rule $rule) : bool

Parameters

$rule : Rule: the rule to add

Return values

bool —

whether the rule is successfully added to the system

executeRule()

Executes the rule associated with the specified auth item.


    protected
                    executeRule(string|int $user, Item $item, array<string|int, mixed> $params) : bool

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

Parameters

$user : string|int: 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 : Item: the auth item that needs to execute its rule
$params : array<string|int, mixed>: parameters passed to [[CheckAccessInterface::checkAccess()]] and will be passed to the rule

Return values

bool —

the return value of [[Rule::execute()]]. If the auth item does not specify a rule, true will be returned.

getItem()

Returns the named auth item.


    protected
    abstract                getItem(string $name) : Item|null

Parameters

$name : string: the auth item name.

Return values

Item|null —

the auth item corresponding to the specified name. Null is returned if no such item.

getItems()

Returns the items of the specified type.


    protected
    abstract                getItems(int $type) : array<string|int, Item>

Parameters

$type : int: the auth item type (either [[Item::TYPE_ROLE]] or [[Item::TYPE_PERMISSION]]

Return values

array<string|int, Item> —

the auth items of the specified type.

hasNoAssignments()

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


    protected
                    hasNoAssignments(array<string|int, Assignment> $assignments) : bool

Parameters

$assignments : array<string|int, Assignment>: array of user's assignments

Return values

bool —

whether array of $assignments is empty and [[defaultRoles]] property is empty as well

removeItem()

Removes an auth item from the RBAC system.


    protected
    abstract                removeItem(Item $item) : bool

Parameters

$item : Item: the item to remove

Return values

bool —

whether the role or permission is successfully removed

removeRule()

Removes a rule from the RBAC system.


    protected
    abstract                removeRule(Rule $rule) : bool

Parameters

$rule : Rule: the rule to remove

Return values

bool —

whether the rule is successfully removed

updateItem()

Updates an auth item in the RBAC system.


    protected
    abstract                updateItem(string $name, Item $item) : bool

Parameters

$name : string: the name of the item being updated
$item : Item: the updated item

Return values

bool —

whether the auth item is successfully updated

updateRule()

Updates a rule to the RBAC system.


    protected
    abstract                updateRule(string $name, Rule $rule) : bool

Parameters

$name : string: the name of the rule being updated
$rule : Rule: the updated rule

Return values

bool —

whether the rule is successfully updated

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.

BaseManager extends Component in package Application implements ManagerInterface

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$behaviors read-only

$defaultRoleInstances read-only

$defaultRoles

$defaultRoles

$_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

add()

Parameters

Return values

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

createPermission()

Parameters

Return values

createRole()

Parameters

Return values

detachBehavior()

Parameters

Return values

detachBehaviors()

ensureBehaviors()

getBehavior()

Parameters

BaseManager extends Component
in package

Application

implements ManagerInterface