\Pivot\AuthenticationAuthenticationManager

Authentication Manager

Summary

Methods
Properties
Constants
__construct()
login()
authenticate()
refreshToken()
setPivotConfig()
getPossibleIdentity()
getIdentity()
getTicket()
getSubscription()
setAdaptor()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
makeAuthenticated()
generateTicket()
$pivotConfig
$adaptor
$cacheManager
N/A

Properties

$cacheManager

$cacheManager : \Pivot\Core\Cache\CacheManager

Cache manager Used to reset the cache on a refresh req

Type

\Pivot\Core\Cache\CacheManager

Methods

login()

login(array  $cred) : boolean

Login functionality

Parameters

array $cred

credentials

Returns

boolean

authenticate()

authenticate(array  $cred) : boolean

Checks that the credentials are valid for the identity and injected adaptor

Parameters

array $cred

Returns

boolean

refreshToken()

refreshToken() : \Pivot\Authentication\Identity

Refresh the toekn in the identity.

Because this is the tie to other things using this cache we must refresh the cache key as well.

Returns

\Pivot\Authentication\Identity —

$identity

setPivotConfig()

setPivotConfig(\Pivot\Core\Configuration\PivotConfig  $pivotConfig) : self

Set the value of Pivot Config

Parameters

\Pivot\Core\Configuration\PivotConfig $pivotConfig

Returns

self

getPossibleIdentity()

getPossibleIdentity() : \Pivot\Authentication\possibleIdentity

Gets the value of Possible Identity

Returns

\Pivot\Authentication\possibleIdentity

getIdentity()

getIdentity() : \Pivot\Authentication\possibleIdentity

Gets the value of Possible Identity

Returns

\Pivot\Authentication\possibleIdentity

getTicket()

getTicket() : \Pivot\Authentication\Config

Gets the Login Ticket

Returns

\Pivot\Authentication\Config —

$ticket

getSubscription()

getSubscription() : \Pivot\Authentication\Config

Gets the Subscription

Returns

\Pivot\Authentication\Config —

$subscription

makeAuthenticated()

makeAuthenticated() : void

Convert the identity into a authenticated identity

generateTicket()

generateTicket(string  $type = 'Bearer') : \Pivot\Authentication\ticket

Generate the login ticket

Parameters

string $type

Type of ticket to generate

Returns

\Pivot\Authentication\ticket