abstract class GenericOauthTypeController extends AuthenticationTypeController (View source)

Properties

protected $authenticationType from AuthenticationTypeController
$apiMethods
protected AbstractService $service
protected Extractor $extractor
protected TokenInterface $token

Methods

view()

No description

__construct(AuthenticationType $type = null)

No description

completeAuthentication(User $u)

tasks to finalize authentication, call on login events etc.

string
getHandle()

No description

array
handle_error($error = false)

No description

showError($error = null)

No description

markError($error)

No description

handle_success($message = false)

No description

showSuccess($message = null)

No description

markSuccess($message)

No description

User|null
authenticate()

Empty because we don't use the authenticate entry point.

string
buildHash(User $u)

Create a cookie hash to identify the user indefinitely.

bool
verifyHash(User $u, string $hash)

Hash authentication disabled for oauth.

TokenInterface
getToken()

No description

setToken(TokenInterface $token)

No description

null|User
attemptAuthentication()

No description

ExtractorInterface
getExtractor($new = false)

No description

AbstractService
getService()

No description

isValid()

No description

bool|string
getBoundUserID($binding)

No description

bool
supportsRegistration()

Whether or not we will attempt to register the user.

bool
registrationGroupID()

Whether or not we will attempt to register the user.

createUser()

No description

supportsEmail()

No description

supportsUniqueId()

No description

supportsVerifiedEmail()

No description

isEmailVerified()

No description

getEmail()

No description

supportsFullName()

No description

supportsFirstName()

No description

supportsLastName()

No description

getFirstName()

No description

getLastName()

No description

getFullName()

No description

supportsUsername()

No description

getUsername()

No description

int|null
bindUser(User $user, $binding)

No description

int|null
bindUserID($user_id, $binding)

No description

getUniqueId()

No description

handle_attach_attempt()

No description

handle_attach_callback()

No description

Details

abstract getAuthenticationTypeIconHTML()

abstract view()

__construct(AuthenticationType $type = null)

Parameters

AuthenticationType $type This type may be null only for access points that do not rely on the type.

getAuthenticationType()

completeAuthentication(User $u)

tasks to finalize authentication, call on login events etc.

Parameters

User $u

abstract string getHandle()

Return Value

string

array getAdditionalRequestParameters()

Return Value

array

handle_error($error = false)

Parameters

$error

showError($error = null)

Parameters

$error

markError($error)

Parameters

$error

handle_success($message = false)

Parameters

$message

showSuccess($message = null)

Parameters

$message

markSuccess($message)

Parameters

$message

User|null authenticate()

Empty because we don't use the authenticate entry point.

Return Value

User|null

string buildHash(User $u)

Create a cookie hash to identify the user indefinitely.

Parameters

User $u

Return Value

string Unique hash to be used to verify the users identity

bool verifyHash(User $u, string $hash)

Hash authentication disabled for oauth.

Parameters

User $u User object requesting verification.
string $hash

Return Value

bool returns true if the hash is valid, false if not

TokenInterface getToken()

Return Value

TokenInterface

setToken(TokenInterface $token)

Parameters

TokenInterface $token

protected null|User attemptAuthentication()

Return Value

null|User

Exceptions

Exception

ExtractorInterface getExtractor($new = false)

Parameters

$new

Return Value

ExtractorInterface

Exceptions

UndefinedExtractorException

abstract AbstractService getService()

Return Value

AbstractService

protected isValid()

bool|string getBoundUserID($binding)

Parameters

$binding

Return Value

bool|string

Exceptions

DBALException

abstract bool supportsRegistration()

Whether or not we will attempt to register the user.

Return Value

bool

abstract bool registrationGroupID()

Whether or not we will attempt to register the user.

Return Value

bool

protected createUser()

supportsEmail()

supportsUniqueId()

supportsVerifiedEmail()

isEmailVerified()

getEmail()

supportsFullName()

supportsFirstName()

supportsLastName()

getFirstName()

getLastName()

getFullName()

supportsUsername()

getUsername()

int|null bindUser(User $user, $binding)

Parameters

User $user
$binding

Return Value

int|null

int|null bindUserID($user_id, $binding)

Parameters

$user_id
$binding

Return Value

int|null

getUniqueId()

abstract handle_authentication_attempt()

abstract handle_authentication_callback()

abstract handle_attach_attempt()

abstract handle_attach_callback()