Controller
class Controller extends GenericOauth2TypeController (View source)
Traits
Trait LoggerAwareTrait A trait used with LoggerAwareInterface
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 | from GenericOauthTypeController | ||
| protected | $firstName | from GenericOauthTypeController | |
| protected | $lastName | from GenericOauthTypeController | |
| protected | $fullName | from GenericOauthTypeController | |
| protected BindingService|null | $bindingService | from GenericOauthTypeController | |
| protected ServiceFactory | $factory | ||
| protected ResolverManagerInterface | $urlResolver | ||
| protected Repository | $config |
Methods
Get the logger channel expected by this LoggerAwareTrait implementation The user is expected to declare this method and return a valid channel name.
Build and return this authentication type's icon HTML.
No description
No description
Method used to verify the user and log them in.
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).
Controller method for form This method is called just before form.php is rendered, use it to set data for that template.
Get the service object associated with this authentication type This method uses the oauth/factory/service object to create our service if one is not set.
Determine whether this type supports automatically registering users This method grabs this configuration from the auth config group.
Get the ID of the group to enter upon registration This method grabs the registration group ID out of the auth config group.
Save data for this authentication type This method is called when the type_form.php submits. It stores client details and configuration for connecting.
Controller method for type_form This method is called just before rendering type_form.php, use it to set data for that template.
Controller method for the hook template This method is called before hook.php is rendered, use it to set data for that template.
Controller method for the hooked template This method gets called before hooked.php is rendered, use it to set data for that template.
Method for setting general data for all views.
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.
getAuthenticationTypeIconHTML()
Build and return this authentication type's icon HTML.
view()
No description
__construct(AuthenticationType $type, ServiceFactory $factory, ResolverManagerInterface $urlResolver, Repository $config)
No description
getAuthenticationType()
No description
completeAuthentication(User $u)
tasks to finalize authentication, call on login events etc.
string
getHandle()
No description
array
getAdditionalRequestParameters()
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.
Returning user will cause finishAuthentication to run, otherwise it's expected that the subclass manage completion.
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
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).
handle_register($token = null)
No description
ExtractorInterface
getExtractor($new = false)
No description
form()
Controller method for form This method is called just before form.php is rendered, use it to set data for that template.
AbstractService
getService()
Get the service object associated with this authentication type This method uses the oauth/factory/service object to create our service if one is not set.
protected
isValid()
No description
int|bool
getBoundUserID($binding)
No description
bool
supportsRegistration()
Determine whether this type supports automatically registering users This method grabs this configuration from the auth config group.
bool
registrationGroupID()
Get the ID of the group to enter upon registration This method grabs the registration group ID out of the auth config group.
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
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_authentication_attempt()
No description
handle_authentication_callback()
No description
handle_attach_attempt()
No description
handle_attach_callback()
No description
handle_detach_attempt()
No description
protected BindingService
getBindingService()
No description
deauthenticate(User $u)
Method used to clean up.
This method must be defined, if it isn't needed, leave it blank.
bool
isAuthenticated(User $u)
Test user authentication status.
saveAuthenticationType(array|Traversable $args)
Save data for this authentication type This method is called when the type_form.php submits. It stores client details and configuration for connecting.
edit()
Controller method for type_form This method is called just before rendering type_form.php, use it to set data for that template.
hook()
Controller method for the hook template This method is called before hook.php is rendered, use it to set data for that template.
hooked()
Controller method for the hooked template This method gets called before hooked.php is rendered, use it to set data for that template.
private
setData()
Method for setting general data for all views.