Class SimpleID\Base\ScopeInfoCollectionEvent

`extends`	`BaseEvent`

An event to collect scope information.

Different identity protocols use the concept of scope to limit the extent to which authorisation is provided by the user. This event is used to collect all the possible scopes that this SimpleID installation can provide, as well as human-friendly information on these scopes.

Scope information is categorised into types. Generally each identity protocol would have a separate type assigned. Currently the available types are:

openid for the OpenID 1 and 2 protocols
oauth for OAuth based protocols (including OpenID Connect)

Listeners should use addScopeInfo() to add scope information.

SimpleID\Util\Events\BaseEvent
- SimpleID\Base\ScopeInfoCollectionEvent

Located at core/Base/ScopeInfoCollectionEvent.php

Methods


					
	public

addScopeInfo(string $type, array<string, array<string, mixed>> $scopes): void

Add scope information.

The scope information is arranged as an array, with the key being the protocol specific name of the scope, and the value being an array of protocol specific settings. Commonly used settings include:

description - a description of the scope presented to the user in the consent page
weight - used for sorting multiple scopes when presented to the user
claims - in OpenID Connect, the claims available in the userinfo endpoint if granted

Parameters

`$type`	the type of the scope information
`$scopes`	the scope information


					
	public

getScopesForType(string $type): array<string>

Returns scopes for a particular type.

Parameters

$type

the type of scopes to return

Returns

an array of scopes, or an empty array if no scope information is found for this particular type


					
	public

getScopeInfoForType(string $type): array<string, mixed>

Returns scope informations for a particular type.

Parameters

$type

the type of scopes to return

Returns

an array containing scope information for the specified type, or an empty array if no scope information is found for this particular type


					
	public

getAllScopeInfo(): array<string, array<string, mixed>>

Returns the entire registry of scope information.

The array returned is organised by type, with the name of the type as the key, and the scope information (equivalent to calling getScopesForType() ) as the value.

Returns

the scope information

Properties
`protected`	`array<string, array<string, mixed>>`	`$scope_info = []`	#

Namespaces

Classes

Class SimpleID\Base\ScopeInfoCollectionEvent

Parameters

Parameters

Returns

Parameters

Returns

Returns