Trait SimpleID\Protocols\ProtocolResultTrait

A utility trait dealing with collecting assertion results from identity protocols.

This trait provides the setResult() method, which updates the assertion result only if it is worse than the existing stored assertion result (if any).

The final assertion result can be obtained from the getResult() method.

SimpleID\Protocols\ProtocolResultTrait
- SimpleID\Protocols\OAuth\OAuthAuthRequestEvent implements ProtocolResult uses ProtocolResultTrait
- SimpleID\Protocols\OpenID\OpenIDCheckEvent implements ProtocolResult uses ProtocolResultTrait

Located at core/Protocols/ProtocolResultTrait.php

Methods


					
	public

setResult(int $result): void

Sets the assertion result.

This method is ignored if the provided assertion result is not worse (i.e. greater than) the existing assertion result stored in the event.

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

Parameters

$result

the assertion result


					
	public

getResult(): int

Returns the currently stored assertion result.

If there is no assertion result currently stored (i.e. hasResult() returns false), this returns SimpleID\Protocols\ProtocolResult::CHECKID_PROTOCOL_ERROR

Returns

the assertion result


					
	public

hasResult(): bool

Returns true if an assertion result has been set previously by another listener.

Returns

true if an assertion result has been set previously

Properties
`protected`	`int`	`$result = null`	#

Namespaces

Classes

Interfaces

Traits

Trait SimpleID\Protocols\ProtocolResultTrait

Parameters

Returns

Returns