Class to represent a platform context. More...

Collaboration diagram for ILIAS\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...

	getPlatform ()
	Get tool consumer. More...

	setPlatformId (int $platformId)
	Set platform ID. More...

	getKey ()
	Get consumer key. More...

	getId ()
	Get context ID. More...

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

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

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

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

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

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

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

	saveSettings ()
	Save setting values. More...

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

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

	setToolSettings (array $settings=array())
	Set Tool Settings. More...

	hasGroupService ()
	Check if a Course Group service is available. More...

	getGroups ()
	Get course group sets and groups. More...

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

	hasMembershipsService ()
	Check if a Membership service is available. More...

	getMembership ()
	Get Membership. More...

	getMemberships (bool $withGroups=false)
	Get Memberships. More...

	hasLineItemService ()
	Check if the Line Item service is available. More...

	hasScoreService ()
	Check if the Score service is available. More...

	hasResultService ()
	Check if the Result service is available. More...

	getLineItems (string $resourceId=null, string $tag=null, int $limit=null)
	Get line items. More...

	createLineItem (LineItem $lineItem)
	Create a new line item. More...

Static Public Member Functions
static	fromRecordId (int $id, \ILIAS\LTI\ToolProvider\DataConnector\DataConnector $dataConnector)
	Load the context from the database. More...

static	fromPlatform (Platform $platform, string $ltiContextId)
	Class constructor from consumer. More...

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

string	$title = null
	Context title. More...

string	$type = null
	Context type. More...

array	$groupSets = null
	User group sets (null if the platform does not support the groups enhancement) More...

array	$groups = null
	User groups (null if the platform does not support the groups enhancement) More...

HTTPMessage	$lastServiceRequest = null
	HttpMessage object for last service request. More...

int	$created = null
	Timestamp for when the object was created. More...

int	$updated = null
	Timestamp for when the object was last updated. More...

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

	getLineItemService ()
	Get the Line Item service object. More...

Private Attributes
Platform	$platform = null
	Platform for this context. More...

int	$platformId = null
	Platform ID for this context. More...

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

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

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

ILIAS LTI ToolProvider DataConnector DataConnector	$dataConnector = null
	Data connector object or string. More...

Detailed Description

Class to represent a platform context.

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

Definition at line 33 of file Context.php.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor.

