Class SimpleID\Protocols\OpenID\OpenIDCheckEvent

`extends`	`BaseEvent`
`implements`	`ProtocolResult`
`uses`	`ProtocolResultTrait`

An event to process an OpenID authentication request.

There are two kinds of OpenID authentication requests:

Identifier requests. These are standard authentication requests provided by the OpenID specifications. SimpleID processes these using the SimpleID\Protocols\OpenID\OpenIDModule::openIDCheckIdentity()

methods, but listeners can modify the assertion result.

Extension requests The OpenID specifications also provides a mechanism for extensions to process authentication requests that are not about an identifier.

Listeners can identify whether a request is an identifier request or an extension request by calling the isExtensionRequest() method.

Listeners can examine the contents of the request, and whether a request is immediate (i.e. whether openid.mode is checkid_immediate) using the getRequest() and isImmediate() methods respectively.

For identifier requests, the identifier that is subject to the request can be obtained from the getRequestedIdentity() method.

The assertion result can be set using the setResult()

method. The result must be one of the constants defined in SimpleID\Protocols\ProtocolResult

Note that for identifier requests, the standard processing (by SimpleID\Protocols\OpenID\OpenIDModule::openIDCheckIdentity()

) occurs after these listeners are called. Therefore, attempts to retrieve the assertion result may return CHECKID_PROTOCOL_ERROR.

SimpleID\Util\Events\BaseEvent
- SimpleID\Protocols\OpenID\OpenIDCheckEvent implements ProtocolResult uses ProtocolResultTrait

Located at core/Protocols/OpenID/OpenIDCheckEvent.php

Methods
`public`	`__construct(Request $request, bool $immediate, ?string $identity = null)`	#
`public`	`getRequest(): Request` Returns the OpenID request. Returns the OpenID request. Returns the OpenID request	#
`public`	`isImmediate(): bool` Returns whether the request is immediate (i.e. whether `openid.mode` is `checkid_immediate`) Returns whether the request is immediate (i.e. whether `openid.mode` is `checkid_immediate`) Returns true if the request is immediate	#
`public`	`isExtensionRequest(): bool` Returns whether the request is an extension request. If the request is not an extension request, it is a standard identifier request. Returns whether the request is an extension request. If the request is not an extension request, it is a standard identifier request. Returns true if the request is an extension request	#
`public`	`getRequestedIdentity(): string` Returns the identifier that is subject to the request. If the request is an extension request, this method returns null Returns the identifier that is subject to the request. If the request is an extension request, this method returns null Returns the OpenID identifier	#

Methods used from SimpleID\Protocols\ProtocolResultTrait
`setResult(), getResult(), hasResult()`

Constants inherited from SimpleID\Protocols\ProtocolResult
`CHECKID_OK, CHECKID_RETURN_TO_SUSPECT, CHECKID_APPROVAL_REQUIRED, CHECKID_REENTER_CREDENTIALS, CHECKID_LOGIN_REQUIRED, CHECKID_IDENTITIES_NOT_MATCHING, CHECKID_IDENTITY_NOT_EXIST, CHECKID_INSUFFICIENT_TRUST, CHECKID_PROTOCOL_ERROR`

Properties
`protected`	`Request`	`$request`	#
`protected`	`bool`	`$immediate`	#
`protected`	`string\|null`	`$identity = null`	#

Properties used from SimpleID\Protocols\ProtocolResultTrait
`$result`

Namespaces

Classes

Class SimpleID\Protocols\OpenID\OpenIDCheckEvent

Returns

Returns

Returns

Returns