Documentation

EntityStatement
in package

Handle EntityStatement

OpenID Connect Federation Entity Statement

Table of Contents

__construct()  : EntityStatement
creates a new EntityStatement instance
applyPolicy()  : mixed
apply policy from federation entity statement
getPayload()  : mixed
return entity statement payload
initFromObject()  : EntityStatement
initialize the entity statement payload from object
makeFromConfig()  : mixed
creates the JWT to be returned from .well-known/openid-federation endpoint
validate()  : mixed
validate token
applyPolicyModifierAdd()  : mixed
applyPolicyModifierDefault()  : mixed
applyPolicyModifierEssential()  : mixed
applyPolicyModifierOneOf()  : mixed
applyPolicyModifierSubsetOf()  : mixed
applyPolicyModifierSupersetOf()  : mixed
applyPolicyModifierValue()  : mixed

Methods

__construct()

creates a new EntityStatement instance

public __construct([string $token = null ][, string $iss = string ]) : EntityStatement
Parameters
$token : string = null

entity statement JWS token

$iss : string = string

issuer

Tags
throws
Exception
Return values
EntityStatement

applyPolicy()

apply policy from federation entity statement

public applyPolicy(EntityStatement $federation_entity_statement) : mixed
Parameters
$federation_entity_statement : EntityStatement

the federation entity statement containing policy

Tags
throws
Exception
Return values
mixed

getPayload()

return entity statement payload

public getPayload() : mixed
Tags
throws
Exception
Return values
mixed

the entity statement payload

initFromObject()

initialize the entity statement payload from object

public initFromObject(object $object) : EntityStatement
Parameters
$object : object

the entity statement object

Tags
throws
Exception
Return values
EntityStatement

makeFromConfig()

creates the JWT to be returned from .well-known/openid-federation endpoint

public static makeFromConfig(array<string|int, mixed> $config[, mixed $json = false ]) : mixed
Parameters
$config : array<string|int, mixed>

base configuration

$json : mixed = false
Tags
throws
Exception
Return values
mixed

validate()

validate token

public validate() : mixed
Tags
throws
Exception
Return values
mixed

applyPolicyModifierAdd()

private applyPolicyModifierAdd(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierDefault()

private applyPolicyModifierDefault(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierEssential()

private applyPolicyModifierEssential(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierOneOf()

private applyPolicyModifierOneOf(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierSubsetOf()

private applyPolicyModifierSubsetOf(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierSupersetOf()

private applyPolicyModifierSupersetOf(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

applyPolicyModifierValue()

private applyPolicyModifierValue(mixed $entity_type, mixed $claim, mixed $policy) : mixed
Parameters
$entity_type : mixed
$claim : mixed
$policy : mixed
Return values
mixed

Search results