Failure

final readonly class \TYPO3\CMS\Core\Authentication\Pipeline\Failure

Implements
AuthenticationResult

Explicitly failed authentication attempt. Loggable and countable towards rate limits, with an optional message safe to show to users.

The reason is a stable, machine-readable code such as "invalid-credentials" or "invalid-token", which callers may map to a response. It is never shown to users.

Table of Contents

Interfaces

AuthenticationResult
Union type of the possible outcomes of an authentication attempt:

Properties

$reason  : string
$userFacingMessage  : string|null

Methods

__construct()  : mixed

Properties

$userFacingMessage

public string|null $userFacingMessage = null

Methods

__construct()

public __construct(string $reason[, string|null $userFacingMessage = null ]) : mixed

Parameters

$reason : string
$userFacingMessage : string|null = null
On this page