Definition at line 151 of file Context.php.

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

     {
         $this->initialize();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createLineItem()

ILIAS\LTI\ToolProvider\Context::createLineItem ( LineItem $lineItem )

Create a new line item.

Parameters

LineItem $lineItem Line item object

Returns: bool True if successful

Definition at line 647 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\getLineItemService().

                                                       : bool
     {
         $ok = false;
         $lineItemService = $this->getLineItemService();
         if (!empty($lineItemService)) {
             $ok = $lineItemService->createLineItem($lineItem);
         }
 
         return $ok;
     }

Here is the call graph for this function:

◆ delete()

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

Delete the context from the database.

Returns: bool True if the context was successfully deleted.

Definition at line 199 of file Context.php.

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

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

Here is the call graph for this function:

◆ fromPlatform()

static ILIAS\LTI\ToolProvider\Context::fromPlatform	(	Platform	$platform,
		string	$ltiContextId
	)

static

Class constructor from consumer.

Deprecated:: Use fromPlatform() instead

See also: Context::fromPlatform()

Parameters

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

Returns: Context Class constructor from platform.

Parameters

Platform	$platform	Platform instance
string	$ltiContextId	LTI Context ID value

Returns: Context

Definition at line 695 of file Context.php.

References $context, ILIAS\LTI\ToolProvider\Context\$ltiContextId, ILIAS\LTI\ToolProvider\Context\$platform, and ILIAS\LTI\ToolProvider\Platform\getDataConnector().

Referenced by ILIAS\LTI\ToolProvider\Tool\authenticate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromRecordId()

static ILIAS\LTI\ToolProvider\Context::fromRecordId	(	int	$id,
		\ILIAS\LTI\ToolProvider\DataConnector\DataConnector	$dataConnector
	)

static

Load the context from the database.

Parameters

int	$id	Record ID of context
\ILIAS\LTI\ToolProvider\DataConnector\DataConnector	$dataConnector	Database connection object

Returns: Context Context object

Definition at line 664 of file Context.php.

References $context, and ILIAS\LTI\ToolProvider\Context\$dataConnector.

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

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

Here is the caller graph for this function:

◆ getDataConnector()

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

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 302 of file Context.php.

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

Referenced by ILIAS\LTI\ToolProvider\Context\delete(), ILIAS\LTI\ToolProvider\ResourceLink\fromContext(), ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\load(), and ILIAS\LTI\ToolProvider\Context\save().

     {
         return $this->dataConnector;
     }

Here is the caller graph for this function:

◆ getGroups()

ILIAS\LTI\ToolProvider\Context::getGroups ( )

Get course group sets and groups.

Returns: bool True if the request was successful

Definition at line 459 of file Context.php.

References ILIAS\LTI\ToolProvider\ApiHook\$GROUPS_SERVICE_HOOK, $service, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                : bool
     {
         $groupsUrl = $this->getSetting('custom_context_groups_url');
         $groupsetsUrl = $this->getSetting('custom_context_group_sets_url');
         $service = new Service\Groups($this, $groupsUrl, $groupsetsUrl);
         $ok = $service->get();
         if (!empty($service->getHttpMessage())) {
             $this->lastServiceRequest = $service->getHttpMessage();
         }
         if (!$ok && $this->hasConfiguredApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
             $className = $this->getApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
             $hook = new $className($this);
             $ok = $hook->getGroups();
         }
 
         return $ok;
     }

Here is the call graph for this function:

◆ getId()

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

Get context ID.

Returns: string ID for this context.

Definition at line 273 of file Context.php.

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

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

◆ getKey()

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

Get consumer key.

Returns: string Consumer key value for this context.

Definition at line 263 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\getPlatform().

                             : string
     {
         return $this->getPlatform()->getKey();
     }

Here is the call graph for this function:

◆ getLineItems()

ILIAS\LTI\ToolProvider\Context::getLineItems	(	string	$resourceId = `null`,
		string	$tag = `null`,
		int	$limit = `null`
	)

Get line items.

Parameters

string \| null	$resourceId	Tool resource ID
string \| null	$tag	Tag
int \| null	$limit	Limit of line items to be returned in each request, null for service default

Returns: LineItem[]|bool Array of LineItem objects or false on error

Definition at line 628 of file Context.php.

References $http, and ILIAS\LTI\ToolProvider\Context\getLineItemService().

     {
         $lineItems = false;
         $this->lastServiceRequest = null;
         $lineItemService = $this->getLineItemService();
         if (!empty($lineItemService)) {
             $lineItems = $lineItemService->getAll(null, $resourceId, $tag);
             $http = $lineItemService->getHttpMessage();
             $this->lastServiceRequest = $http;
         }
 
         return $lineItems;
     }

Here is the call graph for this function:

◆ getLineItemService()

ILIAS\LTI\ToolProvider\Context::getLineItemService ( )

private

Get the Line Item service object.

Returns: bool|Service Line Item service, or false if not available //UK: removed Service\LineItem

Definition at line 729 of file Context.php.

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

Referenced by ILIAS\LTI\ToolProvider\Context\createLineItem(), and ILIAS\LTI\ToolProvider\Context\getLineItems().

     {
         $url = $this->getSetting('custom_lineitems_url');
         if (!empty($url)) {
             $lineItemService = new Service\LineItem($this->getPlatform(), $url);
         } else {
             $lineItemService = false;
         }
 
         return $lineItemService;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembership()

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

Get Membership.

Deprecated:: Use getMemberships() instead

See also: Context::getMemberships()

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

Definition at line 516 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\getMemberships(), and ILIAS\LTI\ToolProvider\Util\logDebug().

     {
         Util::logDebug(
             'Method ceLTIc\LTI\Context::getMembership() has been deprecated; please use ceLTIc\LTI\Context::getMemberships() instead.',
             true
         );
         return $this->getMemberships();
     }

Here is the call graph for this function:

◆ getMemberships()

ILIAS\LTI\ToolProvider\Context::getMemberships ( bool $withGroups = false )

Get Memberships.

Parameters

bool $withGroups True is group information is to be requested as well

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

Definition at line 530 of file Context.php.

References $format, ILIAS\LTI\ToolProvider\ApiHook\$GROUPS_SERVICE_HOOK, ILIAS\LTI\ToolProvider\ApiHook\$MEMBERSHIPS_SERVICE_HOOK, $service, $url, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook(), ILIAS\LTI\ToolProvider\Service\Membership\MEDIA_TYPE_MEMBERSHIPS_NRPS, and ILIAS\LTI\ToolProvider\Service\Membership\MEDIA_TYPE_MEMBERSHIPS_V1.

Referenced by ILIAS\LTI\ToolProvider\Context\getMembership().

     {
         $ok = false;
         $userResults = array();
         $hasMembershipsService = !empty($this->getSetting('custom_context_memberships_url'));
         $hasNRPService = !empty($this->getSetting('custom_context_memberships_v2_url'));
         $hasGroupsService = !empty($this->getSetting('custom_context_groups_url')) ||
             $this->hasConfiguredApiHook(self::$GROUPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
         $hasApiHook = $this->hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
         if (($hasMembershipsService || $hasNRPService) && (!$withGroups || ($hasNRPService && $hasGroupsService) || !$hasApiHook)) {
             if ($hasNRPService) {
                 $url = $this->getSetting('custom_context_memberships_v2_url');
                 $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_NRPS;
             } else {
                 $url = $this->getSetting('custom_context_memberships_url');
                 $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_V1;
             }
             $service = new Service\Membership($this, $url, $format);
             if (!$withGroups || !$hasNRPService) {
                 $userResults = $service->get();
             } else {
                 $userResults = $service->getWithGroups();
             }
             if (!empty($service->getHttpMessage())) {
                 $this->lastServiceRequest = $service->getHttpMessage();
             }
             $ok = $userResults !== false;
         }
         if (!$ok && $hasApiHook) {
             $className = $this->getApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
             $hook = new $className($this);
             $userResults = $hook->getMemberships($withGroups);
         }
 
         return $userResults;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlatform()

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

Get tool consumer.

Deprecated:: Use getPlatform() instead

See also: Context::getPlatform()

Returns: ToolConsumer Tool consumer object for this context. Set tool consumer ID.

Deprecated:: Use setPlatformId() instead

See also: Context::setPlatformId()

Parameters

int $consumerId Tool Consumer ID for this context. Get platform.

Returns: Platform Platform object for this context.

Definition at line 239 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\$platform, ilLTIPlatform\fromRecordId(), and ILIAS\LTI\ToolProvider\Context\getDataConnector().

                                  : ?\ilLTIPlatform
     {
         if (is_null($this->platform)) {
             $this->platform = \ilLTIPlatform::fromRecordId($this->platformId, $this->getDataConnector());
         }
 
         return $this->platform;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordId()

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

Get the context record ID.

Returns: int|null Context record ID value

Definition at line 283 of file Context.php.

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

Referenced by ilLTIDataConnector\deleteContext(), ilLTIDataConnector\loadContext(), ilLTIDataConnector\saveContext(), and ILIAS\LTI\ToolProvider\ResourceLink\setContext().

                                  : ?int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getSetting()

ILIAS\LTI\ToolProvider\Context::getSetting	(	string	$name,
		string	$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 313 of file Context.php.

References $name, and ILIAS\Repository\settings().

                                                                   : string
     {
         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()

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

Get an array of all setting values.

Returns: array Associative array of setting values

Definition at line 347 of file Context.php.

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

Referenced by ilLTIDataConnector\saveContext().

                                  : ?array
     {
         return $this->settings;
     }

Here is the caller graph for this function:

◆ getToolSettings()

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

Get Tool Settings.

Parameters

int	$mode	Mode for request (optional, default is current level only)
bool	$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 397 of file Context.php.

References $service, ILIAS\LTI\ToolProvider\Context\$settings, ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, $url, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

     {
         $ok = false;
         $settings = array();
         if (!empty($this->getSetting('custom_context_setting_url'))) {
             $url = $this->getSetting('custom_context_setting_url');
             $service = new Service\ToolSettings($this, $url, $simple);
             $settings = $service->get($mode);
             $this->lastServiceRequest = $service->getHttpMessage();
             $ok = $settings !== false;
         }
         if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
             $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
             $hook = new $className($this);
             $settings = $hook->getToolSettings($mode, $simple);
         }
 
         return $settings;
     }

Here is the call graph for this function:

◆ hasGroupService()

ILIAS\LTI\ToolProvider\Context::hasGroupService ( )

Check if a Course Group service is available.

Returns: bool True if this context supports a Course Group service

Definition at line 445 of file Context.php.

References ILIAS\LTI\ToolProvider\ApiHook\$MEMBERSHIPS_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                      : bool
     {
         $has = !empty($this->getSetting('custom_context_groups_url'));
         if (!$has) {
             $has = self::hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
         }
         return $has;
     }

Here is the call graph for this function:

◆ hasLineItemService()

ILIAS\LTI\ToolProvider\Context::hasLineItemService ( )

Check if the Line Item service is available.

Returns: bool True if this context supports the Line Item service

Definition at line 572 of file Context.php.

References $scopes, and ILIAS\LTI\ToolProvider\Context\getSetting().

                                         : bool
     {
         $has = false;
         if (!empty($this->getSetting('custom_ags_scopes'))) {
             $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
             if (in_array(Service\LineItem::$SCOPE, $scopes) || in_array(Service\LineItem::$SCOPE_READONLY, $scopes)) {
                 $has = !empty($this->getSetting('custom_lineitems_url'));
             }
         }
 
         return $has;
     }

Here is the call graph for this function:

◆ hasMembershipService()

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

Check if the Membership service is supported.

Deprecated:: Use hasMembershipsService() instead

See also: Context::hasMembershipsService()

Returns: bool True if this context supports the Membership service

Definition at line 485 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\hasMembershipsService(), and ILIAS\LTI\ToolProvider\Util\logDebug().

                                           : bool
     {
         Util::logDebug(
             'Method ceLTIc\LTI\Context::hasMembershipService() has been deprecated; please use ceLTIc\LTI\Context::hasMembershipsService() instead.',
             true
         );
         return $this->hasMembershipsService();
     }

Here is the call graph for this function:

◆ hasMembershipsService()

ILIAS\LTI\ToolProvider\Context::hasMembershipsService ( )

Check if a Membership service is available.

Returns: bool True if this context supports a Memberships service

Definition at line 499 of file Context.php.

References ILIAS\LTI\ToolProvider\ApiHook\$MEMBERSHIPS_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

Referenced by ILIAS\LTI\ToolProvider\Context\hasMembershipService().

                                            : bool
     {
         $has = !empty($this->getSetting('custom_context_memberships_url')) || !empty($this->getSetting('custom_context_memberships_v2_url'));
         if (!$has) {
             $has = self::hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
         }
         return $has;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasResultService()

ILIAS\LTI\ToolProvider\Context::hasResultService ( )

Check if the Result service is available.

Returns: bool True if this context supports the Result service

Definition at line 608 of file Context.php.

References ILIAS\LTI\ToolProvider\Service\Result\$SCOPE, $scopes, and ILIAS\LTI\ToolProvider\Context\getSetting().

                                       : bool
     {
         $has = false;
         if (!empty($this->getSetting('custom_ags_scopes'))) {
             $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
             if (in_array(Service\Result::$SCOPE, $scopes)) {
                 $has = !empty($this->getSetting('custom_lineitems_url'));
             }
         }
 
         return $has;
     }

Here is the call graph for this function:

◆ hasScoreService()

ILIAS\LTI\ToolProvider\Context::hasScoreService ( )

Check if the Score service is available.

Returns: bool True if this context supports the Score service

Definition at line 590 of file Context.php.

References ILIAS\LTI\ToolProvider\Service\Score\$SCOPE, $scopes, and ILIAS\LTI\ToolProvider\Context\getSetting().

                                      : bool
     {
         $has = false;
         if (!empty($this->getSetting('custom_ags_scopes'))) {
             $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
             if (in_array(Service\Score::$SCOPE, $scopes)) {
                 $has = !empty($this->getSetting('custom_lineitems_url'));
             }
         }
 
         return $has;
     }

Here is the call graph for this function:

◆ hasToolSettingsService()

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

Check if the Tool Settings service is available.

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

Definition at line 382 of file Context.php.

References ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                             : bool
     {
         $has = !empty($this->getSetting('custom_context_setting_url'));
         if (!$has) {
             $has = self::hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
         }
         return $has;
     }

Here is the call graph for this function:

◆ initialise()

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

Initialise the context.

Synonym for initialize().

Definition at line 174 of file Context.php.

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

     {
         $this->initialize();
     }

Here is the call graph for this function:

◆ initialize()

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

Initialise the context.

Definition at line 159 of file Context.php.

References ILIAS\Repository\settings().

Referenced by ILIAS\LTI\ToolProvider\Context\__construct(), ILIAS\LTI\ToolProvider\DataConnector\DataConnector\deleteContext(), ilLTIDataConnector\deleteContext(), ILIAS\LTI\ToolProvider\Context\initialise(), and ILIAS\LTI\ToolProvider\Context\load().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

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

private

Load the context from the database.

Parameters

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

Returns: bool True if context was successfully loaded

Definition at line 717 of file Context.php.

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

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

Here is the call graph for this function:

◆ save()

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

Save the context to the database.

Returns: bool True if the context was successfully saved.

Definition at line 184 of file Context.php.

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

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

                           : bool
     {
         $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()

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

Save setting values.

Returns: bool True if the settings were successfully saved

Definition at line 366 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\save().

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

Here is the call graph for this function:

◆ setPlatformId()

ILIAS\LTI\ToolProvider\Context::setPlatformId ( int $platformId )

Set platform ID.

Parameters

int $platformId Platform ID for this context.

Definition at line 252 of file Context.php.

References ILIAS\LTI\ToolProvider\Context\$platformId.

Referenced by ilLTIDataConnector\loadContext().

     {
         $this->platform = null;
         $this->platformId = $platformId;
     }

Here is the caller graph for this function:

◆ setRecordId()

ILIAS\LTI\ToolProvider\Context::setRecordId ( int $id )

Sets the context record ID.

Parameters

int $id Context record ID value

Definition at line 292 of file Context.php.

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

Referenced by ilLTIDataConnector\loadContext(), and ilLTIDataConnector\saveContext().

     {
         $this->id = $id;
     }

Here is the caller graph for this function:

◆ setSetting()

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

Set a setting value.

Parameters

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

Definition at line 329 of file Context.php.

References $name, ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\Repository\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()

ILIAS\LTI\ToolProvider\Context::setSettings ( array $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

Definition at line 356 of file Context.php.

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

Referenced by ilLTIDataConnector\loadContext().

     {
         $this->settings = $settings;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setToolSettings()

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

Set Tool Settings.

Parameters

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

Returns: bool True if action was successful, otherwise false

Definition at line 422 of file Context.php.

References $service, ILIAS\LTI\ToolProvider\ApiHook\$TOOL_SETTINGS_SERVICE_HOOK, $url, ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\Context\getPlatform(), ILIAS\LTI\ToolProvider\Context\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                                               : bool
     {
         $ok = false;
         if (!empty($this->getSetting('custom_context_setting_url'))) {
             $url = $this->getSetting('custom_context_setting_url');
             $service = new Service\ToolSettings($this, $url);
             $ok = $service->set($settings);
             $this->lastServiceRequest = $service->getHttpMessage();
         }
         if (!$ok && $this->hasConfiguredApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
             $className = $this->getApiHook(self::$TOOL_SETTINGS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
             $hook = new $className($this);
             $ok = $hook->setToolSettings($settings);
         }
 
         return $ok;
     }

Here is the call graph for this function:

Field Documentation

◆ $created

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

Timestamp for when the object was created.

Definition at line 97 of file Context.php.

◆ $dataConnector

ILIAS LTI ToolProvider DataConnector DataConnector null ILIAS\LTI\ToolProvider\Context::$dataConnector = null

private

Data connector object or string.

Definition at line 146 of file Context.php.

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

◆ $groups

array null ILIAS\LTI\ToolProvider\Context::$groups = null

User groups (null if the platform does not support the groups enhancement)

A group is represented by an associative array with the following elements:

title
set (ID of group set, array of IDs if the group belongs to more than one set, omitted if the group is not part of a set) The array key value is the group ID.

Definition at line 83 of file Context.php.

◆ $groupSets

array null ILIAS\LTI\ToolProvider\Context::$groupSets = null

User group sets (null if the platform does not support the groups enhancement)

A group set is represented by an associative array with the following elements:

title
groups (array of group IDs)
num_members
num_staff
num_learners The array key value is the group set ID.

Definition at line 71 of file Context.php.

◆ $id

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

private

ID for this context.

Definition at line 125 of file Context.php.

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

◆ $lastServiceRequest

HttpMessage null ILIAS\LTI\ToolProvider\Context::$lastServiceRequest = null

HttpMessage object for last service request.

Definition at line 90 of file Context.php.

◆ $ltiContextId

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

Context ID as supplied in the last connection request.

Definition at line 42 of file Context.php.

Referenced by ILIAS\LTI\ToolProvider\Context\fromPlatform(), and ILIAS\LTI\ToolProvider\Context\getId().

◆ $platform

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

private

Platform for this context.

Definition at line 111 of file Context.php.

Referenced by ILIAS\LTI\ToolProvider\Context\fromPlatform(), and ILIAS\LTI\ToolProvider\Context\getPlatform().

◆ $platformId

int null ILIAS\LTI\ToolProvider\Context::$platformId = null

private

Platform ID for this context.

Definition at line 118 of file Context.php.

Referenced by ILIAS\LTI\ToolProvider\Context\setPlatformId().

◆ $settings

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

private

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

Definition at line 132 of file Context.php.

Referenced by ILIAS\LTI\ToolProvider\Context\getSettings(), ILIAS\LTI\ToolProvider\Context\getToolSettings(), and ILIAS\LTI\ToolProvider\Context\setSettings().

◆ $settingsChanged

bool ILIAS\LTI\ToolProvider\Context::$settingsChanged = false

private

Whether the settings value have changed since last saved.

Definition at line 139 of file Context.php.

◆ $title

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

Context title.

Definition at line 49 of file Context.php.

◆ $type

string null ILIAS\LTI\ToolProvider\Context::$type = null

Context type.

Definition at line 56 of file Context.php.

◆ $updated

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

Timestamp for when the object was last updated.

Definition at line 104 of file Context.php.

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

Services/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

◆ createLineItem()

◆ delete()

◆ fromPlatform()

◆ fromRecordId()

◆ getDataConnector()

◆ getGroups()

◆ getId()

◆ getKey()

◆ getLineItems()

◆ getLineItemService()

◆ getMembership()

◆ getMemberships()

◆ getPlatform()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getToolSettings()

◆ hasGroupService()

◆ hasLineItemService()

◆ hasMembershipService()

◆ hasMembershipsService()

◆ hasResultService()

◆ hasScoreService()

◆ hasToolSettingsService()

◆ initialise()

◆ initialize()

◆ load()

◆ save()

◆ saveSettings()

◆ setPlatformId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Field Documentation

◆ $created

◆ $dataConnector

◆ $groups

◆ $groupSets

◆ $id

◆ $lastServiceRequest

◆ $ltiContextId

◆ $platform

◆ $platformId

◆ $settings

◆ $settingsChanged

◆ $title

◆ $type

◆ $updated