---
title: "Phalcon Auth"
version: "5.17"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Auth
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Auth\AbstractAuthDispatcherListener
Abstract
Source on GitHub
Shared enforcement algorithm for the Cli, Mvc and Micro auth listeners.
The subclass provides the action name and context from its event source,
the action-kind label used in the access-denied exception, and (Mvc only)
a forward handler for Access::redirectTo().
Enforcement is fail-open: when the manager has no active access
(Manager::getAccess() === null) every dispatch is allowed. A policy
activated via Manager::access() persists across forwards and nested
dispatches in the same request until it is replaced.
- **`Phalcon\Auth\AbstractAuthDispatcherListener`**
- [`Phalcon\Auth\Cli\AuthDispatcherListener`](#authcliauthdispatcherlistener)
- [`Phalcon\Auth\Micro\AuthMicroListener`](#authmicroauthmicrolistener)
- [`Phalcon\Auth\Mvc\AuthDispatcherListener`](#authmvcauthdispatcherlistener)
__Uses__ `Phalcon\Auth\Exceptions\AccessDenied` · `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\Manager`
### Method Summary
### Properties
protected
Manager
$manager
### Methods
Public · 1
__construct()
```php
public function __construct( Manager $manager );
```
Protected · 2
enforce()
```php
protected function enforce(
string $actionName,
array $context = [],
mixed $forwardHandler = null
): bool;
```
Runs the access check for the given action name. Returns true when
the dispatch should proceed, false when a forward was issued, and
throws when access is denied without a redirect target.
The guard is fetched only when an access is active, so the no-op
path works without a default guard.
getActionType()
```php
abstract protected function getActionType(): string;
```
Returns the kind label used by AccessDenied (e.g. 'task', 'action',
'route').
## Auth\Access\AbstractAccess
Abstract
Source on GitHub
- **`Phalcon\Auth\Access\AbstractAccess`** - implements [`Phalcon\Contracts\Auth\Access\Access`](/5.17/api/phalcon_contracts/#contractsauthaccessaccess)
- [`Phalcon\Auth\Access\Acl`](#authaccessacl)
- [`Phalcon\Auth\Access\Auth`](#authaccessauth)
- [`Phalcon\Auth\Access\Guest`](#authaccessguest)
__Uses__ `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\Guard\Guard`
### Method Summary
### Properties
protected
array
$exceptActions = []
protected
array
$onlyActions = []
### Methods
Public · 6
getExceptActions()
```php
public function getExceptActions(): array;
```
getOnlyActions()
```php
public function getOnlyActions(): array;
```
isAllowed()
```php
public function isAllowed(
Guard $guard,
string $actionName,
array $context = []
): bool;
```
redirectTo()
```php
public function redirectTo(): array|null;
```
setExceptActions()
```php
public function setExceptActions( array $exceptActions = [] ): void;
```
setOnlyActions()
```php
public function setOnlyActions( array $onlyActions = [] ): void;
```
Protected · 1
allowedIf()
```php
abstract protected function allowedIf( Guard $guard ): bool;
```
Whether the gate's base condition holds for the given identity.
## Auth\Access\AccessLocator
Class
Source on GitHub
Service locator for Phalcon\Auth access gates. Utilizes the container to
obtain the service. For the Phalcon\Container\Container one can use
autowiring. For the Phalcon\Di\Di, one needs to register the gates in it
to be used here (the binary gates also resolve unregistered through Di's
class builder).
@extends AbstractLocator<Access>
- [`Phalcon\Support\AbstractLocator`](/5.17/api/phalcon_support/#supportabstractlocator)
- **`Phalcon\Auth\Access\AccessLocator`**
__Uses__ `Phalcon\Auth\Internal\ContainerResolver` · `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Support\AbstractLocator`
### Method Summary
### Methods
Public · 1
newInstance()
```php
public function newInstance( string $name ): object;
```
Resolve a fresh gate instance from the container.
Gates carry per-activation state (the only/except action filters), so
resolution must yield a fresh instance: new() on the Container
bypasses the instance cache; on the legacy Di, get() builds
unregistered classes and non-shared services fresh (register gates
non-shared).
Protected · 3
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getInterfaceClass()
```php
protected function getInterfaceClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
## Auth\Access\Acl
Class
Source on GitHub
ACL-backed access gate. Checks the authenticated user's role against a
Phalcon\Acl adapter: the ACL component is taken from the 'handler' context
key (prefixed with 'module' and the module separator when present) and the
ACL access is the action name. The 'params' context key is passed through
to the ACL adapter for callable rules.
Filter semantics differ from the binary gates: except = bypass the gate
for the listed actions; only = the gate applies to the listed actions
exclusively (everything else is allowed).
Role resolution: no user resolves to the configured guest role; a user
implementing Phalcon\Acl\RoleAwareInterface supplies its role name; any
other user is rejected with an exception.
- [`Phalcon\Auth\Access\AbstractAccess`](#authaccessabstractaccess)
- **`Phalcon\Auth\Access\Acl`**
__Uses__ `Phalcon\Acl\Adapter\AdapterInterface` · `Phalcon\Acl\RoleAwareInterface` · `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Auth\Exceptions\MissingHandlerContext` · `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Auth\Guard\Guard`
### Method Summary
### Properties
protected
AdapterInterface
$acl
protected
string
$guestRole = "guest"
protected
string
$moduleSeparator = ":"
### Methods
Public · 2
__construct()
```php
public function __construct(
AdapterInterface $acl,
array $options = []
);
```
isAllowed()
```php
public function isAllowed(
Guard $guard,
string $actionName,
array $context = []
): bool;
```
Protected · 2
allowedIf()
```php
protected function allowedIf( Guard $guard ): bool;
```
Unused: this gate overrides isAllowed() in full. Fail closed to
satisfy the abstract.
resolveRole()
```php
protected function resolveRole( Guard $guard ): string;
```
## Auth\Access\Auth
Class
Source on GitHub
- [`Phalcon\Auth\Access\AbstractAccess`](#authaccessabstractaccess)
- **`Phalcon\Auth\Access\Auth`**
__Uses__ `Phalcon\Contracts\Auth\Guard\Guard`
### Method Summary
### Methods
Protected · 1
allowedIf()
```php
protected function allowedIf( Guard $guard ): bool;
```
## Auth\Access\Guest
Class
Source on GitHub
- [`Phalcon\Auth\Access\AbstractAccess`](#authaccessabstractaccess)
- **`Phalcon\Auth\Access\Guest`**
__Uses__ `Phalcon\Contracts\Auth\Guard\Guard`
### Method Summary
### Methods
Protected · 1
allowedIf()
```php
protected function allowedIf( Guard $guard ): bool;
```
## Auth\Adapter\AbstractAdapter
Abstract
Source on GitHub
@template TConfig of AdapterConfig
- **`Phalcon\Auth\Adapter\AbstractAdapter`** - implements [`Phalcon\Contracts\Auth\Adapter\Adapter`](/5.17/api/phalcon_contracts/#contractsauthadapteradapter)
- [`Phalcon\Auth\Adapter\AbstractArrayAdapter`](#authadapterabstractarrayadapter)
- [`Phalcon\Auth\Adapter\Model`](#authadaptermodel)
__Uses__ `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\Adapter\AdapterConfig` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Encryption\Security\Security`
### Method Summary
### Constants
string
DUMMY_HASH = "$2y$10$YMmGMSXz.5U3bjjJ2qx45uElzUrlaBiS8L70VaVnmsKYFJVcam8gW"
Dummy bcrypt hash used to equalize timing on the user-not-found path so a failed lookup costs the same as a real password check (prevents login-timing user enumeration).
### Properties
protected
AdapterConfig
$config
protected
Security
$hasher
### Methods
Public · 4
__construct()
```php
public function __construct(
Security $hasher,
AdapterConfig $config
);
```
getConfig()
```php
public function getConfig(): AdapterConfig;
```
Returns the adapter configuration object.
getModel()
```php
public function getModel(): string|null;
```
Returns the model class name, if configured.
validateCredentials()
```php
public function validateCredentials(
AuthUser $user,
array $credentials
): bool;
```
Validates the supplied plaintext password against the user's stored hash.
Concrete adapters share this implementation; if your data source needs
a different verification strategy, override it.
Protected · 1
burnHash()
```php
protected function burnHash(): void;
```
Runs a throwaway password verification against a fixed dummy hash so the
user-not-found path performs the same hash work as a found path. Call it
when a credential lookup misses to keep response time constant.
## Auth\Adapter\AbstractArrayAdapter
Abstract
Source on GitHub
Common base for adapters whose user records come from an in-memory list
(Memory and Stream). Subclasses provide the row source via loadUsers();
everything else - credentials matching, hydration, the empty-credentials
guard, and a default linear retrieveById - is shared here.
@template TConfig of AdapterConfig
@extends AbstractAdapter<TConfig>
- [`Phalcon\Auth\Adapter\AbstractAdapter`](#authadapterabstractadapter)
- **`Phalcon\Auth\Adapter\AbstractArrayAdapter`**
- [`Phalcon\Auth\Adapter\Memory`](#authadaptermemory)
- [`Phalcon\Auth\Adapter\Stream`](#authadapterstream)
__Uses__ `Phalcon\Auth\AuthUser` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Contracts\Auth\Adapter\AdapterConfig` · `Phalcon\Contracts\Auth\AuthUser`
### Method Summary
### Methods
Public · 2
retrieveByCredentials()
```php
public function retrieveByCredentials( array $credentials ): AuthUserContract|null;
```
Walks the user list and returns the first row whose non-'password'
keys all match strictly. Returns null when no row matches or when
$credentials carries no identifying field at all (only 'password',
or empty) - protects callers from the silent "first row wins" footgun.
retrieveById()
```php
public function retrieveById( mixed $id ): AuthUserContract|null;
```
Default linear-scan implementation. Memory overrides this for an O(1)
id-keyed lookup; Stream uses this as-is.
Protected · 4
hasIdentifyingField()
```php
protected function hasIdentifyingField( array $credentials ): bool;
```
Tests whether a credentials payload carries at least one identifying
field (i.e. anything other than 'password'). An empty payload - or a
payload that only contains 'password' - is treated as "no lookup".
hydrate()
```php
protected function hydrate( array $row ): AuthUserContract;
```
Hydrates a raw user row into either the configured model class or a
Phalcon\Auth\AuthUser value object.
loadUsers()
```php
abstract protected function loadUsers(): array;
```
Returns the source list of user rows. Concrete subclasses decide
where they come from (config array, JSON file, etc.).
matchesRow()
```php
protected function matchesRow(
array $row,
array $credentials
): bool;
```
Strict per-key match of a row against credentials, skipping 'password'.
## Auth\Adapter\AdapterLocator
Class
Source on GitHub
Service locator for Phalcon\Auth adapters. Utilizes the container to
obtain the service. For the Phalcon\Container\Container one can use
autowiring. For the Phalcon\Di\Di, one needs to register the gates in it
to be used here.
@extends AbstractLocator<Adapter>
- [`Phalcon\Support\AbstractLocator`](/5.17/api/phalcon_support/#supportabstractlocator)
- **`Phalcon\Auth\Adapter\AdapterLocator`**
__Uses__ `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Support\AbstractLocator`
### Method Summary
### Methods
Protected · 3
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getInterfaceClass()
```php
protected function getInterfaceClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
## Auth\Adapter\Config\AbstractAdapterConfig
Abstract
Source on GitHub
@todo Remove in v7. Kept only for backwards compatibility; compose
Phalcon\Auth\Adapter\Config\Traits\ModelConfigTrait directly instead of
extending this.
- **`Phalcon\Auth\Adapter\Config\AbstractAdapterConfig`** - implements [`Phalcon\Contracts\Auth\Adapter\AdapterConfig`](/5.17/api/phalcon_contracts/#contractsauthadapteradapterconfig)
- [`Phalcon\Auth\Adapter\Config\MemoryAdapterConfig`](#authadapterconfigmemoryadapterconfig)
- [`Phalcon\Auth\Adapter\Config\ModelAdapterConfig`](#authadapterconfigmodeladapterconfig)
- [`Phalcon\Auth\Adapter\Config\StreamAdapterConfig`](#authadapterconfigstreamadapterconfig)
__Uses__ `Phalcon\Auth\Adapter\Config\Traits\ModelConfigTrait` · `Phalcon\Contracts\Auth\Adapter\AdapterConfig`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $model = null );
```
## Auth\Adapter\Config\MemoryAdapterConfig
Class
Source on GitHub
- [`Phalcon\Auth\Adapter\Config\AbstractAdapterConfig`](#authadapterconfigabstractadapterconfig)
- **`Phalcon\Auth\Adapter\Config\MemoryAdapterConfig`**
### Method Summary
### Properties
protected
array
$users = []
### Methods
Public · 2
__construct()
```php
public function __construct(
array $users = [],
string $model = null
);
```
getUsers()
```php
public function getUsers(): array;
```
## Auth\Adapter\Config\ModelAdapterConfig
Class
Source on GitHub
- [`Phalcon\Auth\Adapter\Config\AbstractAdapterConfig`](#authadapterconfigabstractadapterconfig)
- **`Phalcon\Auth\Adapter\Config\ModelAdapterConfig`**
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue`
### Method Summary
### Properties
protected
string
$idColumn = "id"
### Methods
Public · 3
__construct()
```php
public function __construct(
string $model,
string $idColumn = "id"
);
```
getIdColumn()
```php
public function getIdColumn(): string;
```
getModel()
```php
public function getModel(): string;
```
## Auth\Adapter\Config\StreamAdapterConfig
Class
Source on GitHub
- [`Phalcon\Auth\Adapter\Config\AbstractAdapterConfig`](#authadapterconfigabstractadapterconfig)
- **`Phalcon\Auth\Adapter\Config\StreamAdapterConfig`**
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue`
### Method Summary
### Properties
### Methods
Public · 2
__construct()
```php
public function __construct(
string $file,
string $model = null
);
```
getFile()
```php
public function getFile(): string;
```
## Auth\Adapter\Memory
Class
Source on GitHub
In-memory adapter - useful for tests and small read-only user lists.
@extends AbstractArrayAdapter<MemoryAdapterConfig>
- [`Phalcon\Auth\Adapter\AbstractAdapter`](#authadapterabstractadapter)
- [`Phalcon\Auth\Adapter\AbstractArrayAdapter`](#authadapterabstractarrayadapter)
- **`Phalcon\Auth\Adapter\Memory`**
__Uses__ `Phalcon\Auth\Adapter\Config\MemoryAdapterConfig` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Encryption\Security\Security`
### Method Summary
### Methods
Public · 3
__construct()
```php
public function __construct(
Security $hasher,
MemoryAdapterConfig $config
);
```
fromOptions()
```php
public static function fromOptions(
Security $hasher,
array $options
): static;
```
retrieveById()
```php
public function retrieveById( mixed $id ): AuthUser|null;
```
Overridden for O(1) lookup via the id index built in the constructor.
Protected · 1
loadUsers()
```php
protected function loadUsers(): array;
```
## Auth\Adapter\Model
Class
Source on GitHub
Phalcon Model-backed adapter.
@extends AbstractAdapter<ModelAdapterConfig>
- [`Phalcon\Auth\Adapter\AbstractAdapter`](#authadapterabstractadapter)
- **`Phalcon\Auth\Adapter\Model`** - implements [`Phalcon\Contracts\Auth\Adapter\RememberAdapter`](/5.17/api/phalcon_contracts/#contractsauthadapterrememberadapter)
__Uses__ `Phalcon\Auth\Adapter\Config\ModelAdapterConfig` · `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Auth\Adapter\RememberAdapter` · `Phalcon\Contracts\Auth\AuthRemember` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Auth\RememberToken` · `Phalcon\Contracts\Encryption\Security\Security` · `Phalcon\Mvc\ModelInterface`
### Method Summary
### Methods
Public · 6
__construct()
```php
public function __construct(
Security $hasher,
ModelAdapterConfig $config
);
```
createRememberToken()
```php
public function createRememberToken( AuthUser $user ): RememberToken;
```
Create and persist a new remember token for the user.
fromOptions()
```php
public static function fromOptions(
Security $hasher,
array $options
): static;
```
retrieveByCredentials()
```php
public function retrieveByCredentials( array $credentials ): AuthUser|null;
```
Find a user matching the given credentials (excluding 'password' key).
retrieveById()
```php
public function retrieveById( mixed $id ): AuthUser|null;
```
retrieveByToken()
```php
public function retrieveByToken(
mixed $id,
string $token,
string $userAgent = null
): AuthUser|null;
```
Retrieve a user by the remember-me cookie payload.
## Auth\Adapter\Stream
Class
Source on GitHub
JSON file-backed adapter.
The file must contain a JSON array of user records:
[\{"id":1,"email":"a@b","password":"<hashed>"\}, ...]
@extends AbstractArrayAdapter<StreamAdapterConfig>
- [`Phalcon\Auth\Adapter\AbstractAdapter`](#authadapterabstractadapter)
- [`Phalcon\Auth\Adapter\AbstractArrayAdapter`](#authadapterabstractarrayadapter)
- **`Phalcon\Auth\Adapter\Stream`**
__Uses__ `InvalidArgumentException` · `Phalcon\Auth\Adapter\Config\StreamAdapterConfig` · `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\FileCannotRead` · `Phalcon\Auth\Exceptions\FileDoesNotContainJson` · `Phalcon\Auth\Exceptions\FileDoesNotExist` · `Phalcon\Auth\Exceptions\FileNotValidJson` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Encryption\Security\Security` · `Phalcon\Support\Helper\Json\Decode` · `Phalcon\Traits\Php\FileTrait`
### Method Summary
### Methods
Public · 2
__construct()
```php
public function __construct(
Security $hasher,
StreamAdapterConfig $config
);
```
fromOptions()
```php
public static function fromOptions(
Security $hasher,
array $options
): static;
```
Protected · 1
loadUsers()
```php
protected function loadUsers(): array;
```
Loads and decodes the JSON users file. Re-read on every call - if you
need caching, wrap it.
## Auth\AuthUser
Class
Source on GitHub
Lightweight value object returned by array-backed adapters (Memory, Stream)
when no application model class is configured.
- **`Phalcon\Auth\AuthUser`** - implements [`Phalcon\Contracts\Auth\AuthUser`](/5.17/api/phalcon_contracts/#contractsauthauthuser)
__Uses__ `Phalcon\Auth\Exceptions\DataMustContainIdKey` · `Phalcon\Contracts\Auth\AuthUser`
### Method Summary
### Properties
### Methods
Public · 4
__construct()
```php
public function __construct( array $data );
```
getAuthIdentifier()
```php
public function getAuthIdentifier(): int|string;
```
getAuthPassword()
```php
public function getAuthPassword(): string;
```
toArray()
```php
public function toArray(): array;
```
Returns the underlying data array.
## Auth\Cli\AuthDispatcherListener
Class
Source on GitHub
- [`Phalcon\Auth\AbstractAuthDispatcherListener`](#authabstractauthdispatcherlistener)
- **`Phalcon\Auth\Cli\AuthDispatcherListener`**
__Uses__ `Phalcon\Auth\AbstractAuthDispatcherListener` · `Phalcon\Auth\Exception` · `Phalcon\Cli\Dispatcher` · `Phalcon\Events\Event`
### Method Summary
### Methods
Public · 1
beforeExecuteRoute()
```php
public function beforeExecuteRoute(
Event $event,
Dispatcher $dispatcher
): bool;
```
Protected · 1
getActionType()
```php
protected function getActionType(): string;
```
## Auth\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Auth will use this class
- `\Exception`
- **`Phalcon\Auth\Exception`**
- [`Phalcon\Auth\Exceptions\AccessDenied`](#authexceptionsaccessdenied)
- [`Phalcon\Auth\Exceptions\AccessNotRegistered`](#authexceptionsaccessnotregistered)
- [`Phalcon\Auth\Exceptions\ActiveAccessRequired`](#authexceptionsactiveaccessrequired)
- [`Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue`](#authexceptionsconfigrequiresnonemptyvalue)
- [`Phalcon\Auth\Exceptions\DataMustContainIdKey`](#authexceptionsdatamustcontainidkey)
- [`Phalcon\Auth\Exceptions\DefaultGuardNotRegistered`](#authexceptionsdefaultguardnotregistered)
- [`Phalcon\Auth\Exceptions\DoesNotImplement`](#authexceptionsdoesnotimplement)
- [`Phalcon\Auth\Exceptions\FileCannotRead`](#authexceptionsfilecannotread)
- [`Phalcon\Auth\Exceptions\FileDoesNotContainJson`](#authexceptionsfiledoesnotcontainjson)
- [`Phalcon\Auth\Exceptions\FileDoesNotExist`](#authexceptionsfiledoesnotexist)
- [`Phalcon\Auth\Exceptions\FileNotValidJson`](#authexceptionsfilenotvalidjson)
- [`Phalcon\Auth\Exceptions\GuardNotDefined`](#authexceptionsguardnotdefined)
- [`Phalcon\Auth\Exceptions\MissingHandlerContext`](#authexceptionsmissinghandlercontext)
- [`Phalcon\Auth\Exceptions\OptionRequiresArray`](#authexceptionsoptionrequiresarray)
- [`Phalcon\Auth\Exceptions\OptionRequiresString`](#authexceptionsoptionrequiresstring)
- [`Phalcon\Auth\Exceptions\SessionNamesMustDiffer`](#authexceptionssessionnamesmustdiffer)
- [`Phalcon\Auth\Exceptions\UnknownAdapter`](#authexceptionsunknownadapter)
- [`Phalcon\Auth\Exceptions\UnknownGuard`](#authexceptionsunknownguard)
## Auth\Exceptions\AccessDenied
Class
Source on GitHub
Access denied exception
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\AccessDenied`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $type,
string $name
);
```
## Auth\Exceptions\AccessNotRegistered
Class
Source on GitHub
Access gate name is not registered
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\AccessNotRegistered`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $name );
```
## Auth\Exceptions\ActiveAccessRequired
Class
Source on GitHub
No active access has been set on the manager
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\ActiveAccessRequired`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Auth\Exceptions\ConfigRequiresNonEmptyValue
Class
Source on GitHub
Config requires non-empty value
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 2
__construct()
```php
public function __construct(
string $configName,
string $configKey,
string $suffix = ""
);
```
assert()
```php
public static function assert(
mixed $value,
string $configName,
string $configKey,
string $suffix = ""
): void;
```
Throws when the value is an empty string. A null value is treated as
"not provided" and passes, so optional settings can reuse the same
guard; callers that require presence reject null earlier. Keeps the
empty-value check shared by every config class in one place.
## Auth\Exceptions\DataMustContainIdKey
Class
Source on GitHub
AuthUser data must contain "id"
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\DataMustContainIdKey`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Auth\Exceptions\DefaultGuardNotRegistered
Class
Source on GitHub
No default guard registered
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\DefaultGuardNotRegistered`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Auth\Exceptions\DoesNotImplement
Class
Source on GitHub
Does not implement interface
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\DoesNotImplement`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 2
__construct()
```php
public function __construct(
string $type,
string $name
);
```
assert()
```php
public static function assert(
mixed $value,
mixed $interfaceName,
string $type,
string $name
): void;
```
Throws when value is not an instance of the given interface. Keeps the
"must implement" guard shared across adapters, guards and the manager
in one place.
## Auth\Exceptions\FileCannotRead
Class
Source on GitHub
Cannot read file
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\FileCannotRead`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Auth\Exceptions\FileDoesNotContainJson
Class
Source on GitHub
File does not contain a JSON array
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\FileDoesNotContainJson`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Auth\Exceptions\FileDoesNotExist
Class
Source on GitHub
File does not exist
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\FileDoesNotExist`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Auth\Exceptions\FileNotValidJson
Class
Source on GitHub
Not a valid JSON
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\FileNotValidJson`**
__Uses__ `Phalcon\Auth\Exception` · `Throwable`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $path,
Throwable $ex
);
```
## Auth\Exceptions\GuardNotDefined
Class
Source on GitHub
Guard name is not defined on the manager
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\GuardNotDefined`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $name );
```
## Auth\Exceptions\MissingHandlerContext
Class
Source on GitHub
The Acl access gate is missing the required 'handler' context key
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\MissingHandlerContext`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Auth\Exceptions\OptionRequiresArray
Class
Source on GitHub
Option must be a non-empty array
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\OptionRequiresArray`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $context,
string $key
);
```
## Auth\Exceptions\OptionRequiresString
Class
Source on GitHub
Option must be a non-empty string
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\OptionRequiresString`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $context,
string $key
);
```
## Auth\Exceptions\SessionNamesMustDiffer
Class
Source on GitHub
Session guard 'name' and 'rememberName' must differ
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\SessionNamesMustDiffer`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Auth\Exceptions\UnknownAdapter
Class
Source on GitHub
Unknown auth adapter requested from the factory
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\UnknownAdapter`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $name );
```
## Auth\Exceptions\UnknownGuard
Class
Source on GitHub
Unknown auth guard type requested from the factory
- `\Exception`
- [`Phalcon\Auth\Exception`](#authexception)
- **`Phalcon\Auth\Exceptions\UnknownGuard`**
__Uses__ `Phalcon\Auth\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $type );
```
## Auth\Guard\AbstractGuard
Abstract
Source on GitHub
@template TConfig of GuardConfig
- [`Phalcon\Events\AbstractEventsAware`](/5.17/api/phalcon_events/#eventsabstracteventsaware)
- **`Phalcon\Auth\Guard\AbstractGuard`** - implements [`Phalcon\Contracts\Auth\Guard\Guard`](/5.17/api/phalcon_contracts/#contractsauthguardguard)
- [`Phalcon\Auth\Guard\Session`](#authguardsession)
- [`Phalcon\Auth\Guard\Token`](#authguardtoken)
__Uses__ `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Auth\Guard\Guard` · `Phalcon\Contracts\Auth\Guard\GuardConfig` · `Phalcon\Events\AbstractEventsAware`
### Method Summary
### Properties
protected
Adapter
$adapter
protected
GuardConfig
$config
protected
AuthUser | null
$lastUserAttempted = null
protected
AuthUser | null
$user = null
### Methods
Public · 10
__construct()
```php
public function __construct(
Adapter $adapter,
GuardConfig $config
);
```
check()
```php
public function check(): bool;
```
getAdapter()
```php
public function getAdapter(): Adapter;
```
getConfig()
```php
public function getConfig(): GuardConfig;
```
Returns the guard configuration object.
getLastUserAttempted()
```php
public function getLastUserAttempted(): AuthUser|null;
```
guest()
```php
public function guest(): bool;
```
hasUser()
```php
public function hasUser(): bool;
```
id()
```php
public function id(): int|string|null;
```
setAdapter()
```php
public function setAdapter( Adapter $adapter ): static;
```
setUser()
```php
public function setUser( AuthUser $user ): static;
```
Protected · 1
hasValidCredentials()
```php
protected function hasValidCredentials(
mixed $user,
array $credentials
): bool;
```
user should be ?AuthUser
## Auth\Guard\Config\AbstractGuardConfig
Abstract
Source on GitHub
- **`Phalcon\Auth\Guard\Config\AbstractGuardConfig`** - implements [`Phalcon\Contracts\Auth\Guard\GuardConfig`](/5.17/api/phalcon_contracts/#contractsauthguardguardconfig)
- [`Phalcon\Auth\Guard\Config\SessionGuardConfig`](#authguardconfigsessionguardconfig)
- [`Phalcon\Auth\Guard\Config\TokenGuardConfig`](#authguardconfigtokenguardconfig)
__Uses__ `Phalcon\Contracts\Auth\Guard\GuardConfig`
## Auth\Guard\Config\SessionGuardConfig
Class
Source on GitHub
Configuration for the Session guard. Holds the names under which the
session key and remember-me cookie are stored. Defaults to 'auth' and
'remember'; multi-guard apps can pass a $suffix ('web', 'admin', ...)
to derive 'auth_web' / 'remember_web' style names, or override either
full name explicitly.
- [`Phalcon\Auth\Guard\Config\AbstractGuardConfig`](#authguardconfigabstractguardconfig)
- **`Phalcon\Auth\Guard\Config\SessionGuardConfig`**
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue` · `Phalcon\Auth\Exceptions\SessionNamesMustDiffer`
### Method Summary
### Constants
int
DEFAULT_REMEMBER_TTL = 31536000
Default remember-me cookie lifetime, in seconds (365 days).
### Methods
Public · 4
__construct()
```php
public function __construct(
string $suffix = null,
string $name = null,
string $rememberName = null,
mixed $rememberTtl = null
);
```
getName()
```php
public function getName(): string;
```
getRememberName()
```php
public function getRememberName(): string;
```
getRememberTtl()
```php
public function getRememberTtl(): int;
```
## Auth\Guard\Config\TokenGuardConfig
Class
Source on GitHub
- [`Phalcon\Auth\Guard\Config\AbstractGuardConfig`](#authguardconfigabstractguardconfig)
- **`Phalcon\Auth\Guard\Config\TokenGuardConfig`**
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\ConfigRequiresNonEmptyValue`
### Method Summary
### Properties
protected
string
$inputKey
protected
string
$storageKey
### Methods
Public · 3
__construct()
```php
public function __construct(
string $inputKey,
string $storageKey
);
```
```php
public function getInputKey(): string;
```
getStorageKey()
```php
public function getStorageKey(): string;
```
## Auth\Guard\GuardLocator
Class
Source on GitHub
Service locator for Phalcon\Auth guards. Utilizes the container to obtain
the service. For Phalcon\Container\Container one can use autowiring; for
Phalcon\Di\Di, register the guards in it before resolution.
@extends AbstractLocator<Guard>
- [`Phalcon\Support\AbstractLocator`](/5.17/api/phalcon_support/#supportabstractlocator)
- **`Phalcon\Auth\Guard\GuardLocator`**
__Uses__ `Phalcon\Contracts\Auth\Guard\Guard` · `Phalcon\Support\AbstractLocator`
### Method Summary
### Methods
Protected · 3
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getInterfaceClass()
```php
protected function getInterfaceClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
## Auth\Guard\Session
Class
Source on GitHub
@extends AbstractGuard<SessionGuardConfig>
- [`Phalcon\Events\AbstractEventsAware`](/5.17/api/phalcon_events/#eventsabstracteventsaware)
- [`Phalcon\Auth\Guard\AbstractGuard`](#authguardabstractguard)
- **`Phalcon\Auth\Guard\Session`** - implements [`Phalcon\Contracts\Auth\Guard\GuardStateful`](/5.17/api/phalcon_contracts/#contractsauthguardguardstateful), [`Phalcon\Contracts\Auth\Guard\BasicAuth`](/5.17/api/phalcon_contracts/#contractsauthguardbasicauth)
__Uses__ `DateTimeImmutable` · `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Auth\Guard\Config\SessionGuardConfig` · `Phalcon\Auth\Internal\ContainerResolver` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\Adapter\RememberAdapter` · `Phalcon\Contracts\Auth\AuthRemember` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Auth\Guard\BasicAuth` · `Phalcon\Contracts\Auth\Guard\GuardStateful` · `Phalcon\Contracts\Auth\RememberToken` · `Phalcon\Http\RequestInterface` · `Phalcon\Http\Response\CookiesInterface` · `Phalcon\Session\ManagerInterface` · `Phalcon\Support\Helper\Json\Encode` · `Phalcon\Time\Clock\ClockInterface` · `Phalcon\Time\Clock\SystemClock`
### Method Summary
public
__construct(Adapter $adapter,RequestInterface $request,CookiesInterface $cookies,SessionManagerInterface $session,SessionGuardConfig $config = null,ClockInterface $clock = null)
public
bool
attempt(array $credentials = [],bool $remember = false)
public
bool
basic(string $field = "email",array $extraConditions = [])
public
static
fromOptions(Adapter $adapter,mixed $container,array $options)
public
string
getName()
public
string
getRememberName()
public
void
login(AuthUser $user,bool $remember = false)
public
false|AuthUser
loginById(mixed $id,bool $remember = false)
public
void
logout()
public
bool
once( array $credentials = [] )
public
false|AuthUser
onceBasic(string $field = "email",array $extraConditions = [])
public
AuthUser|null
user()
public
bool
validate( array $credentials = [] )
public
bool
viaRemember()
protected
bool
attemptBasic(string $field,array $extraConditions = [])
protected
array|null
basicCredentials( string $field )
protected
RememberToken
createRememberToken( AuthUser $user )
protected
UserRemember|null
recaller()
protected
void
rememberUser( AuthUser $user )
protected
AuthUser|null
userFromRecaller( UserRemember $recaller )
### Properties
protected
ClockInterface
$clock
protected
CookiesInterface
$cookies
protected
RequestInterface
$request
protected
SessionManagerInterface
$session
protected
bool
$viaRemember = false
### Methods
Public · 14
__construct()
```php
public function __construct(
Adapter $adapter,
RequestInterface $request,
CookiesInterface $cookies,
SessionManagerInterface $session,
SessionGuardConfig $config = null,
ClockInterface $clock = null
);
```
attempt()
```php
public function attempt(
array $credentials = [],
bool $remember = false
): bool;
```
basic()
```php
public function basic(
string $field = "email",
array $extraConditions = []
): bool;
```
fromOptions()
```php
public static function fromOptions(
Adapter $adapter,
mixed $container,
array $options
): static;
```
getName()
```php
public function getName(): string;
```
getRememberName()
```php
public function getRememberName(): string;
```
login()
```php
public function login(
AuthUser $user,
bool $remember = false
): void;
```
loginById()
```php
public function loginById(
mixed $id,
bool $remember = false
): false|AuthUser;
```
logout()
```php
public function logout(): void;
```
once()
```php
public function once( array $credentials = [] ): bool;
```
onceBasic()
```php
public function onceBasic(
string $field = "email",
array $extraConditions = []
): false|AuthUser;
```
user()
```php
public function user(): AuthUser|null;
```
validate()
```php
public function validate( array $credentials = [] ): bool;
```
viaRemember()
```php
public function viaRemember(): bool;
```
Protected · 6
attemptBasic()
```php
protected function attemptBasic(
string $field,
array $extraConditions = []
): bool;
```
basicCredentials()
```php
protected function basicCredentials( string $field ): array|null;
```
createRememberToken()
```php
protected function createRememberToken( AuthUser $user ): RememberToken;
```
recaller()
```php
protected function recaller(): UserRemember|null;
```
rememberUser()
```php
protected function rememberUser( AuthUser $user ): void;
```
userFromRecaller()
```php
protected function userFromRecaller( UserRemember $recaller ): AuthUser|null;
```
## Auth\Guard\Token
Class
Source on GitHub
@extends AbstractGuard<TokenGuardConfig>
- [`Phalcon\Events\AbstractEventsAware`](/5.17/api/phalcon_events/#eventsabstracteventsaware)
- [`Phalcon\Auth\Guard\AbstractGuard`](#authguardabstractguard)
- **`Phalcon\Auth\Guard\Token`**
__Uses__ `Phalcon\Auth\Guard\Config\TokenGuardConfig` · `Phalcon\Auth\Internal\ContainerResolver` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Http\RequestInterface`
### Method Summary
### Properties
protected
RequestInterface
$request
### Methods
Public · 6
__construct()
```php
public function __construct(
Adapter $adapter,
RequestInterface $request,
TokenGuardConfig $config
);
```
fromOptions()
```php
public static function fromOptions(
Adapter $adapter,
mixed $container,
array $options
): static;
```
getTokenForRequest()
```php
public function getTokenForRequest(): string|null;
```
setRequest()
```php
public function setRequest( RequestInterface $request ): static;
```
user()
```php
public function user(): AuthUser|null;
```
validate()
```php
public function validate( array $credentials = [] ): bool;
```
## Auth\Guard\UserRemember
Final
Source on GitHub
Value object representing the contents of a remember-me cookie.
- **`Phalcon\Auth\Guard\UserRemember`**
__Uses__ `InvalidArgumentException` · `Phalcon\Support\Helper\Json\Decode`
### Method Summary
### Properties
protected
int|string|null
$id
protected
string
$token
protected
string
$userAgent
### Methods
Public · 4
__construct()
```php
public function __construct( mixed $payload );
```
Accepts either the raw JSON cookie value (string) or the already
decoded associative array. Malformed input degrades to an empty
payload so callers can read getters without null-guarding.
getId()
```php
public function getId(): int|string|null;
```
getToken()
```php
public function getToken(): string;
```
getUserAgent()
```php
public function getUserAgent(): string;
```
## Auth\Internal\ContainerResolver
Final
Source on GitHub
Internal single source of truth for resolving services from either the
new Phalcon\Container\Container or the legacy Phalcon\Di\Di. Not part of
the public API.
Intent is Container-first; the legacy Di is supported "with provisions":
definitions must be pre-registered (no autowiring), the one exception
being the fresh path, which lets Di build an unregistered but existing
class via its class builder.
All legacy-Di failures are normalized to Phalcon\Container\Exceptions so
callers and userland catch a single exception family.
- **`Phalcon\Auth\Internal\ContainerResolver`**
__Uses__ `Phalcon\Container\Exceptions\Exception` · `Phalcon\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface` · `Phalcon\Di\Exception`
### Method Summary
public
void
ensureContainer( mixed $container )
Validates that the value is a supported container.
public
object
requireService(mixed $container,array $candidates,string $context)
Resolves the first candidate service name that the container can
public
object
resolveCandidate(mixed $container,array $options,string $key,string $fqn,string $shortName,string $context)
Convenience composition of serviceCandidates() + requireService():
public
object
resolveFresh(mixed $container,string $name)
Resolves a fresh instance: new() on the Container (bypasses the
public
array
serviceCandidates(array $options,string $key,string $fqn,string $shortName)
Builds the ordered candidate list for a framework service:
### Methods
Public · 5
ensureContainer()
```php
public static function ensureContainer( mixed $container ): void;
```
Validates that the value is a supported container.
requireService()
```php
public static function requireService(
mixed $container,
array $candidates,
string $context
): object;
```
Resolves the first candidate service name that the container can
provide, as a shared instance. Used for framework services (request,
cookies, session) whose container key may vary between application
setups.
resolveCandidate()
```php
public static function resolveCandidate(
mixed $container,
array $options,
string $key,
string $fqn,
string $shortName,
string $context
): object;
```
Convenience composition of serviceCandidates() + requireService():
resolves the first bound candidate for a framework service whose
container key may vary, using the options override or the
[interface FQN, conventional short name] fallback.
resolveFresh()
```php
public static function resolveFresh(
mixed $container,
string $name
): object;
```
Resolves a fresh instance: new() on the Container (bypasses the
instance cache); get() on the legacy Di (fresh for unregistered or
non-shared services). On Di, an unregistered but existing class is
still built via the class builder.
serviceCandidates()
```php
public static function serviceCandidates(
array $options,
string $key,
string $fqn,
string $shortName
): array;
```
Builds the ordered candidate list for a framework service:
an explicit override from options['services'][key] if present,
otherwise the interface FQN followed by the conventional short name.
## Auth\Internal\Options
Final
Source on GitHub
Internal option-parsing helpers shared by adapter / guard fromOptions()
implementations. Not part of the public API.
- **`Phalcon\Auth\Internal\Options`**
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\OptionRequiresArray` · `Phalcon\Auth\Exceptions\OptionRequiresString`
### Method Summary
### Methods
Public · 4
arrayOption()
```php
public static function arrayOption(
array $options,
string $key,
array $defaultValue
): array;
```
requireArray()
```php
public static function requireArray(
array $options,
string $key,
string $context
): array;
```
requireString()
```php
public static function requireString(
array $options,
string $key,
string $context
): string;
```
stringOrNull()
```php
public static function stringOrNull(
array $options,
string $key
): string|null;
```
## Auth\Manager
Class
Source on GitHub
Composes guards (authentication) and access gates (authorization)
behind a single facade. Guard-specific behavior is reached through
Manager::guard(); callers narrow with instanceof against the
relevant capability interface (GuardStateful, BasicAuth, etc.).
- **`Phalcon\Auth\Manager`** - implements [`Phalcon\Contracts\Auth\Manager`](/5.17/api/phalcon_contracts/#contractsauthmanager)
__Uses__ `Phalcon\Auth\Access\AccessLocator` · `Phalcon\Auth\Exceptions\AccessNotRegistered` · `Phalcon\Auth\Exceptions\ActiveAccessRequired` · `Phalcon\Auth\Exceptions\DefaultGuardNotRegistered` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Auth\Exceptions\GuardNotDefined` · `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Auth\Guard\Guard` · `Phalcon\Contracts\Auth\Guard\GuardStateful` · `Phalcon\Contracts\Auth\Manager`
### Method Summary
### Properties
protected
AccessLocator
$accessFactory
protected
Access | null
$activeAccess = null
protected
Guard | null
$defaultGuard = null
protected
array<string, Guard>
$guards = []
### Methods
Public · 19
__construct()
```php
public function __construct( AccessLocator $accessFactory );
```
access()
```php
public function access( string $accessName ): self;
```
addAccessList()
```php
public function addAccessList( array $accessList ): self;
```
addGuard()
```php
public function addGuard(
string $nameGuard,
Guard $guard,
bool $isDefault = false
): self;
```
attempt()
```php
public function attempt(
array $credentials = [],
bool $remember = false
): bool;
```
check()
```php
public function check(): bool;
```
except()
```php
public function except( string $actions ): self;
```
getAccess()
```php
public function getAccess(): Access|null;
```
getAccessList()
```php
public function getAccessList(): array;
```
getDefaultGuard()
```php
public function getDefaultGuard(): Guard|null;
```
getGuards()
```php
public function getGuards(): array;
```
guard()
```php
public function guard( string $name = null ): Guard;
```
id()
```php
public function id(): int|string|null;
```
logout()
```php
public function logout(): void;
```
only()
```php
public function only( string $actions ): self;
```
setAccess()
```php
public function setAccess( Access $access ): self;
```
setDefaultGuard()
```php
public function setDefaultGuard( Guard $guard ): self;
```
user()
```php
public function user(): AuthUser|null;
```
validate()
```php
public function validate( array $credentials = [] ): bool;
```
## Auth\ManagerFactory
Class
Source on GitHub
Single entry-point factory that builds a fully wired Phalcon\Auth\Manager
from a config tree. Framework-shared services (RequestInterface,
CookiesInterface, SessionManagerInterface) are resolved from the injected
container so the manager wires against the real application singletons,
not separately constructed copies.
[
'guards' => [
'web' => [
'type' => 'session',
'default' => true,
'adapter' => [
'name' => 'model',
'options' => [
'model' => User::class
],
],
'options' => [],
],
'api' => [
'type' => 'token',
'adapter' => [
'name' => 'model',
'options' => [
'model' => User::class
]
],
'options' => [
'inputKey' => 'api_token',
'storageKey' => 'api_token'
],
],
],
'access' => [
'auth' => \Phalcon\Auth\Access\Auth::class,
'guest' => \Phalcon\Auth\Access\Guest::class,
],
]
- **`Phalcon\Auth\ManagerFactory`**
__Uses__ `Phalcon\Auth\Access\AccessLocator` · `Phalcon\Auth\Adapter\AdapterLocator` · `Phalcon\Auth\Exceptions\UnknownAdapter` · `Phalcon\Auth\Exceptions\UnknownGuard` · `Phalcon\Auth\Guard\GuardLocator` · `Phalcon\Auth\Internal\ContainerResolver` · `Phalcon\Auth\Internal\Options` · `Phalcon\Config\ConfigInterface` · `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\Guard\Guard` · `Phalcon\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface` · `Phalcon\Encryption\Security`
### Method Summary
### Properties
protected
AccessLocator
$accessLocator
protected
AdapterLocator
$adapterLocator
protected
Collection|DiInterface
$container
protected
GuardLocator
$guardLocator
protected
Security
$hasher
### Methods
Public · 2
__construct()
```php
public function __construct(
Security $hasher,
mixed $container,
AdapterLocator $adapterLocator = null,
GuardLocator $guardLocator = null,
AccessLocator $accessLocator = null
);
```
load()
```php
public function load( mixed $config ): Manager;
```
Protected · 2
buildAdapter()
```php
protected function buildAdapter(
AdapterLocator $locator,
array $cfg
): Adapter;
```
buildGuard()
```php
protected function buildGuard(
GuardLocator $locator,
string $type,
Adapter $adapter,
array $options
): Guard;
```
## Auth\Micro\AuthMicroListener
Class
Source on GitHub
Listener that enforces the active Phalcon\Auth access gate on each Micro
route execution. Attach to the events manager:
$eventsManager->attach('micro', new AuthMicroListener($manager));
$app->setEventsManager($eventsManager);
The action name is the matched route's name, falling back to the route
pattern when the route is unnamed. The ACL component is the configured
component name (default 'Micro'). redirectTo() is ignored - Micro has no
forward mechanism.
No-op when no active access has been set on the manager.
- [`Phalcon\Auth\AbstractAuthDispatcherListener`](#authabstractauthdispatcherlistener)
- **`Phalcon\Auth\Micro\AuthMicroListener`**
__Uses__ `Phalcon\Auth\AbstractAuthDispatcherListener` · `Phalcon\Auth\Exception` · `Phalcon\Contracts\Auth\Manager` · `Phalcon\Events\Event` · `Phalcon\Mvc\Micro` · `Phalcon\Mvc\RouterInterface` · `Phalcon\Mvc\Router\RouteInterface`
### Method Summary
### Properties
protected
string
$componentName
### Methods
Public · 2
__construct()
```php
public function __construct(
Manager $manager,
string $componentName = "Micro"
);
```
beforeExecuteRoute()
```php
public function beforeExecuteRoute(
Event $event,
Micro $application
): bool;
```
Protected · 1
getActionType()
```php
protected function getActionType(): string;
```
## Auth\Mvc\AuthDispatcherListener
Class
Source on GitHub
Listener that enforces the active Phalcon\Auth access gate on each MVC
dispatch. Attach to the events manager:
$eventsManager->attach('dispatch', new AuthDispatcherListener($manager));
No-op when no active access has been set on the manager.
- [`Phalcon\Auth\AbstractAuthDispatcherListener`](#authabstractauthdispatcherlistener)
- **`Phalcon\Auth\Mvc\AuthDispatcherListener`**
__Uses__ `Phalcon\Auth\AbstractAuthDispatcherListener` · `Phalcon\Auth\Exception` · `Phalcon\Events\Event` · `Phalcon\Mvc\Dispatcher`
### Method Summary
### Methods
Public · 1
beforeExecuteRoute()
```php
public function beforeExecuteRoute(
Event $event,
Dispatcher $dispatcher
): bool;
```
Protected · 1
getActionType()
```php
protected function getActionType(): string;
```
Source: https://docs.phalcon.io/5.17/api/phalcon_auth/index.mdx