Realm

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

Describes a security zone authentication is performed for. The TYPO3 backend, the frontend of a site, or a custom realm such as a token based API.

Authenticators are registered for the realms they serve, so that credentials meant for one realm never authenticate another.

Table of Contents

Properties

$identifier  : string

Methods

backend()  : self
custom()  : self
A realm of its own, e.g. for a token based API. Like the backend realm, a custom realm authenticates backend users. The identifiers of the backend and frontend realms are reserved.
fromRegistration()  : self
The realm an authenticator is registered for: "backend", "frontend" for the frontend of every site, or a custom realm. The frontend realm of a single site can not be registered.
frontend()  : self
The frontend realm of a site, or the general frontend realm if the request has no site configuration (no site or a NullSite).
getRegistrationIdentifier()  : string
The realm identifier the authenticators of this realm are registered for, "frontend" for the frontend realm of every site.
isBackend()  : bool
isFrontend()  : bool
isFrontendIdentifier()  : bool
The frontend realm and the frontend realms of sites authenticate frontend users, every other realm authenticates backend users.

Properties

Methods

backend()

public static backend() : self

Return values

self

custom()

A realm of its own, e.g. for a token based API. Like the backend realm, a custom realm authenticates backend users. The identifiers of the backend and frontend realms are reserved.

public static custom(string $identifier) : self

Parameters

$identifier : string

Return values

self

fromRegistration()

The realm an authenticator is registered for: "backend", "frontend" for the frontend of every site, or a custom realm. The frontend realm of a single site can not be registered.

public static fromRegistration(string $identifier) : self

Parameters

$identifier : string

Return values

self

frontend()

The frontend realm of a site, or the general frontend realm if the request has no site configuration (no site or a NullSite).

public static frontend([SiteInterface|null $site = null ]) : self

Parameters

$site : SiteInterface|null = null

Return values

self

getRegistrationIdentifier()

The realm identifier the authenticators of this realm are registered for, "frontend" for the frontend realm of every site.

public getRegistrationIdentifier() : string

Return values

string

isBackend()

public isBackend() : bool

Return values

bool

isFrontend()

public isFrontend() : bool

Return values

bool

isFrontendIdentifier()

The frontend realm and the frontend realms of sites authenticate frontend users, every other realm authenticates backend users.

public static isFrontendIdentifier(string $identifier) : bool

Parameters

$identifier : string

Return values

bool
On this page