AuthorizationService Class Reference

Inheritance diagram for AuthorizationService:

Public Member Functions
	__construct (AclBuilder $aclBuilder, RoleFactory $roleFactory, RoleCollectionFactory $roleCollectionFactory, RulesFactory $rulesFactory, RulesCollectionFactory $rulesCollectionFactory, Logger $logger, RootAclResource $rootAclResource)
	grantPermissions ($integrationId, $resources)
	grantAllPermissions ($integrationId)
	removePermissions ($integrationId)

Protected Member Functions
	_createRole ($integrationId)
	_deleteRole ($integrationId)

Protected Attributes
	$_aclBuilder
	$_roleFactory
	$_roleCollectionFactory
	$_rulesFactory
	$_rulesCollectionFactory
	$_logger
	$_rootAclResource

Additional Inherited Members
Data Fields inherited from AuthorizationServiceInterface
const	PERMISSION_ANONYMOUS = 'anonymous'
const	PERMISSION_SELF = 'self'

Detailed Description

Service for integration permissions management.

@SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 27 of file AuthorizationService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AclBuilder	$aclBuilder,
		RoleFactory	$roleFactory,
		RoleCollectionFactory	$roleCollectionFactory,
		RulesFactory	$rulesFactory,
		RulesCollectionFactory	$rulesCollectionFactory,
		Logger	$logger,
		RootAclResource	$rootAclResource
	)

Initialize dependencies.

Parameters

AclBuilder	$aclBuilder
RoleFactory	$roleFactory
RoleCollectionFactory	$roleCollectionFactory
RulesFactory	$rulesFactory
RulesCollectionFactory	$rulesCollectionFactory
Logger	$logger
RootAclResource	$rootAclResource

Definition at line 75 of file AuthorizationService.php.

      {
        $this->_aclBuilder = $aclBuilder;
        $this->_roleFactory = $roleFactory;
        $this->_rulesFactory = $rulesFactory;
        $this->_rulesCollectionFactory = $rulesCollectionFactory;
        $this->_roleCollectionFactory = $roleCollectionFactory;
        $this->_logger = $logger;
        $this->_rootAclResource = $rootAclResource;
    }

Member Function Documentation

_createRole()

_createRole (   $integrationId )

protected

Create new ACL role.

Parameters

int

$integrationId

Returns

\Magento\Authorization\Model\Role

Definition at line 144 of file AuthorizationService.php.

    {
        $roleName = UserContextInterface::USER_TYPE_INTEGRATION . $integrationId;
        $role = $this->_roleFactory->create();
        $role->setRoleName($roleName)
            ->setUserType(UserContextInterface::USER_TYPE_INTEGRATION)
            ->setUserId($integrationId)
            ->setRoleType(\Magento\Authorization\Model\Acl\Role\User::ROLE_TYPE)
            ->setParentId(0)
            ->save();
        return $role;
    }

_deleteRole()

_deleteRole (   $integrationId )

protected

Remove integration role. This deletes the cascading permissions

Parameters

int

$integrationId

Returns

\Magento\Authorization\Model\Role

Definition at line 163 of file AuthorizationService.php.

    {
        $roleName = UserContextInterface::USER_TYPE_INTEGRATION . $integrationId;
        $role = $this->_roleFactory->create()->load($roleName, 'role_name');
        return $role->delete();
    }

grantAllPermissions()

grantAllPermissions

(

$integrationId

)

{Grant permissions to the user to access all resources available in the system.

Parameters

int

$integrationId

Returns

void

Exceptions

LocalizedException

}

Implements AuthorizationServiceInterface.

Definition at line 115 of file AuthorizationService.php.

    {
        $this->grantPermissions($integrationId, [$this->_rootAclResource->getId()]);
    }

grantPermissions()

grantPermissions	(		$integrationId,
			$resources
	)

{#- Grant permissions to user to access the specified resources.

Parameters

int	$integrationId
	string[]	$resources List of resources which should be available to the specified user.

Returns

void

Exceptions

LocalizedException

}

Implements AuthorizationServiceInterface.

Definition at line 96 of file AuthorizationService.php.

    {
        try {
            $role = $this->_getUserRole($integrationId);
            if (!$role) {
                $role = $this->_createRole($integrationId);
            }
            $this->_associateResourcesWithRole($role, $resources);
        } catch (\Exception $e) {
            $this->_logger->critical($e);
            throw new LocalizedException(
                __('An error occurred during the attempt to grant permissions. For details, see the exceptions log.')
            );
        }
    }

removePermissions()

removePermissions

(

$integrationId

)

{Remove role and associated permissions for the specified integration.

Parameters

int

$integrationId

Returns

void

Exceptions

LocalizedException

}

Implements AuthorizationServiceInterface.

Definition at line 123 of file AuthorizationService.php.

    {
        try {
            $this->_deleteRole($integrationId);
        } catch (\Exception $e) {
            $this->_logger->critical($e);
            throw new LocalizedException(
                __(
                    'Something went wrong while deleting roles and permissions.'
                    . ' You can find out more in the exceptions log.'
                )
            );
        }
    }

Field Documentation

$_aclBuilder

$_aclBuilder

protected

Definition at line 32 of file AuthorizationService.php.

$_logger

$_logger

protected

Definition at line 57 of file AuthorizationService.php.

$_roleCollectionFactory

$_roleCollectionFactory

protected

Definition at line 42 of file AuthorizationService.php.

$_roleFactory

$_roleFactory

protected

Definition at line 37 of file AuthorizationService.php.

$_rootAclResource

$_rootAclResource

protected

Definition at line 62 of file AuthorizationService.php.

$_rulesCollectionFactory

$_rulesCollectionFactory

protected

Definition at line 52 of file AuthorizationService.php.

$_rulesFactory

$_rulesFactory

protected

Definition at line 47 of file AuthorizationService.php.

---

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

• vendor/magento/module-integration/Model/AuthorizationService.php