ceLTIc\LTI\PlatformNonce Class Reference

Class to represent a platform nonce. More...

Public Member Functions
	__construct (Platform $platform, ?string $value=null)
	Class constructor.
bool	load ()
	Load a nonce value from the database.
bool	save ()
	Save a nonce value in the database.
bool	delete ()
	Delete a nonce value in the database.
Platform	getPlatform ()
	Get platform.
string null	getValue ()
	Get nonce value.

Public Attributes
const	MAX_NONCE_AGE = 30
	Maximum age nonce values will be retained for (in minutes).
int	$expires
	Timestamp for when the nonce value expires.

Static Public Attributes
static int	$maximumLength = 50
	Maximum length which can be stored.

Detailed Description

Class to represent a platform nonce.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\PlatformNonce::__construct	(	Platform	$platform,
		?string	$value = null )

Class constructor.

Parameters

Platform	$platform	Platform object
string | null	$value	Nonce value (optional, default is null)

Member Function Documentation

delete()

bool ceLTIc\LTI\PlatformNonce::delete

(

)

Delete a nonce value in the database.

Returns

bool True if the nonce value was successfully deleted

getPlatform()

Platform ceLTIc\LTI\PlatformNonce::getPlatform

(

)

Get platform.

Returns

Platform Platform for this nonce

Referenced by ceLTIc\LTI\DataConnector\DataConnector\deleteResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_mysqli\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_oci8\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_pdo\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_pgsql\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_sql\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_mysqli\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_oci8\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_pdo\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_pgsql\loadPlatformNonce(), and ceLTIc\LTI\DataConnector\DataConnector_sql\loadPlatformNonce().

getValue()

string null ceLTIc\LTI\PlatformNonce::getValue

(

)

Get nonce value.

Returns

string|null Nonce value

Referenced by ceLTIc\LTI\DataConnector\DataConnector\deleteResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_mysqli\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_oci8\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_pdo\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_pgsql\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector_sql\getSharesResourceLink(), ceLTIc\LTI\DataConnector\DataConnector\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_mysqli\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_oci8\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_pdo\loadPlatformNonce(), ceLTIc\LTI\DataConnector\DataConnector_pgsql\loadPlatformNonce(), and ceLTIc\LTI\DataConnector\DataConnector_sql\loadPlatformNonce().

load()

bool ceLTIc\LTI\PlatformNonce::load

(

)

Load a nonce value from the database.

Returns

bool True if the nonce value was successfully loaded

save()

bool ceLTIc\LTI\PlatformNonce::save

(

)

Save a nonce value in the database.

Returns

bool True if the nonce value was successfully saved

Member Data Documentation

$expires

int ceLTIc\LTI\PlatformNonce::$expires

Timestamp for when the nonce value expires.

$maximumLength

int ceLTIc\LTI\PlatformNonce::$maximumLength = 50

static

Maximum length which can be stored.

Characters are removed from the beginning of the value when too long.

MAX_NONCE_AGE

const ceLTIc\LTI\PlatformNonce::MAX_NONCE_AGE = 30

Maximum age nonce values will be retained for (in minutes).