Class to represent a tool consumer resource link share key. More...

Collaboration diagram for IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey:

Public Member Functions
	__construct ($resourceLink, $id=null)
	Class constructor. More...

	initialize ()
	Initialise the resource link share key. More...

	initialise ()
	Initialise the resource link share key. More...

	save ()
	Save the resource link share key to the database. More...

	delete ()
	Delete the resource link share key from the database. More...

	getId ()
	Get share key value. More...

Data Fields
const	MAX_SHARE_KEY_LIFE = 168
	Maximum permitted life for a share key value. More...

const	DEFAULT_SHARE_KEY_LIFE = 24
	Default life for a share key value. More...

const	MIN_SHARE_KEY_LENGTH = 5
	Minimum length for a share key value. More...

const	MAX_SHARE_KEY_LENGTH = 32
	Maximum length for a share key value. More...

	$resourceLinkId = null
	ID for resource link being shared. More...

	$length = null
	Length of share key. More...

	$life = null
	Life of share key. More...

	$autoApprove = false
	Whether the sharing arrangement should be automatically approved when first used. More...

	$expires = null
	Date/time when the share key expires. More...

Private Member Functions
	load ()
	Load the resource link share key from the database. More...

Private Attributes
	$id = null
	Share key value. More...

	$dataConnector = null
	Data connector. More...

Detailed Description

Class to represent a tool consumer resource link share key.

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 @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 16 of file ResourceLinkShareKey.php.

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::__construct	(	$resourceLink,
		$id = `null`
	)

Class constructor.

Parameters

ResourceLink	$resourceLink	Resource_Link object
string	$id	Value of share key (optional, default is null)

Definition at line 86 of file ResourceLinkShareKey.php.

    {
 
        $this->initialize();
        $this->dataConnector = $resourceLink->getDataConnector();
        $this->resourceLinkId = $resourceLink->getRecordId();
        $this->id = $id;
        if (!empty($id)) {
            $this->load();
        }
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\$id, IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\initialize(), and IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\load().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::delete ( )

Delete the resource link share key from the database.

Returns: boolean True if the share key was successfully deleted

Definition at line 156 of file ResourceLinkShareKey.php.

    {
 
        return $this->dataConnector->deleteResourceLinkShareKey($this);
 
    }

◆ getId()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::getId ( )

Get share key value.

Returns: string Share key value

Definition at line 168 of file ResourceLinkShareKey.php.

    {
 
        return $this->id;
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\$id.

◆ initialise()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::initialise ( )

Initialise the resource link share key.

Pseudonym for initialize().

Definition at line 117 of file ResourceLinkShareKey.php.

    {
 
        $this->initialize();
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\initialize().

Here is the call graph for this function:

◆ initialize()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::initialize ( )

Initialise the resource link share key.

Definition at line 102 of file ResourceLinkShareKey.php.

    {
 
        $this->length = null;
        $this->life = null;
        $this->autoApprove = false;
        $this->expires = null;
 
    }

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\__construct(), IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\initialise(), and IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\load().

Here is the caller graph for this function:

◆ load()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::load ( )

private

Load the resource link share key from the database.

Definition at line 182 of file ResourceLinkShareKey.php.

    {
 
        $this->initialize();
        $this->dataConnector->loadResourceLinkShareKey($this);
        if (!is_null($this->id)) {
            $this->length = strlen($this->id);
        }
        if (!is_null($this->expires)) {
            $this->life = ($this->expires - time()) / 60 / 60;
        }
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\initialize().

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::save ( )

Save the resource link share key to the database.

Returns: boolean True if the share key was successfully saved

Definition at line 129 of file ResourceLinkShareKey.php.

    {
 
        if (empty($this->life)) {
            $this->life = self::DEFAULT_SHARE_KEY_LIFE;
        } else {
            $this->life = max(min($this->life, self::MAX_SHARE_KEY_LIFE), 0);
        }
        $this->expires = time() + ($this->life * 60 * 60);
        if (empty($this->id)) {
            if (empty($this->length) || !is_numeric($this->length)) {
                $this->length = self::MAX_SHARE_KEY_LENGTH;
            } else {
                $this->length = max(min($this->length, self::MAX_SHARE_KEY_LENGTH), self::MIN_SHARE_KEY_LENGTH);
            }
            $this->id = DataConnector::getRandomString($this->length);
        }
 
        return $this->dataConnector->saveResourceLinkShareKey($this);
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\DEFAULT_SHARE_KEY_LIFE, IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector\getRandomString(), and IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\MAX_SHARE_KEY_LENGTH.

Here is the call graph for this function:

Field Documentation

◆ $autoApprove

boolean IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$autoApprove = false

Whether the sharing arrangement should be automatically approved when first used.

Definition at line 59 of file ResourceLinkShareKey.php.

◆ $dataConnector

DataConnector IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$dataConnector = null

private

Data connector.

Definition at line 78 of file ResourceLinkShareKey.php.

◆ $expires

int IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$expires = null

Date/time when the share key expires.

Definition at line 65 of file ResourceLinkShareKey.php.

◆ $id

string IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$id = null

private

Share key value.

Definition at line 72 of file ResourceLinkShareKey.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\__construct(), and IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\getId().

◆ $length

int IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$length = null

Length of share key.

Definition at line 47 of file ResourceLinkShareKey.php.

◆ $life

int IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$life = null

Life of share key.

Definition at line 53 of file ResourceLinkShareKey.php.

◆ $resourceLinkId

string IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::$resourceLinkId = null

ID for resource link being shared.

Definition at line 41 of file ResourceLinkShareKey.php.

◆ DEFAULT_SHARE_KEY_LIFE

const IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::DEFAULT_SHARE_KEY_LIFE = 24

Default life for a share key value.

Definition at line 26 of file ResourceLinkShareKey.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\save().

◆ MAX_SHARE_KEY_LENGTH

const IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::MAX_SHARE_KEY_LENGTH = 32

Maximum length for a share key value.

Definition at line 34 of file ResourceLinkShareKey.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey\save().

◆ MAX_SHARE_KEY_LIFE

const IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::MAX_SHARE_KEY_LIFE = 168

Maximum permitted life for a share key value.

Definition at line 22 of file ResourceLinkShareKey.php.

◆ MIN_SHARE_KEY_LENGTH

const IMSGlobal\LTI\ToolProvider\ResourceLinkShareKey::MIN_SHARE_KEY_LENGTH = 5

Minimum length for a share key value.

Definition at line 30 of file ResourceLinkShareKey.php.

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

libs/composer/vendor/imsglobal/lti/src/ToolProvider/ResourceLinkShareKey.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getId()

◆ initialise()

◆ initialize()

◆ load()

◆ save()

Field Documentation

◆ $autoApprove

◆ $dataConnector

◆ $expires

◆ $id

◆ $length

◆ $life

◆ $resourceLinkId

◆ DEFAULT_SHARE_KEY_LIFE

◆ MAX_SHARE_KEY_LENGTH

◆ MAX_SHARE_KEY_LIFE

◆ MIN_SHARE_KEY_LENGTH