Public Member Functions
	__construct (Datalist $datalist)
	Constructor. More...

	setTestingSecret ($secret)
	Set a secret to be used in testing. More...

	init ()
	Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL). More...

	get ($raw=false)
	Returns the site secret. More...

	getStrength ()
	Get the strength of the site secret. More...

Detailed Description

Definition at line 22 of file SiteSecret.php.

Constructor & Destructor Documentation

Elgg\Database\SiteSecret::__construct ( Datalist $datalist )

Constructor.

Parameters

Datalist $datalist Datalist table

Definition at line 34 of file SiteSecret.php.

Elgg\Database\SiteSecret::get ( $raw = false )

Returns the site secret.

Used to generate difficult to guess hashes for sessions and action tokens.

Parameters

bool $raw If true, a binary key will be returned

Definition at line 83 of file SiteSecret.php.

Elgg\Database\SiteSecret::getStrength ( )

Get the strength of the site secret.

If "weak" or "moderate" is returned, this assumes we're running on the same system that created the key.

Definition at line 121 of file SiteSecret.php.

Elgg\Database\SiteSecret::init ( )

Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL).

Used during installation and saves as a datalist.

Note: Old secrets were hex encoded.

Definition at line 63 of file SiteSecret.php.

Elgg\Database\SiteSecret::setTestingSecret ( $secret )

Set a secret to be used in testing.

Parameters

string $secret Testing site secret. 32 alphanums starting with "z"

Definition at line 49 of file SiteSecret.php.

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