1. class
  2. phpbb
  3. \
  4. auth
  5. \
  6. provider
  7. \
  8. oauth
  9. \
  10. service
  11. \
  12. twitter

twitter

class twitter extends base

Twitter OAuth service

Properties

protected ServiceInterface $service_provider

External OAuth service provider

 from  base
protected config $config
protected request_interface $request

Methods

array
get_auth_scope()

Returns an array of the scopes necessary for auth

from  base
string
get_external_service_class()

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

from  base
get_external_service_provider()

Returns the external library service provider once it has been set

from  base
set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

from  base
__construct(config $config, request_interface $request)

Constructor.

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

Details

in base at line 31
array get_auth_scope()

Returns an array of the scopes necessary for auth

Return Value

array

An array of the required scopes

in base at line 39
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

in base at line 47
get_external_service_provider()

Returns the external library service provider once it has been set

in base at line 55
set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

Parameters

ServiceInterface $service_provider

at line 33
__construct(config $config, request_interface $request)

Constructor.

Parameters

config $config

Config object
request_interface $request

Request object

at line 42
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 53
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 98
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