Overview

Namespaces

  • Charcoal
    • Object
    • User
      • Acl

Classes

  • AbstractUser
  • Authenticator
  • Authorizer
  • AuthToken
  • AuthTokenMetadata
  • GenericUser

Interfaces

  • UserInterface
  • Overview
  • Namespace
  • Class

Class Authorizer

The authorizer service helps with user authorization (permission checking).

Constructor dependencies

Constructor dependencies are passed as an array of key=>value pair. The required dependencies are:

  • logger A PSR3 logger instance.
  • acl A Zend ACL (Access-Control-List) instance.
  • resource The ACL resource identifier (string).

Checking permissions

To check if a given ACL (passed in constructor) allows a list of permissions (aka privileges):

  • userAllowed(UserInterface $user, string[] $aclPermissions)
  • rolesAllowed(string[] $roles, string[] $aclPermissions)
Charcoal\User\Authorizer implements Psr\Log\LoggerAwareInterface uses Psr\Log\LoggerAwareTrait (not available)
Namespace: Charcoal\User
Located at Charcoal/User/Authorizer.php
Methods summary
public
# __construct( array $data )

Parameters

$data
Class dependencies.
protected Zend\Permissions\Acl\Acl
# acl( )

Returns

Zend\Permissions\Acl\Acl
protected string
# resource( )

Returns

string
public boolean
# rolesAllowed( array $aclRoles, array $aclPermissions )

Parameters

$aclRoles
The ACL roles to validate against.
$aclPermissions
The acl permissions to validate.

Returns

boolean
Wether the permissions are allowed for a given list of roles.
public boolean
# userAllowed( Charcoal\User\UserInterface $user, array $aclPermissions )

Parameters

$user
The user to validate against.
$aclPermissions
The acl permissions to validate.

Returns

boolean
Whether the permissions are allowed for a given user.
API documentation generated by ApiGen