Builder Class Reference

Public Member Functions
	__construct (\Magento\Framework\AclFactory $aclFactory, \Magento\Framework\Acl\LoaderInterface $roleLoader, \Magento\Framework\Acl\LoaderInterface $resourceLoader, \Magento\Framework\Acl\LoaderInterface $ruleLoader)
	getAcl ()
	resetRuntimeAcl ()

Protected Attributes
	$_acl
	$_loaderPool
	$_aclFactory

Detailed Description

Access Control List Builder. Retrieves required role/rule/resource loaders and uses them to populate provided ACL object. Acl object is put to cache after creation. On consequent requests, ACL object is deserialized from cache.

@api

Since

100.0.2

Definition at line 16 of file Builder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\AclFactory	$aclFactory,
		\Magento\Framework\Acl\LoaderInterface	$roleLoader,
		\Magento\Framework\Acl\LoaderInterface	$resourceLoader,
		\Magento\Framework\Acl\LoaderInterface	$ruleLoader
	)

Parameters

\Magento\Framework\AclFactory	$aclFactory
\Magento\Framework\Acl\LoaderInterface	$roleLoader
\Magento\Framework\Acl\LoaderInterface	$resourceLoader
\Magento\Framework\Acl\LoaderInterface	$ruleLoader

Definition at line 43 of file Builder.php.

      {
        $this->_aclFactory = $aclFactory;
        $this->_loaderPool = [$roleLoader, $resourceLoader, $ruleLoader];
    }

Member Function Documentation

getAcl()

getAcl

(

)

Build Access Control List

Returns

\Magento\Framework\Acl

Exceptions

Definition at line 59 of file Builder.php.

    {
        if ($this->_acl instanceof \Magento\Framework\Acl) {
            return $this->_acl;
        }

        try {
            $this->_acl = $this->_aclFactory->create();
            foreach ($this->_loaderPool as $loader) {
                $loader->populateAcl($this->_acl);
            }
        } catch (\Exception $e) {
            throw new \LogicException('Could not create an acl object: ' . $e->getMessage());
        }

        return $this->_acl;
    }

resetRuntimeAcl()

resetRuntimeAcl

(

)

Remove cached ACL instance.

Returns

$this

Since

101.0.0

Definition at line 83 of file Builder.php.

    {
        $this->_acl = null;
        return $this;
    }

Field Documentation

$_acl

$_acl

protected

Definition at line 23 of file Builder.php.

$_aclFactory

$_aclFactory

protected

Definition at line 35 of file Builder.php.

$_loaderPool

$_loaderPool

protected

Definition at line 30 of file Builder.php.

---

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

• vendor/magento/framework/Acl/Builder.php