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

Collaboration diagram for IMSGlobal\LTI\ToolProvider\Context:

Public Member Functions
	__construct ()
	Class constructor. More...

	initialize ()
	Initialise the context. More...

	initialise ()
	Initialise the context. More...

	save ()
	Save the context to the database. More...

	delete ()
	Delete the context from the database. More...

	getConsumer ()
	Get tool consumer. More...

	setConsumerId ($consumerId)
	Set tool consumer ID. More...

	getKey ()
	Get tool consumer key. More...

	getId ()
	Get context ID. More...

	getRecordId ()
	Get the context record ID. More...

	setRecordId ($id)
	Sets the context record ID. More...

	getDataConnector ()
	Get the data connector. More...

	getSetting ($name, $default='')
	Get a setting value. More...

	setSetting ($name, $value=null)
	Set a setting value. More...

	getSettings ()
	Get an array of all setting values. More...

	setSettings ($settings)
	Set an array of all setting values. More...

	saveSettings ()
	Save setting values. More...

	hasToolSettingsService ()
	Check if the Tool Settings service is supported. More...

	getToolSettings ($mode=Service\ToolSettings::MODE_CURRENT_LEVEL, $simple=true)
	Get Tool Settings. More...

	setToolSettings ($settings=array())
	Perform a Tool Settings service request. More...

	hasMembershipService ()
	Check if the Membership service is supported. More...

	getMembership ()
	Get Memberships. More...

Static Public Member Functions
static	fromRecordId ($id, $dataConnector)
	Load the context from the database. More...

static	fromConsumer ($consumer, $ltiContextId)
	Class constructor from consumer. More...

Data Fields
	$ltiContextId = null
	Context ID as supplied in the last connection request. More...

	$title = null
	Context title. More...

	$settings = null
	Setting values (LTI parameters, custom parameters and local parameters). More...

	$created = null
	Date/time when the object was created. More...

	$updated = null
	Date/time when the object was last updated. More...

Private Member Functions
	load ($id=null)
	Load the context from the database. More...

Private Attributes
	$consumer = null
	Tool Consumer for this context. More...

	$consumerId = null
	Tool Consumer ID for this context. More...

	$id = null
	ID for this context. More...

	$settingsChanged = false
	Whether the settings value have changed since last saved. More...

	$dataConnector = null
	Data connector object or string. More...

Detailed Description

Class to represent a tool consumer context.

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

Definition at line 17 of file Context.php.

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\ToolProvider\Context::__construct ( )

Class constructor.

