PlatformNonce Class Reference

Class to represent a platform nonce. More...

Inheritance diagram for PlatformNonce:

Public Member Functions
	__construct ($platform, $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	getValue ()
	Get outcome value.

Public Attributes
const	MAX_NONCE_AGE = 30
	Maximum age nonce values will be retained for (in minutes).
int null	$expires = null
	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()

__construct	(		$platform,
			$value = null
	)

Class constructor.

Parameters

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

Reimplemented in ConsumerNonce.

Member Function Documentation

delete()

bool delete

(

)

Delete a nonce value in the database.

Returns

bool True if the nonce value was successfully deleted

getPlatform()

Platform getPlatform

(

)

Get platform.

Returns

Platform Platform for this nonce

Referenced by ConsumerNonce\getConsumer().

getValue()

string getValue

(

)

Get outcome value.

Returns

string Outcome value

load()

bool load

(

)

Load a nonce value from the database.

Returns

bool True if the nonce value was successfully loaded

save()

bool save

(

)

Save a nonce value in the database.

Returns

bool True if the nonce value was successfully saved

Member Data Documentation

$expires

int null $expires = null

Timestamp for when the nonce value expires.

$expires

$maximumLength

int $maximumLength = 50

static

Maximum length which can be stored.

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

$maximumLength

---

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

• PlatformNonce.php