LTI Tool Provider Library  3.0.2
PHP class library for building LTI Tool Providers
Public Member Functions | Data Fields
ConsumerNonce Class Reference

Class to represent a tool consumer nonce. More...

Public Member Functions

 __construct ($consumer, $value=null)
 Class constructor. More...
 
 load ()
 Load a nonce value from the database. More...
 
 save ()
 Save a nonce value in the database. More...
 
 getConsumer ()
 Get tool consumer. More...
 
 getValue ()
 Get outcome value. More...
 

Data Fields

const MAX_NONCE_AGE = 30
 Maximum age nonce values will be retained for (in minutes). More...
 
 $expires = null
 Date/time when the nonce value expires. More...
 

Detailed Description

Class to represent a tool consumer nonce.

Author
Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org
Copyright
IMS Global Learning Consortium Inc
Date
2016
Version
3.0.2
Licence:
http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 14 of file ConsumerNonce.php.

Constructor & Destructor Documentation

__construct (   $consumer,
  $value = null 
)

Class constructor.

Parameters
ToolConsumer$consumerConsumer object
string$valueNonce value (optional, default is null)

Definition at line 48 of file ConsumerNonce.php.

Member Function Documentation

getConsumer ( )

Get tool consumer.

Returns
ToolConsumer Consumer for this nonce

Definition at line 86 of file ConsumerNonce.php.

getValue ( )

Get outcome value.

Returns
string Outcome value

Definition at line 98 of file ConsumerNonce.php.

load ( )

Load a nonce value from the database.

Returns
boolean True if the nonce value was successfully loaded

Definition at line 62 of file ConsumerNonce.php.

save ( )

Save a nonce value in the database.

Returns
boolean True if the nonce value was successfully saved

Definition at line 74 of file ConsumerNonce.php.

Field Documentation

int $expires = null

Date/time when the nonce value expires.

Definition at line 27 of file ConsumerNonce.php.

const MAX_NONCE_AGE = 30

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

Definition at line 20 of file ConsumerNonce.php.

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