Definition at line 85 of file Context.php.

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

     {
 
         $this->initialize();
 
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

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

Delete the context from the database.

Returns: boolean True if the context was successfully deleted.

Definition at line 139 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\getDataConnector().

     {
 
         return $this->getDataConnector()->deleteContext($this);
 
     }

Here is the call graph for this function:

◆ fromConsumer()

static IMSGlobal\LTI\ToolProvider\Context::fromConsumer	(	$consumer,
		$ltiContextId
	)

static

Class constructor from consumer.

Parameters

ToolConsumer	$consumer	Consumer instance
string	$ltiContextId	LTI Context ID value

Returns: Context

Definition at line 425 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$consumer, $context, and IMSGlobal\LTI\ToolProvider\Context\$ltiContextId.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

     {
 
         $context = new Context();
         $context->consumer = $consumer;
         $context->dataConnector = $consumer->getDataConnector();
         $context->ltiContextId = $ltiContextId;
         if (!empty($ltiContextId)) {
             $context->load();
         }
 
         return $context;
 
     }

Here is the caller graph for this function:

◆ fromRecordId()

static IMSGlobal\LTI\ToolProvider\Context::fromRecordId	(	$id,
		$dataConnector
	)

static

Load the context from the database.

Parameters

int	$id	Record ID of context
DataConnector	$dataConnector	Database connection object

Returns: Context Context object

Definition at line 407 of file Context.php.

References $context, IMSGlobal\LTI\ToolProvider\Context\$dataConnector, and IMSGlobal\LTI\ToolProvider\Context\$id.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\getContext().

     {
 
         $context = new Context();
         $context->dataConnector = $dataConnector;
         $context->load($id);
 
         return $context;
 
     }

Here is the caller graph for this function:

◆ getConsumer()

IMSGlobal\LTI\ToolProvider\Context::getConsumer ( )

Get tool consumer.

Returns: ToolConsumer Tool consumer object for this context.

Definition at line 151 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$consumer, IMSGlobal\LTI\ToolProvider\ToolConsumer\fromRecordId(), and IMSGlobal\LTI\ToolProvider\Context\getDataConnector().

Referenced by IMSGlobal\LTI\ToolProvider\Context\getKey().

     {
 
         if (is_null($this->consumer)) {
             $this->consumer = ToolConsumer::fromRecordId($this->consumerId, $this->getDataConnector());
         }
 
         return $this->consumer;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataConnector()

IMSGlobal\LTI\ToolProvider\Context::getDataConnector ( )

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 227 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$dataConnector.

Referenced by IMSGlobal\LTI\ToolProvider\Context\delete(), IMSGlobal\LTI\ToolProvider\Context\getConsumer(), IMSGlobal\LTI\ToolProvider\Context\load(), and IMSGlobal\LTI\ToolProvider\Context\save().

     {
 
         return $this->dataConnector;
 
     }

Here is the caller graph for this function:

◆ getId()

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

Get context ID.

Returns: string ID for this context.

Definition at line 191 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$ltiContextId.

     {
 
         return $this->ltiContextId;
 
     }

◆ getKey()

IMSGlobal\LTI\ToolProvider\Context::getKey ( )

Get tool consumer key.

Returns: string Consumer key value for this context.

Definition at line 179 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\getConsumer().

     {
 
         return $this->getConsumer()->getKey();
 
     }

Here is the call graph for this function:

◆ getMembership()

IMSGlobal\LTI\ToolProvider\Context::getMembership ( )

Get Memberships.

Returns: mixed The array of User objects if successful, otherwise false

Definition at line 388 of file Context.php.

References $response, $url, and IMSGlobal\LTI\ToolProvider\Context\getSetting().

     {
 
         $url = $this->getSetting('custom_context_memberships_url');
         $service = new Service\Membership($this, $url);
         $response = $service->get();
 
         return $response;
 
     }

Here is the call graph for this function:

◆ getRecordId()

IMSGlobal\LTI\ToolProvider\Context::getRecordId ( )

Get the context record ID.

Returns: int Context record ID value

Definition at line 203 of file Context.php.

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

     {
 
         return $this->id;
 
     }

◆ getSetting()

IMSGlobal\LTI\ToolProvider\Context::getSetting	(	$name,
		$default = `''`
	)

Get a setting value.

Parameters

string	$name	Name of setting
string	$default	Value to return if the setting does not exist (optional, default is an empty string)

Returns: string Setting value

Definition at line 242 of file Context.php.

References $default, $name, and settings().

Referenced by IMSGlobal\LTI\ToolProvider\Context\getMembership(), IMSGlobal\LTI\ToolProvider\Context\getToolSettings(), IMSGlobal\LTI\ToolProvider\Context\hasMembershipService(), IMSGlobal\LTI\ToolProvider\Context\hasToolSettingsService(), IMSGlobal\LTI\ToolProvider\Context\setSetting(), and IMSGlobal\LTI\ToolProvider\Context\setToolSettings().

     {
 
         if (array_key_exists($name, $this->settings)) {
             $value = $this->settings[$name];
         } else {
             $value = $default;
         }
 
         return $value;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettings()

IMSGlobal\LTI\ToolProvider\Context::getSettings ( )

Get an array of all setting values.

Returns: array Associative array of setting values

Definition at line 281 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$settings.

     {
 
         return $this->settings;
 
     }

◆ getToolSettings()

IMSGlobal\LTI\ToolProvider\Context::getToolSettings	(	$mode = `Service\ToolSettings::MODE_CURRENT_LEVEL`,
		$simple = `true`
	)

Get Tool Settings.

Parameters

int	$mode	Mode for request (optional, default is current level only)
boolean	$simple	True if all the simple media type is to be used (optional, default is true)

Returns: mixed The array of settings if successful, otherwise false

Definition at line 340 of file Context.php.

References $response, $url, and IMSGlobal\LTI\ToolProvider\Context\getSetting().

     {
 
         $url = $this->getSetting('custom_context_setting_url');
         $service = new Service\ToolSettings($this, $url, $simple);
         $response = $service->get($mode);
 
         return $response;
 
     }

Here is the call graph for this function:

◆ hasMembershipService()

IMSGlobal\LTI\ToolProvider\Context::hasMembershipService ( )

Check if the Membership service is supported.

Returns: boolean True if this context supports the Membership service

Definition at line 374 of file Context.php.

References $url, and IMSGlobal\LTI\ToolProvider\Context\getSetting().

     {
 
         $url = $this->getSetting('custom_context_memberships_url');
 
         return !empty($url);
 
     }

Here is the call graph for this function:

◆ hasToolSettingsService()

IMSGlobal\LTI\ToolProvider\Context::hasToolSettingsService ( )

Check if the Tool Settings service is supported.

Returns: boolean True if this context supports the Tool Settings service

Definition at line 323 of file Context.php.

References $url, and IMSGlobal\LTI\ToolProvider\Context\getSetting().

     {
 
         $url = $this->getSetting('custom_context_setting_url');
 
         return !empty($url);
 
     }

Here is the call graph for this function:

◆ initialise()

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

Initialise the context.

Pseudonym for initialize().

Definition at line 110 of file Context.php.

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

     {
 
         $this->initialize();
 
     }

Here is the call graph for this function:

◆ initialize()

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

Initialise the context.

Definition at line 95 of file Context.php.

References settings().

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

     {
 
         $this->title = '';
         $this->settings = array();
         $this->created = null;
         $this->updated = null;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

IMSGlobal\LTI\ToolProvider\Context::load ( $id = null )

private

Load the context from the database.

Parameters

int $id Record ID of context (optional, default is null)

Returns: boolean True if context was successfully loaded

Definition at line 451 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$id, IMSGlobal\LTI\ToolProvider\Context\getDataConnector(), and IMSGlobal\LTI\ToolProvider\Context\initialize().

     {
 
         $this->initialize();
         $this->id = $id;
         return $this->getDataConnector()->loadContext($this);
 
     }

Here is the call graph for this function:

◆ save()

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

Save the context to the database.

Returns: boolean True if the context was successfully saved.

Definition at line 122 of file Context.php.

References $ok, and IMSGlobal\LTI\ToolProvider\Context\getDataConnector().

Referenced by IMSGlobal\LTI\ToolProvider\Context\saveSettings().

     {
 
         $ok = $this->getDataConnector()->saveContext($this);
         if ($ok) {
             $this->settingsChanged = false;
         }
 
         return $ok;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

IMSGlobal\LTI\ToolProvider\Context::saveSettings ( )

Save setting values.

Returns: boolean True if the settings were successfully saved

Definition at line 305 of file Context.php.

References $ok, and IMSGlobal\LTI\ToolProvider\Context\save().

     {
 
         if ($this->settingsChanged) {
             $ok = $this->save();
         } else {
             $ok = true;
         }
 
         return $ok;
 
     }

Here is the call graph for this function:

◆ setConsumerId()

IMSGlobal\LTI\ToolProvider\Context::setConsumerId ( $consumerId )

Set tool consumer ID.

Parameters

int $consumerId Tool Consumer ID for this resource link.

Definition at line 166 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$consumerId.

     {
 
         $this->consumer = null;
         $this->consumerId = $consumerId;
 
     }

◆ setRecordId()

IMSGlobal\LTI\ToolProvider\Context::setRecordId ( $id )

Sets the context record ID.

Returns: int $id Context record ID value

Definition at line 215 of file Context.php.

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

     {
 
         $this->id = $id;
 
     }

◆ setSetting()

IMSGlobal\LTI\ToolProvider\Context::setSetting	(	$name,
		$value = `null`
	)

Set a setting value.

Parameters

string	$name	Name of setting
string	$value	Value to set, use an empty value to delete a setting (optional, default is null)

Definition at line 261 of file Context.php.

References $name, IMSGlobal\LTI\ToolProvider\Context\getSetting(), and settings().

     {
 
         $old_value = $this->getSetting($name);
         if ($value !== $old_value) {
             if (!empty($value)) {
                 $this->settings[$name] = $value;
             } else {
                 unset($this->settings[$name]);
             }
             $this->settingsChanged = true;
         }
 
     }

Here is the call graph for this function:

◆ setSettings()

IMSGlobal\LTI\ToolProvider\Context::setSettings ( $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

Definition at line 293 of file Context.php.

References IMSGlobal\LTI\ToolProvider\Context\$settings, and settings().

     {
 
         $this->settings = $settings;
 
     }

Here is the call graph for this function:

◆ setToolSettings()

IMSGlobal\LTI\ToolProvider\Context::setToolSettings ( $settings = array() )

Perform a Tool Settings service request.

Parameters

array $settings An associative array of settings (optional, default is none)

Returns: boolean True if action was successful, otherwise false

Definition at line 358 of file Context.php.

References $response, IMSGlobal\LTI\ToolProvider\Context\$settings, $url, and IMSGlobal\LTI\ToolProvider\Context\getSetting().

     {
 
         $url = $this->getSetting('custom_context_setting_url');
         $service = new Service\ToolSettings($this, $url);
         $response = $service->set($settings);
 
         return $response;
 
     }

Here is the call graph for this function:

Field Documentation

◆ $consumer

ToolConsumer IMSGlobal\LTI\ToolProvider\Context::$consumer = null

private

Tool Consumer for this context.

Definition at line 56 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\fromConsumer(), and IMSGlobal\LTI\ToolProvider\Context\getConsumer().

◆ $consumerId

int IMSGlobal\LTI\ToolProvider\Context::$consumerId = null

private

Tool Consumer ID for this context.

Definition at line 62 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\setConsumerId().

◆ $created

int IMSGlobal\LTI\ToolProvider\Context::$created = null

Date/time when the object was created.

Definition at line 43 of file Context.php.

◆ $dataConnector

mixed IMSGlobal\LTI\ToolProvider\Context::$dataConnector = null

private

Data connector object or string.

Definition at line 80 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\fromRecordId(), and IMSGlobal\LTI\ToolProvider\Context\getDataConnector().

◆ $id

int IMSGlobal\LTI\ToolProvider\Context::$id = null

private

ID for this context.

Definition at line 68 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\fromRecordId(), IMSGlobal\LTI\ToolProvider\Context\getRecordId(), IMSGlobal\LTI\ToolProvider\Context\load(), and IMSGlobal\LTI\ToolProvider\Context\setRecordId().

◆ $ltiContextId

string IMSGlobal\LTI\ToolProvider\Context::$ltiContextId = null

Context ID as supplied in the last connection request.

Definition at line 25 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\fromConsumer(), and IMSGlobal\LTI\ToolProvider\Context\getId().

◆ $settings

array IMSGlobal\LTI\ToolProvider\Context::$settings = null

Setting values (LTI parameters, custom parameters and local parameters).

Definition at line 37 of file Context.php.

Referenced by IMSGlobal\LTI\ToolProvider\Context\getSettings(), IMSGlobal\LTI\ToolProvider\Context\setSettings(), and IMSGlobal\LTI\ToolProvider\Context\setToolSettings().

◆ $settingsChanged

boolean IMSGlobal\LTI\ToolProvider\Context::$settingsChanged = false

private

Whether the settings value have changed since last saved.

Definition at line 74 of file Context.php.

◆ $title

string IMSGlobal\LTI\ToolProvider\Context::$title = null

Context title.

Definition at line 31 of file Context.php.

◆ $updated

int IMSGlobal\LTI\ToolProvider\Context::$updated = null

Date/time when the object was last updated.

Definition at line 49 of file Context.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ fromConsumer()

◆ fromRecordId()

◆ getConsumer()

◆ getDataConnector()

◆ getId()

◆ getKey()

◆ getMembership()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getToolSettings()

◆ hasMembershipService()

◆ hasToolSettingsService()

◆ initialise()

◆ initialize()

◆ load()

◆ save()

◆ saveSettings()

◆ setConsumerId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Field Documentation

◆ $consumer

◆ $consumerId

◆ $created

◆ $dataConnector

◆ $id

◆ $ltiContextId

◆ $settings

◆ $settingsChanged

◆ $title

◆ $updated