Class luya\admin\components\AdminMenu

Inheritanceluya\admin\components\AdminMenu » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.0

Admin Menu Data.

Collect informations from the menu data based on the admin modules in order to generate the different admin menu levels and containers.

Public Properties

Hide inherited properties

Property Type Description Defined By
$adminModuleMenus array An array with \luya\admin\components\AdminMenuBuilderInterface objects. luya\admin\components\AdminMenu
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$items array luya\admin\components\AdminMenu
$menu array Returns an array with all menu elements. luya\admin\components\AdminMenu
$modules array Returns an array with all modules you have permission for. luya\admin\components\AdminMenu
$userId integer Returns the current admin user id. luya\admin\components\AdminMenu

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
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
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
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
getAdminModuleMenus() Get the module menus. luya\admin\components\AdminMenu
getApiDetail() Return all informations about a menu point based on the api endpoint name. luya\admin\components\AdminMenu
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getItems() Get all items for all nodes. luya\admin\components\AdminMenu
getMenu() Return the menu array entries from all registered admin modules. luya\admin\components\AdminMenu
getModuleItems() Returns the node with a groups array where each groups contains an items array with the item. luya\admin\components\AdminMenu
getModules() Returns an Array with modules and checks the permission for those. luya\admin\components\AdminMenu
getNodeData() Get the node for a given array key. luya\admin\components\AdminMenu
getUserId() Get current admin user id. luya\admin\components\AdminMenu
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
trigger() Triggers an event. yii\base\Component

Property Details

Hide inherited properties

$adminModuleMenus public property

An array with \luya\admin\components\AdminMenuBuilderInterface objects.

public array $adminModuleMenus null
$items public read-only property
public array getItems ( )
$menu public property

Returns an array with all menu elements.

public array $menu null
$modules public read-only property

Returns an array with all modules you have permission for.

public array getModules ( )
$userId public property

Returns the current admin user id.

public integer $userId null

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

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

                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

                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.

                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

                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.

                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.

                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);
}

            
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:

return yii\base\Behavior

The behavior object

                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

                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.

                public function behaviors()
{
    return [];
}

            
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

                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

                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.

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

            
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.

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

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

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

            
getAdminModuleMenus() public method

Get the module menus.

public luya\admin\components\AdminMenuBuilderInterface getAdminModuleMenus ( )
return luya\admin\components\AdminMenuBuilderInterface

An array with AdminMenuBuilderInterface objects.

                public function getAdminModuleMenus()
{
    return Yii::$app->getAdminModulesMenus();
}

            
getApiDetail() public method

Return all informations about a menu point based on the api endpoint name.

public array|boolean getApiDetail ( $api, $pool null )
$api string

The Api Endpoint

$pool

                public function getApiDetail($api, $pool = null)
{
    $items = $this->getItems();
    if ($pool) {
        $items = ArrayHelper::searchColumns($items, 'pool', $pool);
    }
    $items = array_values($items); // reset keys to fix isset error
    return ArrayHelper::searchColumn($items, 'permissionApiEndpoint', $api);
}

            
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

                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

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

            
getItems() public method

Get all items for all nodes.

public array getItems ( )

                public function getItems()
{
    if ($this->_items !== null) {
        return $this->_items;
    }
    $data = [];
    foreach ($this->getModules() as $node) {
        foreach (ArrayHelper::getValue($this->getModuleItems($node['id']), 'groups', []) as $groupValue) {
            foreach ($groupValue['items'] as $array) {
                $array['module'] = $node;
                $data[] = $array;
            }
        }
    }
    $this->_items = $data;
    return $data;
}

            
getMenu() public method

Return the menu array entries from all registered admin modules.

Response array is organized as follow:

  • Node (Root level menu)
    • Group
      • Items

Example array response:

