Class AuthenticationMiddleware

Authentication Middleware

Namespace: Authentication\Middleware

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

Configuration options
$container protected

Cake\Core\ContainerInterface|null

The container instance from the application
$subject protected

Authentication\AuthenticationServiceInterface|Authentication\AuthenticationServiceProviderInterface

Authentication service or application instance.

Method Summary

__construct() public

Constructor
_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
configShallow() public

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

Returns AuthenticationServiceInterface instance.
getConfig() public

Returns the config.
getConfigOrFail() public

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

Callable implementation for the middleware stack.
setConfig() public

Sets the config.

Method Detail

__construct() ¶ public

__construct(Authentication\AuthenticationServiceInterface|Authentication\AuthenticationServiceProviderInterface $subject, array $config = [], Cake\Core\ContainerInterface|null $container = null)

Constructor

Parameters

Authentication\AuthenticationServiceInterface|Authentication\AuthenticationServiceProviderInterface $subject: Authentication service or application instance.
array $config optional: Array of configuration settings.
Cake\Core\ContainerInterface|null $container optional: The container instance from the application

Throws

InvalidArgumentException
When invalid subject has been passed.

_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

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

getAuthenticationService() ¶ protected

getAuthenticationService(Psr\Http\Message\ServerRequestInterface $request): Authentication\AuthenticationServiceInterface

Returns AuthenticationServiceInterface instance.

Parameters

Psr\Http\Message\ServerRequestInterface $request: Server request.

Returns

Authentication\AuthenticationServiceInterface

Throws

RuntimeException
When authentication method has not been defined.

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

process() ¶ public

process(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface

Callable implementation for the middleware stack.

Processes an incoming server request in order to produce a response. If unable to produce the response itself, it may delegate to the provided request handler to do so.

Parameters

ServerRequestInterface $request: The request.
RequestHandlerInterface $handler: The request handler.

Returns

Psr\Http\Message\ResponseInterface

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.

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

Configuration options

The following keys are deprecated and should instead be set on the AuthenticationService

identityAttribute - The request attribute to store the identity in.
unauthenticatedRedirect - The URL to redirect unauthenticated errors to. See AuthenticationComponent::allowUnauthenticated()
queryParam - The name of the query string parameter containing the previously blocked URL in case of unauthenticated redirect, or null to disable appending the denied URL.

Type

array

`$container` ¶ protected

The container instance from the application

Type

Cake\Core\ContainerInterface|null

`$subject` ¶ protected

Authentication service or application instance.

Type

Authentication\AuthenticationServiceInterface|Authentication\AuthenticationServiceProviderInterface

Namespaces

Class AuthenticationMiddleware

Property Summary

Method Summary

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

getAuthenticationService() protected

getConfig() public

getConfigOrFail() public

process() public

setConfig() public

Method Detail

__construct() ¶ public

Parameters

Throws

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

getAuthenticationService() ¶ protected

Parameters

Returns

Throws

getConfig() ¶ public

Usage

Parameters

Returns

getConfigOrFail() ¶ public

Parameters

Returns

Throws

process() ¶ public

Parameters

Returns

setConfig() ¶ public

Usage

Parameters

Returns

Throws

Property Detail

$_config ¶ protected

Type

$_configInitialized ¶ protected

Type

$_defaultConfig ¶ protected

Type

$container ¶ protected

Type

$subject ¶ protected

Type

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$container` ¶ protected

`$subject` ¶ protected