---
title: "Phalcon Auth"
version: "5.14"
---
> 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 and Mvc auth dispatcher
listeners. The dispatcher-specific subclass provides only the action
name from its typed dispatcher, the action-kind label used in the
access-denied exception, and (Mvc only) a forward handler for
Access::redirectTo().
- **`Phalcon\Auth\AbstractAuthDispatcherListener`**
- [`Phalcon\Auth\Cli\AuthDispatcherListener`](#authcliauthdispatcherlistener)
- [`Phalcon\Auth\Mvc\AuthDispatcherListener`](#authmvcauthdispatcherlistener)
__Uses__ `Phalcon\Auth\Exceptions\AccessDenied` · `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,
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.
getActionType()
```php
abstract protected function getActionType(): string;
```
Returns the kind label used by AccessDenied (e.g. 'task',
'action').
## Auth\Access\AbstractAccess
Abstract
Source on GitHub
- **`Phalcon\Auth\Access\AbstractAccess`** — implements [`Phalcon\Contracts\Auth\Access\Access`](/5.14/api/phalcon_contracts/#contractsauthaccessaccess)
- [`Phalcon\Auth\Access\Auth`](#authaccessauth)
- [`Phalcon\Auth\Access\Guest`](#authaccessguest)
__Uses__ `Phalcon\Contracts\Auth\Access\Access` · `Phalcon\Contracts\Auth\Manager`
### Method Summary
### Properties
protected
array
$exceptActions = []
protected
Manager
$manager
protected
array
$onlyActions = []
### Methods
Public · 7
__construct()
```php
public function __construct( Manager $manager );
```
getExceptActions()
```php
public function getExceptActions(): array;
```
getOnlyActions()
```php
public function getOnlyActions(): array;
```
isAllowed()
```php
public function isAllowed( string $actionName ): bool;
```
redirectTo()
```php
public function redirectTo(): array|null;
```
setExceptActions()
```php
public function setExceptActions( array $exceptActions = [] ): void;
```
setOnlyActions()
```php
public function setOnlyActions( array $onlyActions = [] ): void;
```
## 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.
@extends AbstractLocator<Access>
- [`Phalcon\Support\AbstractLocator`](/5.14/api/phalcon_support/#supportabstractlocator)
- **`Phalcon\Auth\Access\AccessLocator`**
__Uses__ `Phalcon\Contracts\Auth\Access\Access` · `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\Access\Auth
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`Phalcon\Auth\Access\AbstractAccess`](#authaccessabstractaccess)
- **`Phalcon\Auth\Access\Auth`**
### Method Summary
### Methods
Public · 1
allowedIf()
```php
public function allowedIf(): bool;
```
## Auth\Access\Guest
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`Phalcon\Auth\Access\AbstractAccess`](#authaccessabstractaccess)
- **`Phalcon\Auth\Access\Guest`**
### Method Summary
### Methods
Public · 1
allowedIf()
```php
public function allowedIf(): bool;
```
## Auth\Adapter\AbstractAdapter
Abstract
Source on GitHub
@template TConfig of AdapterConfig
- **`Phalcon\Auth\Adapter\AbstractAdapter`** — implements [`Phalcon\Contracts\Auth\Adapter\Adapter`](/5.14/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
### 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.
## 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\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.14/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
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- **`Phalcon\Auth\Adapter\Config\AbstractAdapterConfig`** — implements [`Phalcon\Contracts\Auth\Adapter\AdapterConfig`](/5.14/api/phalcon_contracts/#contractsauthadapteradapterconfig)
- [`Phalcon\Auth\Adapter\Config\MemoryAdapterConfig`](#authadapterconfigmemoryadapterconfig)
- [`Phalcon\Auth\Adapter\Config\ModelAdapterConfig`](#authadapterconfigmodeladapterconfig)
- [`Phalcon\Auth\Adapter\Config\StreamAdapterConfig`](#authadapterconfigstreamadapterconfig)
__Uses__ `Phalcon\Contracts\Auth\Adapter\AdapterConfig`
### Method Summary
### Properties
protected
string|null
$model = null
### Methods
Public · 2
__construct()
```php
public function __construct( string $model = null );
```
getModel()
```php
public function getModel(): string|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
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`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
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`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.14/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`
### 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 · 3
loadUsers()
```php
protected function loadUsers(): array;
```
Loads and decodes the JSON users file. Re-read on every call - if you
need caching, wrap it.
phpFileExists()
```php
protected function phpFileExists( string $filename ): bool;
```
phpFileGetContents()
```php
protected function phpFileGetContents( string $filename );
```
## 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.14/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
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`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\ConfigRequiresNonEmptyValue`](#authexceptionsconfigrequiresnonemptyvalue)
- [`Phalcon\Auth\Exceptions\DataMustContainIdKey`](#authexceptionsdatamustcontainidkey)
- [`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)
## 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\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 · 1
__construct()
```php
public function __construct(
string $configName,
string $configKey,
string $suffix = ""
);
```
## 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\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 · 1
__construct()
```php
public function __construct(
string $type,
string $name
);
```
## 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\Guard\AbstractGuard
Abstract
Source on GitHub
@template TConfig of GuardConfig
- [`Phalcon\Events\AbstractEventsAware`](/5.14/api/phalcon_events/#eventsabstracteventsaware)
- **`Phalcon\Auth\Guard\AbstractGuard`** — implements [`Phalcon\Contracts\Auth\Guard\Guard`](/5.14/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
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- **`Phalcon\Auth\Guard\Config\AbstractGuardConfig`** — implements [`Phalcon\Contracts\Auth\Guard\GuardConfig`](/5.14/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`
### Method Summary
### Methods
Public · 3
__construct()
```php
public function __construct(
string $suffix = null,
string $name = null,
string $rememberName = null
);
```
getName()
```php
public function getName(): string;
```
getRememberName()
```php
public function getRememberName(): string;
```
## Auth\Guard\Config\TokenGuardConfig
Class
Source on GitHub
This file is part of the Phalcon Framework.
(c) Phalcon Team <team@phalcon.io>
For the full copyright and license information, please view the LICENSE.txt
file that was distributed with this source code.
Implementation of this file has been influenced by sinbadxiii/cphalcon-auth
@link https://github.com/sinbadxiii/cphalcon-auth
- [`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.14/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.14/api/phalcon_events/#eventsabstracteventsaware)
- [`Phalcon\Auth\Guard\AbstractGuard`](#authguardabstractguard)
- **`Phalcon\Auth\Guard\Session`** — implements [`Phalcon\Contracts\Auth\Guard\GuardStateful`](/5.14/api/phalcon_contracts/#contractsauthguardguardstateful), [`Phalcon\Contracts\Auth\Guard\BasicAuth`](/5.14/api/phalcon_contracts/#contractsauthguardbasicauth)
__Uses__ `Phalcon\Auth\Exception` · `Phalcon\Auth\Exceptions\DoesNotImplement` · `Phalcon\Auth\Guard\Config\SessionGuardConfig` · `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\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface` · `Phalcon\Http\RequestInterface` · `Phalcon\Http\Response\CookiesInterface` · `Phalcon\Session\ManagerInterface` · `Phalcon\Support\Helper\Json\Encode`
### Method Summary
public
__construct(Adapter $adapter,RequestInterface $request,CookiesInterface $cookies,SessionManagerInterface $session,SessionGuardConfig $config = 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
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
);
```
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.14/api/phalcon_events/#eventsabstracteventsaware)
- [`Phalcon\Auth\Guard\AbstractGuard`](#authguardabstractguard)
- **`Phalcon\Auth\Guard\Token`**
__Uses__ `Phalcon\Auth\Guard\Config\TokenGuardConfig` · `Phalcon\Auth\Internal\Options` · `Phalcon\Contracts\Auth\Adapter\Adapter` · `Phalcon\Contracts\Auth\AuthUser` · `Phalcon\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface` · `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\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\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface`
### Method Summary
### Methods
Public · 4
arrayOption()
```php
public static function arrayOption(
array $options,
string $key,
array $defaultValue
): array;
```
requireString()
```php
public static function requireString(
array $options,
string $key,
string $context
): string;
```
resolveService()
```php
public static function resolveService(
mixed $container,
string $serviceId,
string $context
): object;
```
@template T of object
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.14/api/phalcon_contracts/#contractsauthmanager)
__Uses__ `Phalcon\Auth\Access\AccessLocator` · `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\Guard\GuardLocator` · `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
$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\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.14/api/phalcon_auth/index.mdx