interface service_interface

OAuth service interface

Methods

array
get_auth_scope()

Returns an array of the scopes necessary for auth

array
get_service_credentials()

Returns an array containing the service credentials belonging to requested service.

string
perform_auth_login()

Returns the results of the authentication in json format

string
perform_token_auth()

Returns the results of the authentication in json format Use this function when the user already has an access token

string
get_external_service_class()

Returns the class of external library service provider that has to be used.

get_external_service_provider()

Returns the external library service provider once it has been set

set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

Details

at line 26
array get_auth_scope()

Returns an array of the scopes necessary for auth

Return Value

array

An array of the required scopes

at line 39
array get_service_credentials()

Returns an array containing the service credentials belonging to requested service.

Return Value

array

An array containing the 'key' and the 'secret' of the service in the form: array( 'key' => string 'secret' => string )

at line 48
string perform_auth_login()

Returns the results of the authentication in json format

Return Value

string

The unique identifier returned by the service provider that is used to authenticate the user with phpBB.

Exceptions

exception

at line 58
string perform_token_auth()

Returns the results of the authentication in json format Use this function when the user already has an access token

Return Value

string

The unique identifier returned by the service provider that is used to authenticate the user with phpBB.

Exceptions

exception

at line 72
string get_external_service_class()

Returns the class of external library service provider that has to be used.

Return Value

string

If the string is a class, it will register the provided string as a class, which later will be generated as the OAuth external service provider. If the string is not a class, it will use this string, trying to generate a service for the version 2 and 1 respectively: \OAuth\OAuth2\Service\ If the string is empty, it will default to OAuth's standard service classes, trying to generate a service for the version 2 and 1 respectively: \OAuth\OAuth2\Service\Facebook

at line 77
get_external_service_provider()

Returns the external library service provider once it has been set

at line 84
set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

Parameters

ServiceInterface $service_provider