Class FormAuthenticator

Form Authenticator

Authenticates an identity based on the POST data of the request.

Namespace: Authentication\Authenticator

Property Summary

$_config protected

array<string, mixed>

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array
Default config for this object.
- fields The fields to use to identify a user by.
- loginUrl Login URL or an array of URLs.
- urlChecker Url checker config.
$_identifier protected

Authentication\Identifier\IdentifierInterface

Identifier or identifiers collection.

Method Summary

__construct() public

Constructor
_buildLoginUrlErrorResult() protected

Prepares the error object for a login URL error
_checkUrl() protected

Checks the Login URL
_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
_getData() protected

Checks the fields to ensure they are supplied.
_getUrlChecker() protected

Gets the login URL checker
authenticate() public

Authenticates the identity contained in a request. Will use the config.userModel, and config.fields to find POST data that is used to find a matching record in the config.userModel. Will return false if there is no post data, either username or password is missing, or if the scope conditions have not been met.
configShallow() public

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
getConfig() public

Returns the config.
getConfigOrFail() public

Returns the config for this specific key.
getIdentifier() public

Gets the identifier.
setConfig() public

Sets the config.
setIdentifier() public

Sets the identifier.

Method Detail

__construct() ¶ public

__construct(Authentication\Identifier\IdentifierInterface $identifier, array $config = [])

Constructor

Parameters

Authentication\Identifier\IdentifierInterface $identifier: Identifier or identifiers collection.
array $config optional: Configuration settings.

_buildLoginUrlErrorResult() ¶ protected

_buildLoginUrlErrorResult(Psr\Http\Message\ServerRequestInterface $request): Authentication\Authenticator\ResultInterface

Prepares the error object for a login URL error

Parameters

Psr\Http\Message\ServerRequestInterface $request: The request that contains login information.

Returns

Authentication\Authenticator\ResultInterface

_checkUrl() ¶ protected

_checkUrl(Psr\Http\Message\ServerRequestInterface $request): bool

Checks the Login URL

Parameters

Psr\Http\Message\ServerRequestInterface $request: The request that contains login information.

Returns

bool

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters

array<string, mixed>|string $key: Key to write to.
mixed $value: Value to write.
string|bool $merge optional: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_getData() ¶ protected

_getData(Psr\Http\Message\ServerRequestInterface $request): array|null

Checks the fields to ensure they are supplied.

Parameters

Psr\Http\Message\ServerRequestInterface $request: The request that contains login information.

Returns

array|null

_getUrlChecker() ¶ protected

_getUrlChecker(): Authentication\UrlChecker\UrlCheckerInterface

Gets the login URL checker

Returns

Authentication\UrlChecker\UrlCheckerInterface

authenticate() ¶ public

authenticate(Psr\Http\Message\ServerRequestInterface $request): Authentication\Authenticator\ResultInterface

Authenticates the identity contained in a request. Will use the config.userModel, and config.fields to find POST data that is used to find a matching record in the config.userModel. Will return false if there is no post data, either username or password is missing, or if the scope conditions have not been met.

Parameters

Psr\Http\Message\ServerRequestInterface $request: The request that contains login information.

Returns

Authentication\Authenticator\ResultInterface

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

array<string, mixed>|string $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.

Returns

$this

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional: The key to get or null for the whole config.
mixed $default optional: The return value when the key does not exist.

Returns

mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key: The key to get.

Returns

mixed

Throws

InvalidArgumentException

getIdentifier() ¶ public

getIdentifier(): Authentication\Identifier\IdentifierInterface

Gets the identifier.

Returns

Authentication\Identifier\IdentifierInterface

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

array<string, mixed>|string $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.
bool $merge optional: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\CakeException
When trying to set a key that is invalid.

setIdentifier() ¶ public

setIdentifier(Authentication\Identifier\IdentifierInterface $identifier): $this

Sets the identifier.

Parameters

Authentication\Identifier\IdentifierInterface $identifier: IdentifierInterface instance.

Returns

$this

Property Detail

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

Default config for this object.

fields The fields to use to identify a user by.
loginUrl Login URL or an array of URLs.
urlChecker Url checker config.

Type

array

`$_identifier` ¶ protected

Identifier or identifiers collection.

Type

Authentication\Identifier\IdentifierInterface

Namespaces

Class FormAuthenticator

Property Summary

Method Summary

__construct() public

_buildLoginUrlErrorResult() protected

_checkUrl() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_getData() protected

_getUrlChecker() protected

authenticate() public

configShallow() public

getConfig() public

getConfigOrFail() public

getIdentifier() public

setConfig() public

setIdentifier() public

Method Detail

__construct() ¶ public

Parameters

_buildLoginUrlErrorResult() ¶ protected

Parameters

Returns

_checkUrl() ¶ protected

Parameters

Returns

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_getData() ¶ protected

Parameters

Returns

_getUrlChecker() ¶ protected

Returns

authenticate() ¶ public

Parameters

Returns

configShallow() ¶ public

Parameters

Returns

getConfig() ¶ public

Usage

Parameters

Returns

getConfigOrFail() ¶ public

Parameters

Returns

Throws

getIdentifier() ¶ public

Returns

setConfig() ¶ public

Usage

Parameters

Returns

Throws

setIdentifier() ¶ public

Parameters

Returns

Property Detail

$_config ¶ protected

Type

$_configInitialized ¶ protected

Type

$_defaultConfig ¶ protected

Type

$_identifier ¶ protected

Type

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_identifier` ¶ protected