Class to represent a platform nonce. More...

Collaboration diagram for ILIAS\LTI\ToolProvider\PlatformNonce:

Public Member Functions
	__construct (Platform $platform, string $value=null)
	Class constructor. More...

	load ()
	Load a nonce value from the database. More...

	save ()
	Save a nonce value in the database. More...

	delete ()
	Delete a nonce value in the database. More...

	getPlatform ()
	Get platform. More...

	getValue ()
	Get outcome value. More...

Data Fields
const	MAX_NONCE_AGE = 30
	Maximum age nonce values will be retained for (in minutes). More...

int	$expires = null
	Timestamp for when the nonce value expires. More...

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

Private Attributes
Platform	$platform = null
	Platform to which this nonce applies. More...

string	$value = null
	Nonce value. More...

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 @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 28 of file PlatformNonce.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LTI\ToolProvider\PlatformNonce::__construct	(	Platform	$platform,
		string	$value = `null`
	)

Class constructor.

Parameters

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

Definition at line 70 of file PlatformNonce.php.

    {
        $this->platform = $platform;
        $this->value = substr($value, -self::$maximumLength);
        $this->expires = time() + (self::MAX_NONCE_AGE * 60);
    }

References ILIAS\LTI\ToolProvider\PlatformNonce\$platform, and ILIAS\LTI\ToolProvider\PlatformNonce\$value.

Member Function Documentation

◆ delete()

ILIAS\LTI\ToolProvider\PlatformNonce::delete ( )

Delete a nonce value in the database.

Returns: bool True if the nonce value was successfully deleted

Definition at line 102 of file PlatformNonce.php.

                            : bool
    {
        return $this->platform->getDataConnector()->deletePlatformNonce($this);
    }

◆ getPlatform()

ILIAS\LTI\ToolProvider\PlatformNonce::getPlatform ( )

Get platform.

Returns: Platform Platform for this nonce

Definition at line 112 of file PlatformNonce.php.

                                 : ?Platform
    {
        return $this->platform;
    }

References ILIAS\LTI\ToolProvider\PlatformNonce\$platform.

◆ getValue()

ILIAS\LTI\ToolProvider\PlatformNonce::getValue ( )

Get outcome value.

Returns: string Outcome value

Definition at line 122 of file PlatformNonce.php.

                              : ?string
    {
        return $this->value;
    }

References ILIAS\LTI\ToolProvider\PlatformNonce\$value.

◆ load()

ILIAS\LTI\ToolProvider\PlatformNonce::load ( )

Load a nonce value from the database.

Returns: bool True if the nonce value was successfully loaded

Definition at line 82 of file PlatformNonce.php.

                          : bool
    {
        return $this->platform->getDataConnector()->loadPlatformNonce($this);
    }

◆ save()

ILIAS\LTI\ToolProvider\PlatformNonce::save ( )

Save a nonce value in the database.

Returns: bool True if the nonce value was successfully saved

Definition at line 92 of file PlatformNonce.php.

                          : bool
    {
        return $this->platform->getDataConnector()->savePlatformNonce($this);
    }

Field Documentation

◆ $expires

int null ILIAS\LTI\ToolProvider\PlatformNonce::$expires = null

Timestamp for when the nonce value expires.

Definition at line 49 of file PlatformNonce.php.

◆ $maximumLength

int ILIAS\LTI\ToolProvider\PlatformNonce::$maximumLength = 50

static

Maximum length which can be stored.

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

Definition at line 42 of file PlatformNonce.php.

◆ $platform

Platform null ILIAS\LTI\ToolProvider\PlatformNonce::$platform = null

private

Platform to which this nonce applies.

Definition at line 56 of file PlatformNonce.php.

Referenced by ILIAS\LTI\ToolProvider\PlatformNonce\__construct(), and ILIAS\LTI\ToolProvider\PlatformNonce\getPlatform().

◆ $value

string null ILIAS\LTI\ToolProvider\PlatformNonce::$value = null

private

Nonce value.

Definition at line 63 of file PlatformNonce.php.

Referenced by ILIAS\LTI\ToolProvider\PlatformNonce\__construct(), and ILIAS\LTI\ToolProvider\PlatformNonce\getValue().

◆ MAX_NONCE_AGE

const ILIAS\LTI\ToolProvider\PlatformNonce::MAX_NONCE_AGE = 30

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

Definition at line 33 of file PlatformNonce.php.

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

Services/LTI/src/ToolProvider/PlatformNonce.php

Public Member Functions

Data Fields

Static Public Attributes

Private Attributes