Elgg  Version 3.0
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Elgg\PersistentLoginService Class Reference

Public Member Functions

 __construct (Database $db,\ElggSession $session,\ElggCrypto $crypto, array $cookie_config, $cookie_token, $time=null)
 Constructor. More...
 
 makeLoginPersistent (\ElggUser $user)
 Make the user's login persistent. More...
 
 removePersistentLogin ()
 Remove the persisted login token from client and server. More...
 
 handlePasswordChange (\ElggUser $subject,\ElggUser $modifier=null)
 Handle a password change. More...
 
 bootSession ()
 Boot the persistent login session, possibly returning the user who should be silently logged in. More...
 
 replaceLegacyToken (\ElggUser $logged_in_user)
 Replace the user's token if it's a legacy hexadecimal token. More...
 
 getUserFromHash ($hash)
 Find a user with the given hash. More...
 
 updateTokenUsage (\ElggUser $user)
 Update the timestamp linked to a persistent cookie code, this indicates that the code was used recently. More...
 
 removeExpiredTokens ($time)
 Remove all persistent codes from the database which have expired based on the cookie config. More...
 
 removeAllHashes (\ElggUser $user)
 Remove all the hashes associated with a user. More...
 

Public Attributes

 $_callable_get_user = 'get_user'
 
 $_callable_elgg_set_cookie = 'elgg_set_cookie'
 
 $_callable_sleep = 'sleep'
 

Protected Member Functions

 storeHash (\ElggUser $user, $hash)
 Store a hash in the DB. More...
 
 removeHash ($hash)
 Remove a hash from the DB. More...
 
 handleDbException (\DatabaseException $exception, $default=null)
 Swallow a schema not upgraded exception, otherwise rethrow it. More...
 
 hashToken ($token)
 Create a hash from the token. More...
 
 setCookie ($token)
 Store the token in the client cookie (or remove the cookie) More...
 
 setSessionToken ($token)
 Store the token in the session (or remove it from the session) More...
 
 generateToken ()
 Generate a random token (base 64 URL) More...
 
 isLegacyToken ($token)
 Is the given token a legacy MD5 hash? More...
 

Protected Attributes

 $db
 
 $table
 
 $cookie_config
 
 $cookie_token
 
 $session
 
 $crypto
 
 $time
 

Detailed Description

Definition at line 28 of file PersistentLoginService.php.

Constructor & Destructor Documentation

Elgg\PersistentLoginService::__construct ( Database  $db,
\ElggSession  $session,
\ElggCrypto  $crypto,
array  $cookie_config,
  $cookie_token,
  $time = null 
)

Constructor.

Parameters
Database$dbThe DB service
\ElggSession$sessionThe Elgg session
\ElggCrypto$cryptoThe cryptography service
array$cookie_configThe persistent login cookie settings
string$cookie_tokenThe token from the request cookie
int$timeThe current time

Definition at line 40 of file PersistentLoginService.php.

Member Function Documentation

Elgg\PersistentLoginService::bootSession ( )

Boot the persistent login session, possibly returning the user who should be silently logged in.

Returns
|null

Definition at line 112 of file PersistentLoginService.php.

Elgg\PersistentLoginService::generateToken ( )
protected

Generate a random token (base 64 URL)

The first char is always "z" to indicate the value has more entropy than the previously generated ones.

Returns
string

Definition at line 391 of file PersistentLoginService.php.

Elgg\PersistentLoginService::getUserFromHash (   $hash)

Find a user with the given hash.

Parameters
string$hashThe hashed token
Returns
|null

Definition at line 158 of file PersistentLoginService.php.

Elgg\PersistentLoginService::handleDbException ( \DatabaseException  $exception,
  $default = null 
)
protected

Swallow a schema not upgraded exception, otherwise rethrow it.

Parameters
\DatabaseException$exceptionThe exception to handle
string$defaultThe value to return if the table doesn't exist yet
Returns
mixed
Exceptions

Definition at line 307 of file PersistentLoginService.php.

Elgg\PersistentLoginService::handlePasswordChange ( \ElggUser  $subject,
\ElggUser  $modifier = null 
)

Handle a password change.

Parameters
\ElggUser$subjectThe user whose password changed
\ElggUser$modifierThe user who changed the password
Returns
void

Definition at line 97 of file PersistentLoginService.php.

Elgg\PersistentLoginService::hashToken (   $token)
protected

Create a hash from the token.

Parameters
string$tokenThe token to hash
Returns
string

Definition at line 343 of file PersistentLoginService.php.

Elgg\PersistentLoginService::isLegacyToken (   $token)
protected

Is the given token a legacy MD5 hash?

Parameters
string$tokenThe token to analyze
Returns
bool

Definition at line 402 of file PersistentLoginService.php.

Elgg\PersistentLoginService::makeLoginPersistent ( \ElggUser  $user)

Make the user's login persistent.

Parameters
\ElggUser$userThe user who logged in
Returns
void

Definition at line 65 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removeAllHashes ( \ElggUser  $user)

Remove all the hashes associated with a user.

Parameters
\ElggUser$userThe user for whom we're removing hashes
Returns
void

Definition at line 323 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removeExpiredTokens (   $time)

Remove all persistent codes from the database which have expired based on the cookie config.

Parameters
int$timethe base timestamp to use
Returns
bool

Definition at line 226 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removeHash (   $hash)
protected

Remove a hash from the DB.

Parameters
string$hashThe hashed token to remove (unused before 1.9)
Returns
void

Definition at line 284 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removePersistentLogin ( )

Remove the persisted login token from client and server.

Returns
void

Definition at line 79 of file PersistentLoginService.php.

Elgg\PersistentLoginService::replaceLegacyToken ( \ElggUser  $logged_in_user)

Replace the user's token if it's a legacy hexadecimal token.

Parameters
\ElggUser$logged_in_userThe logged in user
Returns
void

Definition at line 141 of file PersistentLoginService.php.

Elgg\PersistentLoginService::setCookie (   $token)
protected

Store the token in the client cookie (or remove the cookie)

Parameters
string$tokenEmpty string to remove cookie
Returns
void

Definition at line 356 of file PersistentLoginService.php.

Elgg\PersistentLoginService::setSessionToken (   $token)
protected

Store the token in the session (or remove it from the session)

Parameters
string$tokenThe token to store in session. Empty string to remove.
Returns
void

Definition at line 375 of file PersistentLoginService.php.

Elgg\PersistentLoginService::storeHash ( \ElggUser  $user,
  $hash 
)
protected

Store a hash in the DB.

Parameters
\ElggUser$userThe user for whom we're storing the hash
string$hashThe hashed token
Returns
void

Definition at line 259 of file PersistentLoginService.php.

Elgg\PersistentLoginService::updateTokenUsage ( \ElggUser  $user)

Update the timestamp linked to a persistent cookie code, this indicates that the code was used recently.

Parameters
\ElggUser$userthe user to update the cookie code for
Returns
bool|null

Definition at line 190 of file PersistentLoginService.php.

Member Data Documentation

Elgg\PersistentLoginService::$_callable_elgg_set_cookie = 'elgg_set_cookie'

Definition at line 451 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$_callable_get_user = 'get_user'

Definition at line 445 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$_callable_sleep = 'sleep'

Definition at line 457 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$cookie_config
protected

Definition at line 419 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$cookie_token
protected

Definition at line 424 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$crypto
protected

Definition at line 434 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$db
protected

Definition at line 409 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$session
protected

Definition at line 429 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$table
protected

Definition at line 414 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$time
protected

Definition at line 439 of file PersistentLoginService.php.


The documentation for this class was generated from the following file: