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...

Public Attributes
	$_callable_get_user = 'get_user'
	DO NOT USE. More...
	$_callable_elgg_set_cookie = 'elgg_set_cookie'
	DO NOT USE. More...
	$_callable_sleep = 'sleep'
	DO NOT USE. More...

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...
	removeAllHashes (\ElggUser $user)
	Remove all the hashes associated with a user. More...
	hashToken ($token)
	Create a hash from the token. More...
	setCookie ($token)
	Store the token in the client cookie (or remove the cookie) More...
	setSession ($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 26 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	$db	The DB service
\ElggSession	$session	The Elgg session
\ElggCrypto	$crypto	The cryptography service
array	$cookie_config	The persistent login cookie settings
string	$cookie_token	The token from the request cookie
int	$time	The current time

Definition at line 38 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 110 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 310 of file PersistentLoginService.php.

Elgg\PersistentLoginService::getUserFromHash

(

$hash

)

Find a user with the given hash.

Parameters

string

$hash

The hashed token

Returns

|null

Definition at line 156 of file PersistentLoginService.php.

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

protected

Swallow a schema not upgraded exception, otherwise rethrow it.

Parameters

\DatabaseException	$exception	The exception to handle
string	$default	The value to return if the table doesn't exist yet

Returns

mixed

Exceptions

Definition at line 230 of file PersistentLoginService.php.

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

Handle a password change.

Parameters

\ElggUser	$subject	The user whose password changed
\ElggUser	$modifier	The user who changed the password

Returns

void

Definition at line 95 of file PersistentLoginService.php.

Elgg\PersistentLoginService::hashToken (   $token )

protected

Create a hash from the token.

Parameters

string

$token

The token to hash

Returns

string

Definition at line 262 of file PersistentLoginService.php.

Elgg\PersistentLoginService::isLegacyToken (   $token )

protected

Is the given token a legacy MD5 hash?

Parameters

string

$token

The token to analyze

Returns

bool

Definition at line 321 of file PersistentLoginService.php.

Elgg\PersistentLoginService::makeLoginPersistent

(

\ElggUser

$user

)

Make the user's login persistent.

Parameters

\ElggUser

$user

The user who logged in

Returns

void

Definition at line 63 of file PersistentLoginService.php.

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

protected

Remove all the hashes associated with a user.

Parameters

\ElggUser

$user

The user for whom we're removing hashes

Returns

void

Definition at line 246 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removeHash (   $hash )

protected

Remove a hash from the DB.

Parameters

string

$hash

The hashed token to remove (unused before 1.9)

Returns

void

Definition at line 209 of file PersistentLoginService.php.

Elgg\PersistentLoginService::removePersistentLogin

(

)

Remove the persisted login token from client and server.

Returns

void

Definition at line 77 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_user

The logged in user

Returns

void

Definition at line 139 of file PersistentLoginService.php.

Elgg\PersistentLoginService::setCookie (   $token )

protected

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

Parameters

string

$token

Empty string to remove cookie

Returns

void

Definition at line 275 of file PersistentLoginService.php.

Elgg\PersistentLoginService::setSession (   $token )

protected

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

Parameters

string

$token

The token to store in session. Empty string to remove.

Returns

void

Definition at line 294 of file PersistentLoginService.php.

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

protected

Store a hash in the DB.

Parameters

\ElggUser	$user	The user for whom we're storing the hash
string	$hash	The hashed token

Returns

void

Definition at line 184 of file PersistentLoginService.php.

Member Data Documentation

Elgg\PersistentLoginService::$_callable_elgg_set_cookie = 'elgg_set_cookie'

DO NOT USE.

For unit test mocking private

Definition at line 370 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$_callable_get_user = 'get_user'

DO NOT USE.

For unit test mocking private

Definition at line 364 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$_callable_sleep = 'sleep'

DO NOT USE.

For unit test mocking private

Definition at line 376 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$cookie_config

protected

Definition at line 338 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$cookie_token

protected

Definition at line 343 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$crypto

protected

Definition at line 353 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$db

protected

Definition at line 328 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$session

protected

Definition at line 348 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$table

protected

Definition at line 333 of file PersistentLoginService.php.

Elgg\PersistentLoginService::$time

protected

Definition at line 358 of file PersistentLoginService.php.

---

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

• engine/classes/Elgg/PersistentLoginService.php