abstract class GenericOauthTypeController extends AuthenticationTypeController (View source)

Traits

Trait LoggerAwareTrait A trait used with LoggerAwareInterface

LoggerAwareTrait

Properties

protected $authenticationType from  AuthenticationTypeController
protected $app from  AuthenticationTypeController
$apiMethods
protected AbstractService $service
protected Extractor $extractor
protected TokenInterface $token
protected $username
protected $email
protected $firstName
protected $lastName
protected $fullName
protected BindingService|null $bindingService

Methods

string
getLoggerChannel()

Get the logger channel expected by this LoggerAwareTrait implementation The user is expected to declare this method and return a valid channel name.

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

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

int|bool
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

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

Get the binding associated to a specific user.

getUniqueId()

No description

handle_attach_attempt()

No description

handle_attach_callback()

No description

handle_detach_attempt()

No description

Details

abstract string getLoggerChannel()

Get the logger channel expected by this LoggerAwareTrait implementation The user is expected to declare this method and return a valid channel name.

Return Value

string

One of \Concrete\Core\Logging\Channels::CHANNEL_*

abstract getAuthenticationTypeIconHTML()

No description

abstract view()

No description

__construct(AuthenticationType $type = null)

No description

Parameters

AuthenticationType $type

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

getAuthenticationType()

No description

completeAuthentication(User $u)

tasks to finalize authentication, call on login events etc.

Parameters

User $u

abstract string getHandle()

No description

Return Value

string

array getAdditionalRequestParameters()

No description

Return Value

array

handle_error($error = false)

No description

Parameters

$error

showError($error = null)

No description

Parameters

$error

markError($error)

No description

Parameters

$error

handle_success($message = false)

No description

Parameters

$message

showSuccess($message = null)

No description

Parameters

$message

markSuccess($message)

No description

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

No description

Return Value

TokenInterface

setToken(TokenInterface $token)

No description

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)

No description

Parameters

$token

ExtractorInterface getExtractor($new = false)

No description

Parameters

$new

Return Value

ExtractorInterface

Exceptions

UndefinedExtractorException

form()

No description

abstract AbstractService getService()

No description

Return Value

AbstractService

protected isValid()

No description

int|bool getBoundUserID($binding)

No description

Parameters

$binding

Return Value

int|bool

False if no user id is bound

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

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

Parameters

User $user
$binding

Return Value

int|null

int|null bindUserID($user_id, $binding)

No description

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

No description

abstract handle_authentication_attempt()

No description

abstract handle_authentication_callback()

No description

abstract handle_attach_attempt()

No description

abstract handle_attach_callback()

No description

handle_detach_attempt()

No description

protected BindingService getBindingService()

No description

Return Value

BindingService