Role Class Reference

Inheritance diagram for Role:

Public Member Functions
	__construct (\Magento\Authorization\Model\Acl\Role\GroupFactory $groupFactory, \Magento\Authorization\Model\Acl\Role\UserFactory $roleFactory, \Magento\Framework\App\ResourceConnection $resource, \Magento\Framework\Acl\Data\CacheInterface $aclDataCache=null, Json $serializer=null, $cacheKey=self::ACL_ROLES_CACHE_KEY)
	populateAcl (\Magento\Framework\Acl $acl)
Public Member Functions inherited from LoaderInterface
	populateAcl (\Magento\Framework\Acl $acl)

Data Fields
const	ACL_ROLES_CACHE_KEY = 'authorization_role_cached_data'

Protected Attributes
	$_resource
	$_groupFactory
	$_roleFactory

Detailed Description

Definition at line 13 of file Role.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Authorization\Model\Acl\Role\GroupFactory	$groupFactory,
		\Magento\Authorization\Model\Acl\Role\UserFactory	$roleFactory,
		\Magento\Framework\App\ResourceConnection	$resource,
		\Magento\Framework\Acl\Data\CacheInterface	$aclDataCache = null,
		Json	$serializer = null,
			$cacheKey = self::ACL_ROLES_CACHE_KEY
	)

Parameters

\Magento\Authorization\Model\Acl\Role\GroupFactory	$groupFactory
\Magento\Authorization\Model\Acl\Role\UserFactory	$roleFactory
\Magento\Framework\App\ResourceConnection	$resource
\Magento\Framework\Acl\Data\CacheInterface	$aclDataCache
Json	$serializer
string	$cacheKey

Definition at line 58 of file Role.php.

      {
        $this->_resource = $resource;
        $this->_groupFactory = $groupFactory;
        $this->_roleFactory = $roleFactory;
        $this->aclDataCache = $aclDataCache ?: ObjectManager::getInstance()->get(
            \Magento\Framework\Acl\Data\CacheInterface::class
        );
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
        $this->cacheKey = $cacheKey;
    }

Member Function Documentation

populateAcl()

populateAcl

(

\Magento\Framework\Acl

$acl

)

Populate ACL with roles from external storage

Parameters

\Magento\Framework\Acl

$acl

Returns

void

Definition at line 82 of file Role.php.

    {
        foreach ($this->getRolesArray() as $role) {
            $parent = $role['parent_id'] > 0 ? $role['parent_id'] : null;
            switch ($role['role_type']) {
                case RoleGroup::ROLE_TYPE:
                    $acl->addRole($this->_groupFactory->create(['roleId' => $role['role_id']]), $parent);
                    break;

                case RoleUser::ROLE_TYPE:
                    if (!$acl->hasRole($role['role_id'])) {
                        $acl->addRole($this->_roleFactory->create(['roleId' => $role['role_id']]), $parent);
                    } else {
                        $acl->addRoleParent($role['role_id'], $parent);
                    }
                    break;
            }
        }
    }

Field Documentation

$_groupFactory

$_groupFactory

protected

Definition at line 28 of file Role.php.

$_resource

$_resource

protected

Definition at line 23 of file Role.php.

$_roleFactory

$_roleFactory

protected

Definition at line 33 of file Role.php.

ACL_ROLES_CACHE_KEY

const ACL_ROLES_CACHE_KEY = 'authorization_role_cached_data'

Cache key for ACL roles cache

Definition at line 18 of file Role.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-authorization/Model/Acl/Loader/Role.php