class Controller extends GenericOauth2TypeController (View source)

Properties

protected $authenticationType from AuthenticationTypeController
protected $app from AuthenticationTypeController
$apiMethods from GenericOauthTypeController
protected AbstractService $service from GenericOauth2TypeController
protected Extractor $extractor from GenericOauthTypeController
protected TokenInterface $token from GenericOauthTypeController
protected $username from GenericOauthTypeController
protected $email from GenericOauthTypeController
protected $firstName from GenericOauthTypeController
protected $lastName from GenericOauthTypeController
protected $fullName from GenericOauthTypeController

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

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()

Method used to verify the user and log them in.

string
buildHash(User $u)

Create a cookie hash to identify the user indefinitely.

bool
verifyHash(User $u, string $hash)

Verify cookie hash to identify user.

TokenInterface
getToken()

No description

setToken(TokenInterface $token)

No description

null|User
attemptAuthentication()

We now check if the user allows access to email address as twitter does not provide this and users can deny access to on facebook).

handle_register($token = null)

No description

ExtractorInterface
getExtractor($new = false)

No description

form()

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

getEmail()

No description

getFirstName()

No description

getLastName()

No description

getFullName()

No description

getUsername()

No description

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

No description

int|null
bindUserID($user_id, $binding)

No description

string|null
getBindingForUser(User|UserInfo|User|int $user)

Get the binding associated to a specific user.

getUniqueId()

No description

handle_detach_attempt()

No description

deauthenticate(User $u)

Method used to clean up.

bool
isAuthenticated(User $u)

Test user authentication status.

saveAuthenticationType($args)

No description

edit()

No description

Details

getAuthenticationTypeIconHTML()

__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

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()

Method used to verify the user and log them in.

Returning user will cause finishAuthentication to run, otherwise it's expected that the subclass manage completion.

Return Value

User|null

Exceptions

AuthenticationTypeFailureException

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)

Verify cookie hash to identify user.

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()

We now check if the user allows access to email address as twitter does not provide this and users can deny access to on facebook).

Return Value

null|User

Exceptions

Exception

handle_register($token = null)

Parameters

$token

ExtractorInterface getExtractor($new = false)

Parameters

$new

Return Value

ExtractorInterface

Exceptions

UndefinedExtractorException

AbstractService getService()

Return Value

AbstractService

isValid()

bool|string getBoundUserID($binding)

Parameters

$binding

Return Value

bool|string

Exceptions

DBALException

bool supportsRegistration()

Whether or not we will attempt to register the user.

Return Value

bool

bool registrationGroupID()

Whether or not we will attempt to register the user.

Return Value

bool

protected createUser()

supportsEmail()

supportsUniqueId()

supportsVerifiedEmail()

isEmailVerified()

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

string|null getBindingForUser(User|UserInfo|User|int $user)

Get the binding associated to a specific user.

Parameters

User|UserInfo|User|int $user

Return Value

string|null

getUniqueId()

handle_authentication_attempt()

handle_authentication_callback()

handle_attach_attempt()

handle_attach_callback()

handle_detach_attempt()

deauthenticate(User $u)

Method used to clean up.

This method must be defined, if it isn't needed, leave it blank.

Parameters

User $u

bool isAuthenticated(User $u)

Test user authentication status.

Parameters

User $u

Return Value

bool Returns true if user is authenticated, false if not

saveAuthenticationType($args)

Parameters

$args

edit()