Skip to content

Phalcon acl

NOTE

All classes are prefixed with Phalcon

Acl\Adapter\AbstractAdapter

Abstract Source on GitHub

Functionality common to all adapters

Uses Phalcon\Acl\Enum · Phalcon\Events\EventsAwareInterface · Phalcon\Events\Traits\EventsAwareTrait

Method Summary

public string|null getActiveAccess() Returns the access which the list is checking if a role can access it public string|null getActiveComponent() Returns the component which the list is checking if some role can access public string|null getActiveRole() Returns the role which the list is checking if it's allowed to certain public int getDefaultAction() Returns the default action public void setDefaultAction( int $defaultAccess ) Sets the default access level

Properties

protected int $accessGranted = Enum::DENY Access Granted
protected string|null $activeAccess = null Active access which the list is checking if some role can access it
protected string|null $activeComponent = null Component which the list is checking if some role can access it
protected string|null $activeRole = null Role which the list is checking if it's allowed to certain component/access
protected int $defaultAccess = Enum::DENY Default access

Methods

Public · 5

getActiveAccess()

public function getActiveAccess(): string|null;

Returns the access which the list is checking if a role can access it

getActiveComponent()

public function getActiveComponent(): string|null;

Returns the component which the list is checking if some role can access it

getActiveRole()

public function getActiveRole(): string|null;

Returns the role which the list is checking if it's allowed to certain component/access

getDefaultAction()

public function getDefaultAction(): int;

Returns the default action

setDefaultAction()

public function setDefaultAction( int $defaultAccess ): void;

Sets the default access level (Phalcon\Acl\Enum::ALLOW or Phalcon\Acl\Enum::DENY)

Acl\Adapter\AdapterInterface

Interface Source on GitHub

Interface for Phalcon\Acl adapters

Uses Phalcon\Contracts\Acl\Adapter\Adapter

Acl\Adapter\Memory

Class Source on GitHub

Manages ACL lists in memory

$acl = new \Phalcon\Acl\Adapter\Memory();

$acl->setDefaultAction(
    \Phalcon\Acl\Enum::DENY
);

// Register roles
$roles = [
    "users"  => new \Phalcon\Acl\Role("Users"),
    "guests" => new \Phalcon\Acl\Role("Guests"),
];
foreach ($roles as $role) {
    $acl->addRole($role);
}

// Private area components
$privateComponents = [
    "companies" => ["index", "search", "new", "edit", "save", "create", "delete"],
    "products"  => ["index", "search", "new", "edit", "save", "create", "delete"],
    "invoices"  => ["index", "profile"],
];

foreach ($privateComponents as $componentName => $actions) {
    $acl->addComponent(
        new \Phalcon\Acl\Component($componentName),
        $actions
    );
}

// Public area components
$publicComponents = [
    "index"   => ["index"],
    "about"   => ["index"],
    "session" => ["index", "register", "start", "end"],
    "contact" => ["index", "send"],
];

foreach ($publicComponents as $componentName => $actions) {
    $acl->addComponent(
        new \Phalcon\Acl\Component($componentName),
        $actions
    );
}

// Grant access to public areas to both users and guests
foreach ($roles as $role) {
    foreach ($publicComponents as $component => $actions) {
        $acl->allow($role->getName(), $component, "*");
    }
}

// Grant access to private area to role Users
foreach ($privateComponents as $component => $actions) {
    foreach ($actions as $action) {
        $acl->allow("Users", $component, $action);
    }
}

Uses Phalcon\Acl\Component · Phalcon\Acl\ComponentAwareInterface · Phalcon\Acl\ComponentInterface · Phalcon\Acl\Enum · Phalcon\Acl\Exceptions\AccessRuleNotFound · Phalcon\Acl\Exceptions\CircularInheritanceError · Phalcon\Acl\Exceptions\ElementNotFound · Phalcon\Acl\Exceptions\InvalidAccessList · Phalcon\Acl\Exceptions\InvalidComponentImplementation · Phalcon\Acl\Exceptions\InvalidRoleImplementation · Phalcon\Acl\Exceptions\InvalidRoleType · Phalcon\Acl\Exceptions\MissingFunctionParameters · Phalcon\Acl\Exceptions\ParameterTypeMismatch · Phalcon\Acl\Exceptions\RoleNotFoundException · Phalcon\Acl\Role · Phalcon\Acl\RoleAwareInterface · Phalcon\Acl\RoleInterface · Phalcon\Contracts\Acl\Adapter\Adapter · Phalcon\Events\Exception · ReflectionClass · ReflectionException · ReflectionFunction · ReflectionNamedType