Array (
[id] => 1, // auto assigned
[moduleId] => admin
[template] =>
[routing] => default
[alias] => menu_node_system
[icon] => layers
[permissionRoute] =>
[permissionIsRoute] =>
[searchModelClass] =>
[groups] => Array ( // Optional
       [menu_group_access] => Array  (
              [name] => menu_group_access
              [items] => Array  (
                      [0] => Array (
                              [alias] => menu_access_item_user
                              [route] => admin/user/index
                              [icon] => person
                              [permissionApiEndpoint] => api-admin-user
                              [permissionIsRoute] =>
                              [permissionIsApi] => 1
                              [searchModelClass] =>
                              [options] => Array ()
                          )
                      [1] => Array  (
                              [alias] => menu_access_item_group
                              [route] => admin/group/index
                              [icon] => group
                              [permissionApiEndpoint] => api-admin-group
                              [permissionIsRoute] =>
                              [permissionIsApi] => 1
                              [searchModelClass] =>
                              [options] => Array ( )
                          )
                  )
          )
)
public array getMenu ( )

                public function getMenu()
{
    if ($this->_menu !== null) {
        return $this->_menu;
    }
    $menu = [];
    foreach ($this->getAdminModuleMenus() as $menuBuilder) {
        // removed legacy support, menu must be instance of AdminmenuBuilderInterface
        if (!$menuBuilder instanceof AdminMenuBuilderInterface) {
            throw new Exception("admin menu must be instance of AdminMenuBuilderInterface");
        }
        // call the interface menu method returns the array for the given Module.
        $data = $menuBuilder->menu();
        $menu = ArrayHelper::merge($menu, $data);
    }
    $this->_menu = $menu;
    return $menu;
}

            
getModuleItems() public method

Returns the node with a groups array where each groups contains an items array with the item.

public array getModuleItems ( $nodeId )
$nodeId integer
return array

If there are not groups, or not items for a group an empty array will be returned.

throws Exception

                public function getModuleItems($nodeId)
{
    if (isset($this->_nodeItems[$nodeId])) {
        return $this->_nodeItems[$nodeId];
    }
    $data = $this->getNodeData($nodeId);
    if (isset($data['groups'])) {
        foreach ($data['groups'] as $groupName => $groupItem) {
            // translate the group names
            try {
                $data['groups'][$groupName]['name'] = Yii::t($data['moduleId'], $groupItem['name'], [], Yii::$app->language);
            } catch (\Exception $e) {
                // do nothing and keep the current name inside the array
            }
            foreach ($groupItem['items'] as $groupItemKey => $groupItemEntry) {
                if ($groupItemEntry['permissionIsRoute']) {
                    $id = Yii::$app->auth->matchRoute($this->getUserId(), $groupItemEntry['route']);
                    if (!$id) {
                        unset($data['groups'][$groupName]['items'][$groupItemKey]);
                        continue;
                    }
                } elseif ($groupItemEntry['permissionIsApi']) {
                    $id = Yii::$app->auth->matchApi($this->getUserId(), $groupItemEntry['permissionApiEndpoint']);
                    if (!$id) {
                        unset($data['groups'][$groupName]['items'][$groupItemKey]);
                        continue;
                    }
                } else {
                    throw new Exception('Menu item detected without permission entry');
                }
                try {
                    $alias = Yii::t($data['moduleId'], $data['groups'][$groupName]['items'][$groupItemKey]['alias'], [], Yii::$app->language);
                } catch (\Exception $err) {
                    $alias = $data['groups'][$groupName]['items'][$groupItemKey]['alias'];
                }
                // if a pool is available, the route will be modified by appending the pool param
                $pool = AdminMenuBuilder::getOptionValue($groupItemEntry, 'pool', null);
                if ($pool) {
                    $data['groups'][$groupName]['items'][$groupItemKey]['route'] = $data['groups'][$groupName]['items'][$groupItemKey]['route'] . '?pool='.$pool;
                }
                $data['groups'][$groupName]['items'][$groupItemKey]['hiddenInMenu'] = AdminMenuBuilder::getOptionValue($groupItemEntry, 'hiddenInMenu', false);
                $data['groups'][$groupName]['items'][$groupItemKey]['pool'] = AdminMenuBuilder::getOptionValue($groupItemEntry, 'pool', null);
                $data['groups'][$groupName]['items'][$groupItemKey]['alias'] = $alias;
                $data['groups'][$groupName]['items'][$groupItemKey]['authId'] = $id;
            }
            // if there are no items for this group, unset the group from the data array
            if ((is_countable($data['groups'][$groupName]['items']) ? count($data['groups'][$groupName]['items']) : 0) == 0) {
                unset($data['groups'][$groupName]);
            }
        }
        // if there are no groups reset the array to an empty array
        if (empty($data['groups'])) {
            $data = [];
        }
    } else {
        // as we want to catch all groups and the items of the groups, if the group has no items reset the array to an empty arrray
        $data = [];
    }
    $this->_nodeItems[$nodeId] = $data;
    return $data;
}

            
getModules() public method

Returns an Array with modules and checks the permission for those.

Example Response:

Array (
'moduleId' => 'admin',
'id' => 1,
'template' => $item['template'],
'routing' => $item['routing'],
'alias' => $alias,
'icon' => $item['icon'],
'searchModelClass' => $item['searchModelClass'],
)
public array getModules ( )
return array

Returns an array with all modules you have permission for.

throws luya\Exception

                public function getModules()
{
    if ($this->_modules !== null) {
        return $this->_modules;
    }
    $responseData = [];
    foreach ($this->getMenu() as $item) {
        // check if this is an entrie with a permission
        if ($item['permissionIsRoute']) {
            // verify if the permission is provided for this user:
            // if the permission is granted will write in $responseData,
            // if not we continue;
            if (!Yii::$app->auth->matchRoute($this->getUserId(), $item['permissionRoute'])) {
                continue;
            }
        }
        $authIds = [];
        // this item does have groups
        if (isset($item['groups'])) {
            $permissionGranted = false;
            // see if the groups has items
            foreach ($item['groups'] as $groupName => $groupItem) {
                if ((is_countable($groupItem['items']) ? count($groupItem['items']) : 0) > 0) {
                    foreach ($groupItem['items'] as $groupItemEntry) {
                        if ($groupItemEntry['permissionIsRoute']) {
                            // when true, set permissionGranted to true
                            if (($id = Yii::$app->auth->matchRoute($this->getUserId(), $groupItemEntry['route']))) {
                                $authIds[] = $id;
                                $permissionGranted = true;
                            }
                        } elseif ($groupItemEntry['permissionIsApi']) {
                            // when true, set permissionGranted to true
                            if (($id = Yii::$app->auth->matchApi($this->getUserId(), $groupItemEntry['permissionApiEndpoint']))) {
                                $authIds[] = $id;
                                $permissionGranted = true;
                            }
                        } else {
                            throw new Exception('Menu item detected without permission entry');
                        }
                    }
                }
            }
            // skip menu stack for this item
            if (!$permissionGranted) {
                continue;
            }
        }
        try {
            // check if a translation exists, otherwise use alias instead.
            $alias = Yii::t($item['moduleId'], $item['alias'], [], Yii::$app->language);
        } catch (\Exception $err) {
            $alias = $item['alias'];
        }
        // ok we have passed all the tests, lets make an entry
        $responseData[] = [
            'moduleId' => $item['moduleId'],
            'id' => $item['id'],
            'authIds' => $authIds,
            'template' => $item['template'],
            'routing' => $item['routing'],
            'alias' => $alias,
            'icon' => $item['icon'],
            'searchModelClass' => $item['searchModelClass'],
        ];
    }
    $this->_modules = $responseData;
    return $responseData;
}

            
getNodeData() public method

Get the node for a given array key.

public boolean|array getNodeData ( $id )
$id integer

                public function getNodeData($id)
{
    if (!isset($this->getMenu()[$id])) {
        return false;
    }
    return $this->getMenu()[$id];
}

            
getUserId() public method

Get current admin user id.

public integer getUserId ( )

                public function getUserId()
{
    return Yii::$app->adminuser->getId();
}

            
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.

                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

                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;
}

            
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:

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

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

                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

                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.

                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]);
    }
}

            
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.

                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);
}