core\oauth2\discovery\base_definition Class Reference

Inheritance diagram for core\oauth2\discovery\base_definition:

Static Public Member Functions
static	create_endpoints (issuer $issuer)
	Create endpoints for this issuer.
static	discover_endpoints ($issuer)
	If the discovery endpoint exists for this issuer, try and determine the list of valid endpoints.
static	get_discovery_endpoint_url (issuer $issuer)
	Get the URL for the discovery manifest.

Static Protected Member Functions
static	create_discovery_endpoint (issuer $issuer, string $url)
	Helper method to create discovery endpoint.
static	create_field_mappings (issuer $issuer)
	Process how to map user field information.
static	process_configuration_json (issuer $issuer, stdClass $info)
	Process the discovery information and create endpoints defined with the expected format.
static	register (issuer $issuer)
	Self-register the issuer if the 'registration' endpoint exists and client id and secret aren't defined.

Member Function Documentation

create_discovery_endpoint()

static core\oauth2\discovery\base_definition::create_discovery_endpoint ( issuer $issuer, string $url )

staticprotected

Helper method to create discovery endpoint.

Parameters

issuer	$issuer	Issuer the endpoints should be created for.
string	$url	Discovery endpoint URL.

Return values

endpoint

The endpoint created.

Exceptions

core\invalid_persistent_exception

create_endpoints()

static core\oauth2\discovery\base_definition::create_endpoints ( issuer $issuer )

static

Create endpoints for this issuer.

Parameters

issuer

$issuer

Issuer the endpoints should be created for.

Return values

issuer

Reimplemented in core\oauth2\service\facebook, core\oauth2\service\microsoft, and core\oauth2\service\nextcloud.

create_field_mappings()

static core\oauth2\discovery\base_definition::create_field_mappings ( issuer $issuer )

staticabstractprotected

Process how to map user field information.

Parameters

issuer

$issuer

The OAuth issuer the endpoints should be discovered for.

Return values

void

Reimplemented in core\oauth2\discovery\imsbadgeconnect, core\oauth2\discovery\openidconnect, core\oauth2\service\clever, and core\oauth2\service\imsobv2p1.

discover_endpoints()

static core\oauth2\discovery\base_definition::discover_endpoints ( $issuer )

static

If the discovery endpoint exists for this issuer, try and determine the list of valid endpoints.

Parameters

issuer

$issuer

Return values

int	The number of discovered services.

get_discovery_endpoint_url()

static core\oauth2\discovery\base_definition::get_discovery_endpoint_url ( issuer $issuer )

staticabstract

Get the URL for the discovery manifest.

Parameters

issuer

$issuer

The OAuth issuer the endpoints should be discovered for.

Return values

string

The URL of the discovery file, containing the endpoints.

Reimplemented in core\oauth2\discovery\imsbadgeconnect, and core\oauth2\discovery\openidconnect.

process_configuration_json()

static core\oauth2\discovery\base_definition::process_configuration_json ( issuer $issuer, stdClass $info )

staticabstractprotected

Process the discovery information and create endpoints defined with the expected format.

Parameters

issuer	$issuer	The OAuth issuer the endpoints should be discovered for.
stdClass	$info	The discovery information, with the endpoints to process and create.

Return values

void

Reimplemented in core\oauth2\discovery\imsbadgeconnect, and core\oauth2\discovery\openidconnect.

register()

static core\oauth2\discovery\base_definition::register ( issuer $issuer )

staticabstractprotected

Self-register the issuer if the 'registration' endpoint exists and client id and secret aren't defined.

Parameters

issuer

$issuer

The OAuth issuer to register.

Return values

void

Reimplemented in core\oauth2\discovery\imsbadgeconnect, and core\oauth2\discovery\openidconnect.

---

The documentation for this class was generated from the following file:

• lib/classes/oauth2/discovery/base_definition.php