Method Summary

public __construct() Memory constructor. public bool addComponent(ComponentInterface|string $componentObject,array|string $accessList) Adds a component to the ACL list public bool addComponentAccess(string $componentName,mixed $accessList) Adds access to components public bool addInherit(string $roleName,array|RoleInterface|string $roleToInherit) Add a role which inherits from an existing role public bool addRole(mixed $roleObject,array|RoleInterface|string|null $accessInherits = null) Adds a role to the ACL list. The second parameter lets to inherit access public void allow(string $roleName,string $componentName,array|string $access,callable|null $function = null) Allow access to a role on a component. You can use * as wildcard public void deny(string $roleName,string $componentName,array|string $access,callable|null $function = null) Deny access to a role on a component. You can use * as wildcard public void dropComponentAccess(string $componentName,array|string $accessList) Removes access from a component public mixed getActiveFunction() Returns the latest function used to acquire access public int getActiveFunctionCustomArgumentsCount() Returns number of additional arguments(excluding role and resource) for active function public string|null getActiveKey() Returns the last composite key used to acquire access. public array|null getComponents() Return an array with every component registered in the list public array|null getInheritedRoles( string $roleName = "" ) Returns the inherited roles for a passed role name. If no role name public int getNoArgumentsDefaultAction() Returns the default ACL access level for no arguments provided in public array|null getRoles() Return an array with every role registered in the list public bool isAllowed(mixed $roleName,mixed $componentName,string $access,array|null $parameters = null) Check whether a role is allowed to access an action from a component public bool isComponent( string $componentName ) Check whether component exist in the components list public bool isRole( string $roleName ) Check whether role exist in the roles list public void setNoArgumentsDefaultAction( int $defaultAccess ) Sets the default access level (Phalcon\Enum::ALLOW or

Properties

protected array<string, int> $access = [] Access
protected array<string, bool> $accessList = [] Access List
protected mixed $activeFunction Returns the latest function used to acquire access
protected int $activeFunctionCustomArgumentsCount = 0 Returns number of additional arguments(excluding role and resource) for active function
protected mixed $activeKey = null Returns the latest key used to acquire access
protected array $components = [] Components
protected array $componentsNames = [] Component Names
protected array $functions = [] Function List
protected int $noArgumentsDefaultAction = Enum::DENY Default action for no arguments is allow
protected array<string, array<int, string>> $roleInherits = [] Role Inherits
protected array<string, RoleInterface> $roles = [] Roles

Methods

Public · 19

__construct()

public function __construct();

Memory constructor.

addComponent()

public function addComponent(
    ComponentInterface|string $componentObject,
    array|string $accessList
): bool;

Adds a component to the ACL list

Access names can be a particular action, for instance search, update delete etc. or a list of them.

Example: 

// Add a component to the list allowing access to an action
$acl->addComponent(
    new Phalcon\Acl\Component("customers"),
    "search"
);

$acl->addComponent("customers", "search");

// Add a component  with an access list
$acl->addComponent(
    new Phalcon\Acl\Component("customers"),
    [
        "create",
        "search",
    ]
);

$acl->addComponent(
    "customers",
    [
        "create",
        "search",
    ]
);

addComponentAccess()

public function addComponentAccess(
    string $componentName,
    mixed $accessList
): bool;

Adds access to components

addInherit()

public function addInherit(
    string $roleName,
    array|RoleInterface|string $roleToInherit
): bool;

Add a role which inherits from an existing role

$acl->addRole("administrator", "consultant");
$acl->addRole("administrator", ["consultant", "consultant2"]);

addRole()

public function addRole(
    mixed $roleObject,
    array|RoleInterface|string|null $accessInherits = null
): bool;

Adds a role to the ACL list. The second parameter lets to inherit access from an existing role

$acl->addRole(
    new Phalcon\Acl\Role("administrator"),
    "consultant"
);

$acl->addRole("administrator", "consultant");
$acl->addRole("administrator", ["consultant", "consultant2"]);

allow()

public function allow(
    string $roleName,
    string $componentName,
    array|string $access,
    callable|null $function = null
): void;

Allow access to a role on a component. You can use * as wildcard

A * role is an eager snapshot: it expands to the roles that exist when allow() is called, so roles added afterwards do not inherit the grant.

// Allow access to guests to search on customers
$acl->allow("guests", "customers", "search");

// Allow access to guests to search or create on customers
$acl->allow("guests", "customers", ["search", "create"]);

// Allow access to any role to browse on products
$acl->allow("*", "products", "browse");

// Allow access to any role to perform any action on any component
$acl->allow("*", "*", "*");

deny()

public function deny(
    string $roleName,
    string $componentName,
    array|string $access,
    callable|null $function = null
): void;

Deny access to a role on a component. You can use * as wildcard

A * role is an eager snapshot: it expands to the roles that exist when deny() is called, so roles added afterwards do not inherit the rule.

// Deny access to guests to search on customers
$acl->deny("guests", "customers", "search");

// Deny access to guests to search or create on customers
$acl->deny("guests", "customers", ["search", "create"]);

// Deny access to any role to browse on products
$acl->deny("*", "products", "browse");

// Deny access to any role to perform any action on any component
$acl->deny("*", "*", "*");

dropComponentAccess()

public function dropComponentAccess(
    string $componentName,
    array|string $accessList
): void;

Removes access from a component

getActiveFunction()

public function getActiveFunction(): mixed;

Returns the latest function used to acquire access

getActiveFunctionCustomArgumentsCount()

public function getActiveFunctionCustomArgumentsCount(): int;

Returns number of additional arguments(excluding role and resource) for active function

getActiveKey()

public function getActiveKey(): string|null;

Returns the last composite key used to acquire access.

getComponents()

public function getComponents(): array|null;

Return an array with every component registered in the list

getInheritedRoles()

public function getInheritedRoles( string $roleName = "" ): array|null;

Returns the inherited roles for a passed role name. If no role name has been specified it will return the whole array. If the role has not been found it returns an empty array

getNoArgumentsDefaultAction()

public function getNoArgumentsDefaultAction(): int;

Returns the default ACL access level for no arguments provided in isAllowed action if a function (callable) exists for accessKey

getRoles()

public function getRoles(): array|null;

Return an array with every role registered in the list

isAllowed()

public function isAllowed(
    mixed $roleName,
    mixed $componentName,
    string $access,
    array|null $parameters = null
): bool;

Check whether a role is allowed to access an action from a component

// Does andres have access to the customers component to create?
$acl->isAllowed("andres", "Products", "create");

// Do guests have access to any component to edit?
$acl->isAllowed("guests", "*", "edit");

isComponent()

public function isComponent( string $componentName ): bool;

Check whether component exist in the components list

isRole()

public function isRole( string $roleName ): bool;

Check whether role exist in the roles list

setNoArgumentsDefaultAction()

public function setNoArgumentsDefaultAction( int $defaultAccess ): void;

Sets the default access level (Phalcon\Enum::ALLOW or Phalcon\Enum::DENY) for no arguments provided in isAllowed action if there exists func for accessKey

Acl\Adapter\Storage

Class Source on GitHub

ACL adapter that persists its policy to any Phalcon\Storage backend (Redis, Apcu, Stream, Memcached, ...) as a whole-policy snapshot.

The snapshot is a versioned, scalar-only structure: roles and components are stored as name => description maps and rebuilt into objects on load, so the snapshot round-trips through any serializer (php, json, igbinary, msgpack).

Callable (closure) rules are not serializable. Any access key backed by a closure is persisted as DENY, so a reloaded policy fails closed until the closure is re-registered after load().

Single-writer contract: mutations are in-memory until save() is called, and save() writes the whole snapshot (last-write-wins, no atomic check-and-set). Use external locking when multiple processes write the same key.

@see Persistable

Uses Phalcon\Acl\Component · Phalcon\Acl\Enum · Phalcon\Acl\Exceptions\InvalidSnapshot · Phalcon\Acl\Role · Phalcon\Contracts\Acl\Adapter\Persistable · Phalcon\Storage\Adapter\AdapterInterface

Method Summary

public __construct(StorageInterface $storage,string $key = "acl-data") public bool load() Loads the policy snapshot from the backing store, replacing current public bool save() Persists the policy snapshot. Closure-backed access keys are written as

Constants

int SNAPSHOT_VERSION = 1

Properties

protected string $key = "acl-data"
protected StorageInterface $storage

Methods

Public · 3

__construct()

public function __construct(
    StorageInterface $storage,
    string $key = "acl-data"
);

load()

public function load(): bool;

Loads the policy snapshot from the backing store, replacing current in-memory state. Returns false when no compatible snapshot exists; throws Phalcon\Acl\Exceptions\InvalidSnapshot on an incompatible version or a malformed structure.

save()

public function save(): bool;

Persists the policy snapshot. Closure-backed access keys are written as DENY (fail closed); roles/components are written as scalar name => description maps for serializer independence.

Acl\Component

Class Source on GitHub

This class defines component entity and its description

Uses Phalcon\Acl\Exceptions\ForbiddenWildcard · Phalcon\Acl\Traits\ItemTrait

Method Summary

public __construct(string $name,string|null $description = null) Component constructor.

Methods

Public · 1

__construct()

public function __construct(
    string $name,
    string|null $description = null
);

Component constructor.

Acl\ComponentAwareInterface

Interface Source on GitHub

Interface for ACL Component aware objects

Uses Phalcon\Contracts\Acl\ComponentAware

Acl\ComponentInterface

Interface Source on GitHub

Interface for Phalcon\Acl\Component

Uses Phalcon\Contracts\Acl\Component

Acl\Enum

Class Source on GitHub

Constants for Phalcon\Acl\Adapter adapters

  • Phalcon\Acl\Enum

Constants

int ALLOW = 1
int DENY = 0

Acl\Exception

Class Source on GitHub

Class for exceptions thrown by Phalcon\Acl

Acl\Exceptions\AccessRuleNotFound

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct(string $accessName,string $componentName)

Methods

Public · 1

__construct()

public function __construct(
    string $accessName,
    string $componentName
);

Acl\Exceptions\CircularInheritanceError

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct( string $roleName )

Methods

Public · 1

__construct()

public function __construct( string $roleName );

Acl\Exceptions\ElementNotFound

Class Source on GitHub

Uses Phalcon\Acl\Exception

Acl\Exceptions\ForbiddenWildcard

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct( string $elementType )

Methods

Public · 1

__construct()

public function __construct( string $elementType );

Acl\Exceptions\InvalidAccessList

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Acl\Exceptions\InvalidComponentImplementation

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Acl\Exceptions\InvalidRoleImplementation

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Acl\Exceptions\InvalidRoleType

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Acl\Exceptions\InvalidSnapshot

Class Source on GitHub

Uses Phalcon\Acl\Exception

Acl\Exceptions\MissingFunctionParameters

Class Source on GitHub

Uses Phalcon\Acl\Exception

Acl\Exceptions\ParameterTypeMismatch

Class Source on GitHub

Uses Phalcon\Acl\Exception

Acl\Exceptions\RoleNotFoundException

Class Source on GitHub

Uses Phalcon\Acl\Exception

Method Summary

public __construct( string $roleName )

Methods

Public · 1

__construct()

public function __construct( string $roleName );

Acl\Role

Class Source on GitHub

This class defines role entity and its description

Uses Phalcon\Acl\Exceptions\ForbiddenWildcard · Phalcon\Acl\Traits\ItemTrait

Method Summary

public __construct(string $name,string|null $description = null) Role constructor.

Methods

Public · 1

__construct()

public function __construct(
    string $name,
    string|null $description = null
);

Role constructor.

Acl\RoleAwareInterface

Interface Source on GitHub

Interface for ACL Role aware objects

Uses Phalcon\Contracts\Acl\RoleAware

Acl\RoleInterface

Interface Source on GitHub

Interface for Phalcon\Acl\Role

Uses Phalcon\Contracts\Acl\Role

Acl\Traits\ItemTrait

Trait Source on GitHub

This class defines role/component names and their descriptions

  • Phalcon\Acl\Traits\ItemTrait

Used by Phalcon\Acl\Component · Phalcon\Acl\Role

Method Summary

public string __toString() public string|null getDescription() public string getName()

Properties

protected string|null $description = null Role/Component description
protected string $name Role/Component name

Methods

Public · 3

__toString()

public function __toString(): string;

getDescription()

public function getDescription(): string|null;

getName()

public function getName(): string;