ILIAS\LTI\ToolProvider\ResourceLink Class Reference

Class to represent a platform resource link. More...

Collaboration diagram for ILIAS\LTI\ToolProvider\ResourceLink:

Public Member Functions
	__construct ()
	Class constructor. More...
	initialize ()
	Initialise the resource link. More...
	initialise ()
	Initialise the resource link. More...
	save ()
	Save the resource link to the database. More...
	delete ()
	Delete the resource link from the database. More...
	getPlatform ()
	Get tool consumer. More...
	getPlatformId ()
	Get platform ID. More...
	setPlatformId (?int $platformId)
	Set platform ID. More...
	getContext ()
	Get context. More...
	getContextId ()
	Get context record ID. More...
	setContext (Context $context)
	Set context. More...
	setContextId (?int $contextId)
	Set context ID. More...
	getKey ()
	Get consumer key. More...
	getId ()
	Get resource link ID. More...
	getRecordId ()
	Get resource link record ID. More...
	setRecordId (int $id)
	Set resource link 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...
	hasOutcomesService ()
	Check if an Outcomes service is available. More...
	hasMembershipsService ()
	Check if a Memberships service is available. More...
	hasSettingService ()
	Check if the Setting extension service is available. 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...
	hasAssessmentControlService ()
	Check if the Assessment Control service is available. More...
	doOutcomesService (int $action, Outcome $ltiOutcome, UserResult $userResult)
	Perform an Outcomes service request. More...
	doSettingService (int $action, string $value=null)
	Perform a Memberships extension service request. 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...
	hasMembershipService ()
	Check if the Membership service is supported. More...
	getMembership ()
	Get Membership. More...
	getMemberships (bool $withGroups=false)
	Get Memberships. More...
	getUserResultSourcedIDs (bool $localOnly=false, int $idScope=null)
	Obtain an array of UserResult objects for users with a result sourcedId. More...
	getShares ()
	Get an array of ResourceLinkShare objects for each resource link which is sharing this context. More...
	getLineItems (string $resourceId=null, string $tag=null, int $limit=null)
	Get line items. More...
	createLineItem (LineItem $lineItem)
	Create a new line item. More...
	getOutcomes (int $limit=null)
	Get all outcomes. More...
	doAssessmentControlAction (AssessmentControlAction $assessmentControlAction, User $user, int $attemptNumber)
	Perform an Assessment Control action. More...

Static Public Member Functions
static	fromPlatform (Platform $platform, string $ltiResourceLinkId, string $tempId=null)
	Class constructor from consumer. More...
static	fromContext (Context $context, string $ltiResourceLinkId, string $tempId=null)
	Class constructor from context. More...
static	fromRecordId (int $id, DataConnector $dataConnector)
	Load the resource link from the database. More...

Data Fields
const	EXT_READ = 1
	Read action. More...
const	EXT_WRITE = 2
	Write (create/update) action. More...
const	EXT_DELETE = 3
	Delete action. More...
const	EXT_CREATE = 4
	Create action. More...
const	EXT_UPDATE = 5
	Update action. More...
const	EXT_TYPE_DECIMAL = 'decimal'
	Decimal outcome type. More...
const	EXT_TYPE_PERCENTAGE = 'percentage'
	Percentage outcome type. More...
const	EXT_TYPE_RATIO = 'ratio'
	Ratio outcome type. More...
const	EXT_TYPE_LETTER_AF = 'letteraf'
	Letter (A-F) outcome type. More...
const	EXT_TYPE_LETTER_AF_PLUS = 'letterafplus'
	Letter (A-F) with optional +/- outcome type. More...
const	EXT_TYPE_PASS_FAIL = 'passfail'
	Pass/fail outcome type. More...
const	EXT_TYPE_TEXT = 'freetext'
	Free text outcome type. More...
string	$title = null
	Context title. More...
string	$ltiResourceLinkId = null
	Resource link ID as supplied in the last connection request. 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...
string	$extRequest = null
	Request for last service request. More...
	$extRequestHeaders = null
	Request headers for last service request. More...
string	$extResponse = null
	Response from last service request. More...
	$extResponseHeaders = null
	Response header from last service request. More...
string	$primaryResourceLinkId = null
	Primary key value for resource link being shared (if any). More...
bool	$shareApproved = null
	Whether the sharing request has been approved by the primary resource link. 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 resource link from the database. More...
	checkValueType (Outcome $ltiOutcome, array $supportedTypes=null)
	Convert data type of value to a supported type if possible. More...
	doService (string $type, string $url, array $params, string $scope)
	Send an unofficial LTI service request to the platform. More...
	doResultService (UserResult $userResult, string $url)
	Send a request to the Result service endpoint. More...
	doScoreService (Outcome $ltiOutcome, UserResult $userResult, string $url)
	Send a service request to the Score service endpoint. More...
	doLTI11Service (string $type, string $url, string $xml)
	Send an LTI 1.1 service request to the platform. More...
	getLineItemService ()
	Get the Line Item service object. More...
	domnodeToArray ($node)
	Convert DOM nodes to array. More...

Private Attributes
int	$id = null
	Record ID for this resource link. More...
Platform	$platform = null
	Platform for this resource link. More...
int	$platformId = null
	Platform ID for this resource link. More...
Context	$context = null
	Context for this resource link. More...
int	$contextId = null
	Context ID for this resource link. 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...
DOMDocument	$extDoc = null
	XML document for the last extension service request. More...
array	$extNodes = null
	XML node array for the last extension service request. More...
DataConnector	$dataConnector = null
	Data connector object or string. More...

Detailed Description

Class to represent a platform resource link.

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 35 of file ResourceLink.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LTI\ToolProvider\ResourceLink::__construct

(

)

Class constructor.

Definition at line 276 of file ResourceLink.php.

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

    {
        $this->initialize();
    }

Here is the call graph for this function:

Member Function Documentation

checkValueType()

ILIAS\LTI\ToolProvider\ResourceLink::checkValueType ( Outcome  $ltiOutcome, array  $supportedTypes = null  )

private

Convert data type of value to a supported type if possible.

Parameters

Outcome	$ltiOutcome	Outcome object
array | null	$supportedTypes	Array of outcome types to be supported (optional, default is null to use supported types reported in the last launch for this resource link)

Returns

bool True if the type/value are valid and supported

Definition at line 1467 of file ResourceLink.php.

References $parts, ILIAS\LTI\ToolProvider\ResourceLink\getSetting(), ILIAS\LTI\ToolProvider\Outcome\getValue(), and ILIAS\LTI\ToolProvider\Outcome\setValue().

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

                                                                                      : bool
    {
        if (empty($supportedTypes)) {
            $supportedTypes = explode(
                ',',
                str_replace(' ', '', strtolower($this->getSetting('ext_ims_lis_resultvalue_sourcedids', self::EXT_TYPE_DECIMAL)))
            );
        }
        $type = $ltiOutcome->type;
        $value = $ltiOutcome->getValue();
        // Check whether the type is supported or there is no value
        $ok = in_array($type, $supportedTypes) || empty($value);
        if (!$ok) {
            // Convert numeric values to decimal
            if ($type === self::EXT_TYPE_PERCENTAGE) {
                if (substr($value, -1) === '%') {
                    $value = substr($value, 0, -1);
                }
                $ok = is_numeric($value) && ($value >= 0) && ($value <= 100);
                if ($ok) {
                    $ltiOutcome->setValue($value / 100);
                    $ltiOutcome->type = self::EXT_TYPE_DECIMAL;
                }
            } elseif ($type === self::EXT_TYPE_RATIO) {
                $parts = explode('/', $value, 2);
                $ok = (count($parts) === 2) && is_numeric($parts[0]) && is_numeric($parts[1]) && ($parts[0] >= 0) && ($parts[1] > 0);
                if ($ok) {
                    $ltiOutcome->setValue($parts[0] / $parts[1]);
                    $ltiOutcome->type = self::EXT_TYPE_DECIMAL;
                }
                // Convert letter_af to letter_af_plus or text
            } elseif ($type === self::EXT_TYPE_LETTER_AF) {
                if (in_array(self::EXT_TYPE_LETTER_AF_PLUS, $supportedTypes)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_LETTER_AF_PLUS;
                } elseif (in_array(self::EXT_TYPE_TEXT, $supportedTypes)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_TEXT;
                }
                // Convert letter_af_plus to letter_af or text
            } elseif ($type === self::EXT_TYPE_LETTER_AF_PLUS) {
                if (in_array(self::EXT_TYPE_LETTER_AF, $supportedTypes) && (strlen($value) === 1)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_LETTER_AF;
                } elseif (in_array(self::EXT_TYPE_TEXT, $supportedTypes)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_TEXT;
                }
                // Convert text to decimal
            } elseif ($type === self::EXT_TYPE_TEXT) {
                $ok = is_numeric($value) && ($value >= 0) && ($value <= 1);
                if ($ok) {
                    $ltiOutcome->type = self::EXT_TYPE_DECIMAL;
                } elseif (substr($value, -1) === '%') {
                    $value = substr($value, 0, -1);
                    $ok = is_numeric($value) && ($value >= 0) && ($value <= 100);
                    if ($ok) {
                        if (in_array(self::EXT_TYPE_PERCENTAGE, $supportedTypes)) {
                            $ltiOutcome->type = self::EXT_TYPE_PERCENTAGE;
                        } else {
                            $ltiOutcome->setValue($value / 100);
                            $ltiOutcome->type = self::EXT_TYPE_DECIMAL;
                        }
                    }
                }
            }
        }

        return $ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createLineItem()

ILIAS\LTI\ToolProvider\ResourceLink::createLineItem

(

LineItem

$lineItem

)

Create a new line item.

Parameters

LineItem

$lineItem

Line item object

Returns

bool True if successful

Definition at line 1289 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId, and ILIAS\LTI\ToolProvider\ResourceLink\getLineItemService().

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

        return $ok;
    }

Here is the call graph for this function:

delete()

ILIAS\LTI\ToolProvider\ResourceLink::delete

(

)

Delete the resource link from the database.

Returns

bool True if the resource link was successfully deleted.

Definition at line 326 of file ResourceLink.php.

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

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

Here is the call graph for this function:

doAssessmentControlAction()

ILIAS\LTI\ToolProvider\ResourceLink::doAssessmentControlAction	(	AssessmentControlAction	$assessmentControlAction,
		User	$user,
		int	$attemptNumber
	)

Perform an Assessment Control action.

Parameters

AssessmentControlAction	$assessmentControlAction	Assessment control object
User	$user	User object
int	$attemptNumber	Number of attempt

Returns

string|bool The response status or false if the request was not successfully processed

Definition at line 1336 of file ResourceLink.php.

References $http, $url, and ILIAS\LTI\ToolProvider\ResourceLink\getSetting().

    {
        $status = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        $url = $this->getSetting('custom_ap_acs_url');
        if (!empty($url)) {
            $assessmentControlService = new Service\AssessmentControl($this, $url);
            $status = $assessmentControlService->submitAction($assessmentControlAction, $user, $attemptNumber);
            $http = $assessmentControlService->getHttpMessage();
            $this->extResponse = $http->response;
            $this->extResponseHeaders = $http->responseHeaders;
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $status;
    }

Here is the call graph for this function:

doLTI11Service()

ILIAS\LTI\ToolProvider\ResourceLink::doLTI11Service ( string  $type, string  $url, string  $xml  )

private

Send an LTI 1.1 service request to the platform.

Parameters

string	$type	Message type value
string	$url	URL to send request to
string	$xml	XML of message request

Returns

bool True if the request successfully obtained a response

Definition at line 1681 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, Vendor\Package\$e, $http, $scope, ILIAS\LTI\ToolProvider\ResourceLink\domnodeToArray(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), and ILIAS\LTI\ToolProvider\useOAuth1().

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

                                                                           : bool
    {
        $ok = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        if (!empty($url)) {
            $id = uniqid();
            $xmlRequest = <<< EOD
<?xml version = "1.0" encoding = "UTF-8"?>
<imsx_POXEnvelopeRequest xmlns = "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
  <imsx_POXHeader>
    <imsx_POXRequestHeaderInfo>
      <imsx_version>V1.0</imsx_version>
      <imsx_messageIdentifier>{$id}</imsx_messageIdentifier>
    </imsx_POXRequestHeaderInfo>
  </imsx_POXHeader>
  <imsx_POXBody>
    <{$type}Request>
{$xml}
    </{$type}Request>
  </imsx_POXBody>
</imsx_POXEnvelopeRequest>
EOD;
            $scope = 'https://purl.imsglobal.org/spec/lti-bo/scope/basicoutcome';
            $retry = false;
            $newToken = false;
            if (!$this->getPlatform()->useOAuth1()) {
                $accessToken = $this->platform->getAccessToken();
                $retry = true;
                if (empty($accessToken)) {
                    $accessToken = new AccessToken($this->platform);
                    $this->platform->setAccessToken($accessToken);
                }
                if (!$accessToken->hasScope($scope) && (empty(Tool::$defaultTool) || !in_array(
                    $scope,
                    Tool::$defaultTool->requiredScopes
                ))) {
                    $accessToken->expires = time();
                    $accessToken->get($scope, true);
                    $this->platform->setAccessToken($accessToken);
                    $newToken = true;
                }
            }
            do {
                // Add message signature
                $header = $this->getPlatform()->addSignature($url, $xmlRequest, 'POST', 'application/xml');
                // Connect to platform
                $http = new \ILIAS\LTI\ToolProvider\Http\HttpMessage($url, 'POST', $xmlRequest, $header);
                if ($http->send()) {
                    // Parse XML response
                    $this->extResponse = $http->response;
                    $this->extResponseHeaders = $http->responseHeaders;
                    try {
                        $this->extDoc = new DOMDocument();
                        $this->extDoc->loadXML($http->response);
                        $this->extNodes = $this->domnodeToArray($this->extDoc->documentElement);
                        if (isset($this->extNodes['imsx_POXHeader']['imsx_POXResponseHeaderInfo']['imsx_statusInfo']['imsx_codeMajor']) &&
                            ($this->extNodes['imsx_POXHeader']['imsx_POXResponseHeaderInfo']['imsx_statusInfo']['imsx_codeMajor'] === 'success')) {
                            $ok = true;
                        }
                    } catch (\Exception $e) {
                    }
                }
                $retry = $retry && !$newToken && !$ok;
                if ($retry) {  // Obtain a new access token just for the required scope
                    $accessToken = $this->platform->getAccessToken();
                    $accessToken->expires = time();
                    $accessToken->get($scope, true);
                    $this->platform->setAccessToken($accessToken);
                    $newToken = true;
                }
            } while ($retry);
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

domnodeToArray()

ILIAS\LTI\ToolProvider\ResourceLink::domnodeToArray (   $node )

private

Convert DOM nodes to array.

Parameters

DOMElement | \DOMText

$node

XML element

Returns

array|string Array of XML document elements

Definition at line 1786 of file ResourceLink.php.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\doLTI11Service(), and ILIAS\LTI\ToolProvider\ResourceLink\doService().

    {
        $output = array();
        switch ($node->nodeType) {
            case XML_CDATA_SECTION_NODE:
            case XML_TEXT_NODE:
                $output = trim($node->textContent);
                break;
            case XML_ELEMENT_NODE:
                for ($i = 0; $i < $node->childNodes->length; $i++) {
                    $child = $node->childNodes->item($i);
                    $v = $this->domnodeToArray($child);
                    if (isset($child->tagName)) {
                        $output[$child->tagName][] = $v;
                    } else {
                        $s = (string) $v;
                        if (!empty($s)) {
                            $output = $s;
                        }
                    }
                }
                if (is_array($output)) {
                    if ($node->hasAttributes()) {
                        foreach ($node->attributes as $attrNode) {
                            $output['@attributes'][$attrNode->name] = (string) $attrNode->value;
                        }
                    }
                    foreach ($output as $t => $v) {
                        if (is_array($v) && (count($v) === 1) && ($t !== '@attributes')) {
                            $output[$t] = $v[0];
                        }
                    }
                }
                break;
        }

        return $output;
    }

Here is the caller graph for this function:

doOutcomesService()

ILIAS\LTI\ToolProvider\ResourceLink::doOutcomesService	(	int	$action,
		Outcome	$ltiOutcome,
		UserResult	$userResult
	)

Perform an Outcomes service request.

Parameters

int	$action	The action type constant
Outcome	$ltiOutcome	Outcome object
UserResult	$userResult	UserResult object

Returns

bool True if the request was successfully processed

Definition at line 718 of file ResourceLink.php.

References $comment, ILIAS\LTI\ToolProvider\ApiHook\$OUTCOMES_SERVICE_HOOK, $params, $response, ILIAS\LTI\ToolProvider\ResourceLink\checkValueType(), ILIAS\LTI\ToolProvider\ResourceLink\doLTI11Service(), ILIAS\LTI\ToolProvider\ResourceLink\doResultService(), ILIAS\LTI\ToolProvider\ResourceLink\doScoreService(), ILIAS\LTI\ToolProvider\ResourceLink\doService(), ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), ILIAS\LTI\ToolProvider\Outcome\getPointsPossible(), ILIAS\LTI\ToolProvider\UserResult\getResourceLink(), ILIAS\LTI\ToolProvider\Outcome\getValue(), ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\LTI\ToolProvider\Outcome\setValue().

                                                                                               : bool
    {
        $ok = false;
        $this->extResponse = '';
        // Lookup service details from the source resource link appropriate to the user (in case the destination is being shared)
        $sourceResourceLink = $userResult->getResourceLink();
        $sourcedId = $userResult->ltiResultSourcedId;

        // Use LTI 1.1 service in preference to extension service if it is available
        $urlAGS = $sourceResourceLink->getSetting('custom_lineitem_url');
        $urlLTI11 = $sourceResourceLink->getSetting('lis_outcome_service_url');
        $urlExt = $sourceResourceLink->getSetting('ext_ims_lis_basic_outcome_url');

        if (!empty($urlAGS)) {
            if (($action === self::EXT_READ) && ($ltiOutcome->type === self::EXT_TYPE_DECIMAL) && $sourceResourceLink->hasResultService()) {
                $ltiOutcome = $this->doResultService($userResult, $urlAGS);
                $ok = !empty($ltiOutcome);
            } elseif ((($action === self::EXT_WRITE) && $this->checkValueType($ltiOutcome, array(self::EXT_TYPE_DECIMAL)) && $sourceResourceLink->hasScoreService()) ||
                ($action === self::EXT_DELETE)) {
                if ($action === self::EXT_DELETE) {
                    $ltiOutcome->setValue(null);
                    $ltiOutcome->activityProgress = 'Initialized';
                    $ltiOutcome->gradingProgress = 'NotReady';
                }
                $ok = $this->doScoreService($ltiOutcome, $userResult, $urlAGS);
            }
        }
        if (!$ok && is_null($ltiOutcome->getValue())) {
            $ltiOutcome->setValue('');
        }
        if (!$ok && !empty($urlLTI11)) {
            $do = '';
            $outcome = $ltiOutcome->getValue();
            if (($action === self::EXT_READ) && ($ltiOutcome->type === self::EXT_TYPE_DECIMAL)) {
                $do = 'readResult';
            } elseif (($action === self::EXT_WRITE) && $this->checkValueType($ltiOutcome, array(self::EXT_TYPE_DECIMAL))) {
                $do = 'replaceResult';
                if (($ltiOutcome->getPointsPossible() <> 1) && ($ltiOutcome->getPointsPossible() > 0)) {
                    $outcome = $outcome / $ltiOutcome->getPointsPossible();
                }
            } elseif ($action === self::EXT_DELETE) {
                $do = 'deleteResult';
            }
            if (!empty($do)) {
                $xml = '';
                if ($action === self::EXT_WRITE) {
                    $comment = (empty($ltiOutcome->comment)) ? '' : trim($ltiOutcome->comment);
                    if (!empty($comment) && !empty($sourceResourceLink->getSetting('ext_outcome_data_values_accepted'))) {
                        $resultDataTypes = explode(',', $sourceResourceLink->getSetting('ext_outcome_data_values_accepted'));
                        $resultDataType = '';
                        if (count($resultDataTypes) === 1) {
                            $resultDataType = $resultDataTypes[0];
                        } elseif (count($resultDataTypes) > 1) {
                            $isUrl = (strpos($comment, 'http://') === 0) || (strpos($comment, 'https://') === 0);
                            if ($isUrl && in_array('ltiLaunchUrl', $resultDataTypes)) {
                                $resultDataType = 'ltiLaunchUrl';
                            } elseif ($isUrl && in_array('url', $resultDataTypes)) {
                                $resultDataType = 'url';
                            } elseif (in_array('text', $resultDataTypes)) {
                                $resultDataType = 'text';
                            }
                        }
                        if (!empty($resultDataType)) {
                            $xml = <<< EOF

          <resultData>
            <{$resultDataType}>{$comment}</{$resultDataType}>
          </resultData>
EOF;
                        }
                    }
                    $xml = <<< EOF

        <result>
          <resultScore>
            <language>{$ltiOutcome->language}</language>
            <textString>{$outcome}</textString>
          </resultScore>{$xml}
        </result>
EOF;
                }
                $sourcedId = htmlentities($sourcedId);
                $xml = <<<EOF
      <resultRecord>
        <sourcedGUID>
          <sourcedId>{$sourcedId}</sourcedId>
        </sourcedGUID>{$xml}
      </resultRecord>
EOF;
                if ($this->doLTI11Service($do, $urlLTI11, $xml)) {
                    switch ($action) {
                        case self::EXT_READ:
                            if (!isset($this->extNodes['imsx_POXBody']["{$do}Response"]['result']['resultScore']['textString'])) {
                                break;
                            } else {
                                $ltiOutcome->setValue($this->extNodes['imsx_POXBody']["{$do}Response"]['result']['resultScore']['textString']);
                            }
                            // no break
                        case self::EXT_WRITE:
                        case self::EXT_DELETE:
                            $ok = true;
                            break;
                    }
                }
            }
        }
        if (!$ok && !empty($urlExt)) {
            $do = '';
            $outcome = $ltiOutcome->getValue();
            if (($action === self::EXT_READ) && ($ltiOutcome->type === self::EXT_TYPE_DECIMAL)) {
                $do = 'basic-lis-readresult';
            } elseif (($action === self::EXT_WRITE) && $this->checkValueType($ltiOutcome, array(self::EXT_TYPE_DECIMAL))) {
                $do = 'basic-lis-updateresult';
                if (($ltiOutcome->getPointsPossible() <> 1) && ($ltiOutcome->getPointsPossible() > 0)) {
                    $outcome = $outcome / $ltiOutcome->getPointsPossible();
                }
            } elseif ($action === self::EXT_DELETE) {
                $do = 'basic-lis-deleteresult';
            }
            if (!empty($do)) {
                $params = array();
                $params['sourcedid'] = $sourcedId;
                $params['result_resultscore_textstring'] = $outcome;
                if (!empty($ltiOutcome->language)) {
                    $params['result_resultscore_language'] = $ltiOutcome->language;
                }
                if (!empty($ltiOutcome->status)) {
                    $params['result_statusofresult'] = $ltiOutcome->status;
                }
                if (!empty($ltiOutcome->date)) {
                    $params['result_date'] = $ltiOutcome->date;
                }
                if (!empty($ltiOutcome->type)) {
                    $params['result_resultvaluesourcedid'] = $ltiOutcome->type;
                }
                if (!empty($ltiOutcome->dataSource)) {
                    $params['result_datasource'] = $ltiOutcome->dataSource;
                }
                if ($this->doService($do, $urlExt, $params, 'https://purl.imsglobal.org/spec/lti-ext/scope/outcomes')) {
                    switch ($action) {
                        case self::EXT_READ:
                            if (isset($this->extNodes['result']['resultscore']['textstring'])) {
                                $ltiOutcome->setValue($this->extNodes['result']['resultscore']['textstring']);
                            }
                            // no break
                        case self::EXT_WRITE:
                        case self::EXT_DELETE:
                            $ok = true;
                            break;
                    }
                }
            }
        }
        if ((!$ok) && $this->hasConfiguredApiHook(self::$OUTCOMES_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this)) {
            $className = $this->getApiHook(self::$OUTCOMES_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $response = $hook->doOutcomesService($action, $ltiOutcome, $userResult);
            if ($response !== false) {
                $ok = true;
                if ($action === self::EXT_READ) {
                    $ltiOutcome->setValue($response);
                }
            }
        }

        return $ok;
    }

Here is the call graph for this function:

doResultService()

ILIAS\LTI\ToolProvider\ResourceLink::doResultService ( UserResult  $userResult, string  $url  )

private

Send a request to the Result service endpoint.

Parameters

UserResult	$userResult	UserResult object
string	$url	URL to send request to

Returns

Outcome Outcome object

Definition at line 1622 of file ResourceLink.php.

References $http, and ILIAS\LTI\ToolProvider\ResourceLink\getPlatform().

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

                                                                         : ?Outcome
    {
        $outcome = null;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        if (!empty($url)) {
            $resultService = new Service\Result($this->getPlatform(), $url);
            $outcome = $resultService->get($userResult);
            $http = $resultService->getHttpMessage();
            $this->extResponse = $http->response;
            $this->extResponseHeaders = $http->responseHeaders;
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $outcome;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doScoreService()

ILIAS\LTI\ToolProvider\ResourceLink::doScoreService ( Outcome  $ltiOutcome, UserResult  $userResult, string  $url  )

private

Send a service request to the Score service endpoint.

Parameters

Outcome	$ltiOutcome	Outcome object
UserResult	$userResult	UserResult object
string	$url	URL to send request to

Returns

bool True if the request successfully obtained a response

Definition at line 1651 of file ResourceLink.php.

References $http, and ILIAS\LTI\ToolProvider\ResourceLink\getPlatform().

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

                                                                                             : bool
    {
        $ok = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        if (!empty($url)) {
            $scoreService = new Service\Score($this->getPlatform(), $url);
            $scoreService->submit($ltiOutcome, $userResult);
            $http = $scoreService->getHttpMessage();
            $this->extResponse = $http->response;
            $this->extResponseHeaders = $http->responseHeaders;
            $ok = $http->ok;
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doService()

ILIAS\LTI\ToolProvider\ResourceLink::doService ( string  $type, string  $url, array  $params, string  $scope  )

private

Send an unofficial LTI service request to the platform.

Parameters

string	$type	Message type value
string	$url	URL to send request to
array	$params	Associative array of parameter values to be passed
string	$scope	Scope for service

Returns

bool True if the request successfully obtained a response

Definition at line 1546 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, Vendor\Package\$e, $http, ILIAS\LTI\ToolProvider\ResourceLink\domnodeToArray(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), and ILIAS\LTI\ToolProvider\useOAuth1().

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService(), ILIAS\LTI\ToolProvider\ResourceLink\doSettingService(), and ILIAS\LTI\ToolProvider\ResourceLink\getMemberships().

                                                                                       : bool
    {
        $ok = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        if (!empty($url)) {
            $params['lti_version'] = $this->getPlatform()->ltiVersion;
            $params['lti_message_type'] = $type;
            $retry = false;
            $newToken = false;
            if (!$this->getPlatform()->useOAuth1()) {
                $accessToken = $this->platform->getAccessToken();
                $retry = true;
                if (empty($accessToken)) {
                    $accessToken = new AccessToken($this->platform);
                    $this->platform->setAccessToken($accessToken);
                }
                if (!$accessToken->hasScope($scope) && (empty(Tool::$defaultTool) || !in_array(
                    $scope,
                    Tool::$defaultTool->requiredScopes
                ))) {
                    $accessToken->expires = time();
                    $accessToken->get($scope, true);
                    $this->platform->setAccessToken($accessToken);
                    $newToken = true;
                }
            }
            do {
                // Add message signature
                $signed = $this->getPlatform()->addSignature($url, $params, 'POST', 'application/x-www-form-urlencoded');
                // Connect to platform
                if (is_array($signed)) {
                    $http = new HttpMessage($url, 'POST', $signed);
                } else {
                    $http = new HttpMessage($url, 'POST', $params, $signed);
                }
                if ($http->send()) {
                    // Parse XML response
                    $this->extResponse = $http->response;
                    $this->extResponseHeaders = $http->responseHeaders;
                    try {
                        $this->extDoc = new DOMDocument();
                        $this->extDoc->loadXML($http->response);
                        $this->extNodes = $this->domnodeToArray($this->extDoc->documentElement);
                        if (isset($this->extNodes['statusinfo']['codemajor']) && ($this->extNodes['statusinfo']['codemajor'] === 'Success')) {
                            $ok = true;
                        }
                    } catch (\Exception $e) {
                    }
                }
                $retry = $retry && !$newToken && !$ok;
                if ($retry) {  // Obtain a new access token just for the required scope
                    $accessToken = $this->platform->getAccessToken();
                    $accessToken->expires = time();
                    $accessToken->get($scope, true);
                    $this->platform->setAccessToken($accessToken);
                    $newToken = true;
                }
            } while ($retry);
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doSettingService()

ILIAS\LTI\ToolProvider\ResourceLink::doSettingService	(	int	$action,
		string	$value = null
	)

Perform a Memberships extension service request.

The userResult table is updated with any user objects with lis_result_sourcedid values.

Parameters

bool

$withGroups

True is group information is to be requested as well

Returns

mixed Array of UserResult objects or False if the request was not successful

Deprecated:

Use getMemberships() instead

See also

ResourceLink::getMemberships() Perform a Setting service request.

Parameters

int	$action	The action type constant
string | null	$value	The setting value (optional, default is null)

Returns

mixed The setting value for a read action, true if a write or delete action was successful, otherwise false

Definition at line 907 of file ResourceLink.php.

References $params, $response, $url, ILIAS\LTI\ToolProvider\ResourceLink\doService(), ILIAS\LTI\ToolProvider\ResourceLink\getSetting(), ILIAS\LTI\ToolProvider\ResourceLink\saveSettings(), and ILIAS\LTI\ToolProvider\ResourceLink\setSetting().

    {
        $response = false;
        $this->extResponse = '';
        switch ($action) {
            case self::EXT_READ:
                $do = 'basic-lti-loadsetting';
                break;
            case self::EXT_WRITE:
                $do = 'basic-lti-savesetting';
                break;
            case self::EXT_DELETE:
                $do = 'basic-lti-deletesetting';
                break;
        }
        if (isset($do)) {
            $url = $this->getSetting('ext_ims_lti_tool_setting_url');
            $params = array();
            $params['id'] = $this->getSetting('ext_ims_lti_tool_setting_id');
            if (is_null($value)) {
                $value = '';
            }
            $params['setting'] = $value;

            if ($this->doService($do, $url, $params, 'https://purl.imsglobal.org/spec/lti-ext/scope/setting')) {
                switch ($action) {
                    case self::EXT_READ:
                        if (isset($this->extNodes['setting']['value'])) {
                            $response = $this->extNodes['setting']['value'];
                            if (is_array($response)) {
                                $response = '';
                            }
                        }
                        break;
                    case self::EXT_WRITE:
                        $this->setSetting('ext_ims_lti_tool_setting', $value);
                        $this->saveSettings();
                        $response = true;
                        break;
                    case self::EXT_DELETE:
                        $response = true;
                        break;
                }
            }
        }

        return $response;
    }

Here is the call graph for this function:

fromContext()

static ILIAS\LTI\ToolProvider\ResourceLink::fromContext ( Context  $context, string  $ltiResourceLinkId, string  $tempId = null  )

static

Class constructor from context.

Parameters

Context	$context	Context object
string	$ltiResourceLinkId	Resource link ID value
string | null	$tempId	Temporary Resource link ID value (optional, default is null)

Returns

ResourceLink

Definition at line 1410 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId, and ILIAS\LTI\ToolProvider\Context\getDataConnector().

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

                                                                                                          : ResourceLink
    {
        $resourceLink = new ResourceLink();
        $resourceLink->setContext($context);
        $resourceLink->dataConnector = $context->getDataConnector();
        $resourceLink->ltiResourceLinkId = $ltiResourceLinkId;
        if (!empty($ltiResourceLinkId)) {
            $resourceLink->load();
            if (is_null($resourceLink->id) && !empty($tempId)) {
                $resourceLink->ltiResourceLinkId = $tempId;
                $resourceLink->load();
                $resourceLink->ltiResourceLinkId = $ltiResourceLinkId;
            }
            $resourceLink->setContext($context);  // Ensure context remains set
        }

        return $resourceLink;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fromPlatform()

static ILIAS\LTI\ToolProvider\ResourceLink::fromPlatform ( Platform  $platform, string  $ltiResourceLinkId, string  $tempId = null  )

static

Class constructor from consumer.

Deprecated:

Use fromPlatform() instead

See also

ResourceLink::fromPlatform()

Parameters

ToolConsumer	$consumer	Consumer object
string	$ltiResourceLinkId	Resource link ID value
string	$tempId	Temporary Resource link ID value (optional, default is null)

Returns

ResourceLink Class constructor from platform.

Parameters

Platform	$platform	Platform object
string	$ltiResourceLinkId	Resource link ID value
string | null	$tempId	Temporary Resource link ID value (optional, default is null)

Returns

ResourceLink

Definition at line 1385 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId, ILIAS\LTI\ToolProvider\ResourceLink\$platform, and ILIAS\LTI\ToolProvider\Platform\getDataConnector().

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

                                                                                                             : ResourceLink
    {
        $resourceLink = new ResourceLink();
        $resourceLink->platform = $platform;
        $resourceLink->dataConnector = $platform->getDataConnector();
        $resourceLink->ltiResourceLinkId = $ltiResourceLinkId;
        if (!empty($ltiResourceLinkId)) {
            $resourceLink->load();
            if (is_null($resourceLink->id) && !empty($tempId)) {
                $resourceLink->ltiResourceLinkId = $tempId;
                $resourceLink->load();
                $resourceLink->ltiResourceLinkId = $ltiResourceLinkId;
            }
        }

        return $resourceLink;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fromRecordId()

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

static

Load the resource link from the database.

Parameters

int	$id	Record ID of resource link
DataConnector	$dataConnector	Database connection object

Returns

ResourceLink ResourceLink object

Definition at line 1435 of file ResourceLink.php.

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

Referenced by ILIAS\LTI\ToolProvider\Tool\checkForShare(), ILIAS\LTI\ToolProvider\UserResult\getResourceLink(), ilLTIAppEventListener\handleOutcomeWithoutLP(), and ilLTIAppEventListener\tryOutcomeService().

                                                                              : ResourceLink
    {
        $resourceLink = new ResourceLink();
        $resourceLink->dataConnector = $dataConnector;
        $resourceLink->load($id);

        return $resourceLink;
    }

Here is the caller graph for this function:

getContext()

ILIAS\LTI\ToolProvider\ResourceLink::getContext

(

)

Get context.

Returns

Context|null LTIContext object for this resource link.

Definition at line 420 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$context, ILIAS\LTI\ToolProvider\Context\fromRecordId(), and ILIAS\LTI\ToolProvider\ResourceLink\getDataConnector().

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\getMemberships(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), ILIAS\LTI\ToolProvider\ResourceLink\hasMembershipsService(), ilLTIDataConnector\loadResourceLink(), and ilLTIDataConnector\saveResourceLink().

                                : ?Context
    {
        if (is_null($this->context) && !is_null($this->contextId)) {
            $this->context = Context::fromRecordId($this->contextId, $this->getDataConnector());
        }

        return $this->context;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContextId()

ILIAS\LTI\ToolProvider\ResourceLink::getContextId

(

)

Get context record ID.

Returns

int|null Context record ID for this resource link.

Definition at line 434 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$contextId.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\getMemberships(), ILIAS\LTI\ToolProvider\ResourceLink\hasMembershipsService(), and ilLTIDataConnector\saveResourceLink().

                                  : ?int
    {
        if (is_null($this->contextId) && !is_null($this->context)) {
            $this->contextId = $this->context->getRecordId();
        }

        return $this->contextId;
    }

Here is the caller graph for this function:

getDataConnector()

ILIAS\LTI\ToolProvider\ResourceLink::getDataConnector

(

)

Get the data connector.

Returns

DataConnector|null Data connector object or string

Definition at line 509 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$dataConnector, and ILIAS\LTI\ToolProvider\ResourceLink\getPlatform().

Referenced by ILIAS\LTI\ToolProvider\ResourceLinkShareKey\__construct(), ILIAS\LTI\ToolProvider\ResourceLink\delete(), ILIAS\LTI\ToolProvider\UserResult\fromResourceLink(), ILIAS\LTI\ToolProvider\ResourceLink\getContext(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), ILIAS\LTI\ToolProvider\ResourceLink\getShares(), ILIAS\LTI\ToolProvider\ResourceLink\getUserResultSourcedIDs(), ILIAS\LTI\ToolProvider\ResourceLink\load(), and ILIAS\LTI\ToolProvider\ResourceLink\save().

                                      : ?DataConnector
    {
        if (empty($this->dataConnector)) {
            $this->getPlatform();
            if (!empty($this->platform)) {
                $this->dataConnector = $this->platform->getDataConnector();
            }
        }

        return $this->dataConnector;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ILIAS\LTI\ToolProvider\ResourceLink::getId

(

)

Get resource link ID.

Returns

string ID for this resource link.

Definition at line 480 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId.

Referenced by ilLTIDataConnector\loadResourceLink(), and ilLTIDataConnector\saveResourceLink().

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

Here is the caller graph for this function:

getKey()

ILIAS\LTI\ToolProvider\ResourceLink::getKey

(

)

Get consumer key.

Returns

string Consumer key value for this resource link.

Definition at line 470 of file ResourceLink.php.

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

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

Here is the call graph for this function:

getLineItems()

ILIAS\LTI\ToolProvider\ResourceLink::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

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

Definition at line 1262 of file ResourceLink.php.

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

    {
        $lineItems = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        $lineItemService = $this->getLineItemService();
        if (!empty($lineItemService)) {
            $lineItems = $lineItemService->getAll($this->ltiResourceLinkId, $resourceId, $tag, $limit);
            $http = $lineItemService->getHttpMessage();
            $this->extResponse = $http->response;
            $this->extResponseHeaders = $http->responseHeaders;
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $lineItems;
    }

Here is the call graph for this function:

getLineItemService()

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

private

Get the Line Item service object.

Returns

bool|Service Line Item service, or false if not available //erased Service\LineItem

Definition at line 1769 of file ResourceLink.php.

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

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\createLineItem(), and ILIAS\LTI\ToolProvider\ResourceLink\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\ResourceLink::getMembership

(

)

Get Membership.

Deprecated:

Use getMemberships() instead

See also

ResourceLink::getMemberships()

Returns

mixed The array of UserResult objects if successful, otherwise false

Definition at line 1044 of file ResourceLink.php.

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

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

Here is the call graph for this function:

getMemberships()

ILIAS\LTI\ToolProvider\ResourceLink::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 1058 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$id, ILIAS\LTI\ToolProvider\ApiHook\$MEMBERSHIPS_SERVICE_HOOK, $params, $service, $url, ILIAS\LTI\ToolProvider\ResourceLink\doService(), ILIAS\LTI\ToolProvider\UserResult\fromResourceLink(), ILIAS\LTI\ToolProvider\ApiHook\getApiHook(), ILIAS\LTI\ToolProvider\ResourceLink\getContext(), ILIAS\LTI\ToolProvider\ResourceLink\getContextId(), ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), ILIAS\LTI\ToolProvider\ResourceLink\getSetting(), ILIAS\LTI\ToolProvider\ResourceLink\getUserResultSourcedIDs(), ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook(), ILIAS\LTI\ToolProvider\Tool\ID_SCOPE_RESOURCE, ILIAS\LTI\ToolProvider\Service\Membership\MEDIA_TYPE_MEMBERSHIPS_NRPS, ILIAS\LTI\ToolProvider\Service\Membership\MEDIA_TYPE_MEMBERSHIPS_V1, and ILIAS\LTI\ToolProvider\parseRoles().

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

    {
        $ok = false;
        $userResults = array();
        $hasLtiLinkService = !empty($this->getSetting('custom_link_memberships_url'));
        $hasLtiContextService = !empty($this->getContextId()) &&
            (!empty($this->getContext()->getSetting('custom_context_memberships_url')) || !empty($this->getContext()->getSetting('custom_context_memberships_v2_url')));
        $hasGroupsService = !empty($this->getContextId()) && !empty($this->getContext()->getSetting('custom_context_groups_url'));
        $hasExtService = !empty($this->getSetting('ext_ims_lis_memberships_url'));
        $hasApiHook = $this->hasConfiguredApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        if (($hasLtiContextService && (!$withGroups || $hasGroupsService)) || (!$hasExtService && !$hasApiHook)) {
            if (!empty($this->getContextId()) && !empty($this->getContext()->getSetting('custom_context_memberships_v2_url'))) {
                $url = $this->getContext()->getSetting('custom_context_memberships_v2_url');
                $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_NRPS;
            } else {
                $url = $this->getContext()->getSetting('custom_context_memberships_url');
                $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_V1;
            }
            $service = new Service\Membership($this, $url, $format);
            if (!$withGroups) {
                $userResults = $service->get();
            } else {
                $userResults = $service->getWithGroups();
            }
            $this->lastServiceRequest = $service->getHttpMessage();
            $ok = $userResults !== false;
        } elseif ($hasLtiLinkService) {
            $id = $this->id;
            $this->id = null;
            $url = $this->getSetting('custom_link_memberships_url');
            $format = Service\Membership::MEDIA_TYPE_MEMBERSHIPS_V1;
            $service = new Service\Membership($this, $url, $format);
            if (!$withGroups) {
                $userResults = $service->get();
            } else {
                $userResults = $service->getWithGroups();
            }
            $this->lastServiceRequest = $service->getHttpMessage();
            $this->id = $id;
            $ok = $userResults !== false;
        }
        if (!$ok && $hasExtService) {
            $this->extResponse = '';
            $url = $this->getSetting('ext_ims_lis_memberships_url');
            $params = array();
            $params['id'] = $this->getSetting('ext_ims_lis_memberships_id');
            if ($withGroups) {
                $ok = $this->doService(
                    'basic-lis-readmembershipsforcontextwithgroups',
                    $url,
                    $params,
                    'https://purl.imsglobal.org/spec/lti-ext/scope/memberships'
                );
            }
            if (!$ok) {
                $ok = $this->doService(
                    'basic-lis-readmembershipsforcontext',
                    $url,
                    $params,
                    'https://purl.imsglobal.org/spec/lti-ext/scope/memberships'
                );
            }
            if ($ok) {
                $this->groupSets = array();
                $this->groups = array();
                if (isset($this->extNodes['memberships'])) {
                    $memberships = $this->extNodes['memberships'];
                } elseif (isset($this->extNodes['members'])) {
                    $memberships = $this->extNodes['members'];
                } else {
                    $ok = false;
                }
            }
            if ($ok) {
                if (!isset($memberships['member'])) {
                    $members = array();
                } elseif (!isset($memberships['member'][0])) {
                    $members = array();
                    $members[0] = $memberships['member'];
                } else {
                    $members = $memberships['member'];
                }

                for ($i = 0; $i < count($members); $i++) {
                    $userresult = UserResult::fromResourceLink($this, $members[$i]['user_id']);

                    // Set the user name
                    $firstname = (isset($members[$i]['person_name_given'])) ? $members[$i]['person_name_given'] : '';
                    $lastname = (isset($members[$i]['person_name_family'])) ? $members[$i]['person_name_family'] : '';
                    $fullname = (isset($members[$i]['person_name_full'])) ? $members[$i]['person_name_full'] : '';
                    $userresult->setNames($firstname, $lastname, $fullname);

                    // Set the sourcedId
                    if (isset($members[$i]['person_sourcedid'])) {
                        $userresult->sourcedId = $members[$i]['person_sourcedid'];
                    }

                    // Set the user email
                    $email = (isset($members[$i]['person_contact_email_primary'])) ? $members[$i]['person_contact_email_primary'] : '';
                    $userresult->setEmail($email, $this->getPlatform()->defaultEmail);

                    // Set the user roles
                    if (isset($members[$i]['roles'])) {
                        $userresult->roles = Tool::parseRoles($members[$i]['roles']);
                    }

                    // Set the user groups
                    if (!isset($members[$i]['groups']['group'])) {
                        $groups = array();
                    } elseif (!isset($members[$i]['groups']['group'][0])) {
                        $groups = array();
                        $groups[0] = $members[$i]['groups']['group'];
                    } else {
                        $groups = $members[$i]['groups']['group'];
                    }
                    for ($j = 0; $j < count($groups); $j++) {
                        $group = $groups[$j];
                        if (isset($group['set'])) {
                            $set_id = $group['set']['id'];
                            if (!isset($this->groupSets[$set_id])) {
                                $this->groupSets[$set_id] = array('title' => $group['set']['title'], 'groups' => array(),
                                                                  'num_members' => 0, 'num_staff' => 0, 'num_learners' => 0);
                            }
                            $this->groupSets[$set_id]['num_members']++;
                            if ($userresult->isStaff()) {
                                $this->groupSets[$set_id]['num_staff']++;
                            }
                            if ($userresult->isLearner()) {
                                $this->groupSets[$set_id]['num_learners']++;
                            }
                            if (!in_array($group['id'], $this->groupSets[$set_id]['groups'])) {
                                $this->groupSets[$set_id]['groups'][] = $group['id'];
                            }
                            $this->groups[$group['id']] = array('title' => $group['title'], 'set' => $set_id);
                        } else {
                            $this->groups[$group['id']] = array('title' => $group['title']);
                        }
                        $userresult->groups[] = $group['id'];
                    }
                    if (isset($members[$i]['lis_result_sourcedid'])) {
                        $userresult->ltiResultSourcedId = $members[$i]['lis_result_sourcedid'];
                    }
                    $userResults[] = $userresult;
                }
            } else {
                $userResults = false;
            }
            $ok = $userResults !== false;
        }
        if (!$ok && $hasApiHook) {
            $className = $this->getApiHook(self::$MEMBERSHIPS_SERVICE_HOOK, $this->getPlatform()->getFamilyCode());
            $hook = new $className($this);
            $userResults = $hook->getMemberships($withGroups);
            $ok = $userResults !== false;
        }
        if ($ok) {
            $oldUsers = $this->getUserResultSourcedIDs(true, Tool::ID_SCOPE_RESOURCE);
            foreach ($userResults as $userresult) {
                // If a result sourcedid is provided save the user
                if (!empty($userresult->ltiResultSourcedId)) {
                    $userresult->save();
                }
                // Remove old user (if it exists)
                unset($oldUsers[$userresult->getId(Tool::ID_SCOPE_RESOURCE)]);
            }
            // Delete any old users which were not in the latest list from the platform
            foreach ($oldUsers as $id => $userresult) {
                $userresult->delete();
            }
        }

        return $userResults;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOutcomes()

ILIAS\LTI\ToolProvider\ResourceLink::getOutcomes

(

int

$limit = null

)

Get all outcomes.

Parameters

int | null

$limit

Limit of outcomes to be returned in each request, null for service default

Returns

Outcome[]|bool Array of Outcome objects or false on error

Definition at line 1306 of file ResourceLink.php.

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

    {
        $outcomes = false;
        $this->extRequest = '';
        $this->extRequestHeaders = '';
        $this->extResponse = '';
        $this->extResponseHeaders = '';
        $this->lastServiceRequest = null;
        $url = $this->getSetting('custom_lineitem_url');
        if (!empty($url)) {
            $resultService = new Service\Result($this->getPlatform(), $url);
            $outcomes = $resultService->getAll($limit);
            $http = $resultService->getHttpMessage();
            $this->extResponse = $http->response;
            $this->extResponseHeaders = $http->responseHeaders;
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
            $this->lastServiceRequest = $http;
        }

        return $outcomes;
    }

Here is the call graph for this function:

getPlatform()

ILIAS\LTI\ToolProvider\ResourceLink::getPlatform

(

)

Get tool consumer.

Deprecated:

Use getPlatform() instead

See also

Context::getPlatform()

Returns

ToolConsumer Tool consumer object for this resource link. Get tool consumer ID.

Deprecated:

Use getPlatformId() instead

See also

Context::getPlatformId()

Returns

int|null Tool Consumer ID for this resource link. Set tool consumer ID.

Deprecated:

Use setPlatformId() instead

See also

Context::setPlatformId()

Parameters

int

$consumerId

Tool Consumer ID for this resource link. Get platform.

Returns

Platform Platform object for this resource link.

Definition at line 381 of file ResourceLink.php.

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

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\doLTI11Service(), ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService(), ILIAS\LTI\ToolProvider\ResourceLink\doResultService(), ILIAS\LTI\ToolProvider\ResourceLink\doScoreService(), ILIAS\LTI\ToolProvider\ResourceLink\doService(), ILIAS\LTI\ToolProvider\ResourceLink\getDataConnector(), ILIAS\LTI\ToolProvider\ResourceLink\getKey(), ILIAS\LTI\ToolProvider\ResourceLink\getLineItemService(), ILIAS\LTI\ToolProvider\ResourceLink\getMemberships(), ILIAS\LTI\ToolProvider\ResourceLink\getOutcomes(), ILIAS\LTI\ToolProvider\ResourceLink\getToolSettings(), ILIAS\LTI\ToolProvider\ResourceLink\hasMembershipsService(), ILIAS\LTI\ToolProvider\ResourceLink\hasOutcomesService(), ILIAS\LTI\ToolProvider\ResourceLink\hasToolSettingsService(), ilLTIDataConnector\loadResourceLink(), ilLTIDataConnector\saveResourceLink(), and ILIAS\LTI\ToolProvider\ResourceLink\setToolSettings().

                                 : ?Platform
    {
        if (is_null($this->platform)) {
            if (!is_null($this->context) || !is_null($this->contextId)) {
                $this->platform = $this->getContext()->getPlatform();
            } else {
                //UK changed from $this->platform = Platform::fromRecordId($this->platformId, $this->getDataConnector());
                $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:

getPlatformId()

ILIAS\LTI\ToolProvider\ResourceLink::getPlatformId

(

)

Get platform ID.

Returns

int|null Platform ID for this resource link.

Definition at line 400 of file ResourceLink.php.

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

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

getRecordId()

ILIAS\LTI\ToolProvider\ResourceLink::getRecordId

(

)

Get resource link record ID.

Returns

int|null Record ID for this resource link.

Definition at line 490 of file ResourceLink.php.

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

Referenced by ILIAS\LTI\ToolProvider\ResourceLinkShareKey\__construct(), ilLTIDataConnector\deleteResourceLink(), ILIAS\LTI\ToolProvider\UserResult\fromResourceLink(), ilLTIDataConnector\loadResourceLink(), and ilLTIDataConnector\saveResourceLink().

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

Here is the caller graph for this function:

getSetting()

ILIAS\LTI\ToolProvider\ResourceLink::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 527 of file ResourceLink.php.

References ILIAS\Repository\settings().

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\checkValueType(), ILIAS\LTI\ToolProvider\ResourceLink\doAssessmentControlAction(), ILIAS\LTI\ToolProvider\ResourceLink\doSettingService(), ILIAS\LTI\ToolProvider\ResourceLink\getLineItemService(), ILIAS\LTI\ToolProvider\ResourceLink\getMemberships(), ILIAS\LTI\ToolProvider\ResourceLink\getOutcomes(), ILIAS\LTI\ToolProvider\ResourceLink\getToolSettings(), ILIAS\LTI\ToolProvider\ResourceLink\hasAssessmentControlService(), ILIAS\LTI\ToolProvider\ResourceLink\hasLineItemService(), ILIAS\LTI\ToolProvider\ResourceLink\hasMembershipsService(), ILIAS\LTI\ToolProvider\ResourceLink\hasOutcomesService(), ILIAS\LTI\ToolProvider\ResourceLink\hasResultService(), ILIAS\LTI\ToolProvider\ResourceLink\hasScoreService(), ILIAS\LTI\ToolProvider\ResourceLink\hasSettingService(), ILIAS\LTI\ToolProvider\ResourceLink\hasToolSettingsService(), ILIAS\LTI\ToolProvider\ResourceLink\setSetting(), and ILIAS\LTI\ToolProvider\ResourceLink\setToolSettings().

                                                                  : 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\ResourceLink::getSettings

(

)

Get an array of all setting values.

Returns

array Associative array of setting values

Definition at line 561 of file ResourceLink.php.

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

Referenced by ilLTIDataConnector\saveResourceLink().

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

Here is the caller graph for this function:

getShares()

ILIAS\LTI\ToolProvider\ResourceLink::getShares

(

)

Get an array of ResourceLinkShare objects for each resource link which is sharing this context.

Returns

ResourceLinkShare[] Array of ResourceLinkShare objects

Definition at line 1250 of file ResourceLink.php.

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

                               : array
    {
        return $this->getDataConnector()->getSharesResourceLink($this);
    }

Here is the call graph for this function:

getToolSettings()

ILIAS\LTI\ToolProvider\ResourceLink::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 976 of file ResourceLink.php.

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

    {
        $ok = false;
        $settings = array();
        if (!empty($this->getSetting('custom_link_setting_url'))) {
            $url = $this->getSetting('custom_link_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:

getUserResultSourcedIDs()

ILIAS\LTI\ToolProvider\ResourceLink::getUserResultSourcedIDs	(	bool	$localOnly = false,
		int	$idScope = null
	)

Obtain an array of UserResult objects for users with a result sourcedId.

The array may include users from other resource links which are sharing this resource link. It may also be optionally indexed by the user ID of a specified scope.

Parameters

bool	$localOnly	True if only users from this resource link are to be returned, not users from shared resource links (optional, default is false)
int | null	$idScope	Scope to use for ID values (optional, default is null for platform default)

Returns

UserResult[] Array of UserResult objects

Definition at line 1240 of file ResourceLink.php.

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

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

                                                                                         : array
    {
        return $this->getDataConnector()->getUserResultSourcedIDsResourceLink($this, $localOnly, $idScope);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAssessmentControlService()

ILIAS\LTI\ToolProvider\ResourceLink::hasAssessmentControlService

(

)

Check if the Assessment Control service is available.

Returns

bool True if this resource link supports the Assessment Control service

Definition at line 704 of file ResourceLink.php.

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

                                                 : bool
    {
        $url = $this->getSetting('custom_ap_acs_url');

        return !empty($url);
    }

Here is the call graph for this function:

hasLineItemService()

ILIAS\LTI\ToolProvider\ResourceLink::hasLineItemService

(

)

Check if the Line Item service is available.

Returns

bool True if this resource link supports the Line Item service

Definition at line 650 of file ResourceLink.php.

References $scopes, and ILIAS\LTI\ToolProvider\ResourceLink\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\ResourceLink::hasMembershipService

(

)

Check if the Membership service is supported.

Deprecated:

Use hasMembershipsService() instead

See also

ResourceLink::hasMembershipsService()

Returns

bool True if this resource link supports the Membership service

Definition at line 1027 of file ResourceLink.php.

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

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

Here is the call graph for this function:

hasMembershipsService()

ILIAS\LTI\ToolProvider\ResourceLink::hasMembershipsService

(

)

Check if a Memberships service is available.

Returns

bool True if this resource link supports a Memberships service

Definition at line 614 of file ResourceLink.php.

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

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

                                           : bool
    {
        $has = false;
        if (!empty($this->getContextId())) {
            $has = !empty($this->getContext()->getSetting('custom_context_memberships_url')) || !empty($this->getContext()->getSetting('custom_context_memberships_v2_url'));
        }
        if (!$has) {
            $has = !empty($this->getSetting('custom_link_memberships_url'));
        }
        if (!$has) {
            $has = !empty($this->getSetting('ext_ims_lis_memberships_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:

hasOutcomesService()

ILIAS\LTI\ToolProvider\ResourceLink::hasOutcomesService

(

)

Check if an Outcomes service is available.

Returns

bool True if this resource link supports an Outcomes service

Definition at line 596 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ApiHook\$OUTCOMES_SERVICE_HOOK, ILIAS\LTI\ToolProvider\Service\Score\$SCOPE, ILIAS\LTI\ToolProvider\Service\Result\$SCOPE, $scopes, ILIAS\LTI\ToolProvider\ResourceLink\getPlatform(), ILIAS\LTI\ToolProvider\ResourceLink\getSetting(), and ILIAS\LTI\ToolProvider\ApiHook\hasConfiguredApiHook().

                                        : bool
    {
        $has = !empty($this->getSetting('ext_ims_lis_basic_outcome_url')) || !empty($this->getSetting('lis_outcome_service_url'));
        if (!$has && !empty($this->getSetting('custom_lineitem_url')) && !empty($this->getSetting('custom_ags_scopes'))) {
            $scopes = explode(',', $this->getSetting('custom_ags_scopes'));
            $has = in_array(Service\Score::$SCOPE, $scopes) && in_array(Service\Result::$SCOPE, $scopes);
        }
        if (!$has) {
            $has = self::hasConfiguredApiHook(self::$OUTCOMES_SERVICE_HOOK, $this->getPlatform()->getFamilyCode(), $this);
        }
        return $has;
    }

Here is the call graph for this function:

hasResultService()

ILIAS\LTI\ToolProvider\ResourceLink::hasResultService

(

)

Check if the Result service is available.

Returns

bool True if this resource link supports the Result service

Definition at line 686 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\Service\Result\$SCOPE, $scopes, and ILIAS\LTI\ToolProvider\ResourceLink\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_lineitem_url'));
            }
        }

        return $has;
    }

Here is the call graph for this function:

hasScoreService()

ILIAS\LTI\ToolProvider\ResourceLink::hasScoreService

(

)

Check if the Score service is available.

Returns

bool True if this resource link supports the Score service

Definition at line 668 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\Service\Score\$SCOPE, $scopes, and ILIAS\LTI\ToolProvider\ResourceLink\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_lineitem_url'));
            }
        }

        return $has;
    }

Here is the call graph for this function:

hasSettingService()

ILIAS\LTI\ToolProvider\ResourceLink::hasSettingService

(

)

Check if the Setting extension service is available.

Returns

bool True if this resource link supports the Setting extension service

Definition at line 638 of file ResourceLink.php.

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

                                       : bool
    {
        $url = $this->getSetting('ext_ims_lti_tool_setting_url');

        return !empty($url);
    }

Here is the call graph for this function:

hasToolSettingsService()

ILIAS\LTI\ToolProvider\ResourceLink::hasToolSettingsService

(

)

Check if the Tool Settings service is available.

Returns

bool True if this resource link supports the Tool Settings service

Definition at line 961 of file ResourceLink.php.

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

                                            : bool
    {
        $has = !empty($this->getSetting('custom_link_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\ResourceLink::initialise

(

)

Initialise the resource link.

Synonym for initialize().

Definition at line 301 of file ResourceLink.php.

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

    {
        $this->initialize();
    }

Here is the call graph for this function:

initialize()

ILIAS\LTI\ToolProvider\ResourceLink::initialize

(

)

Initialise the resource link.

Definition at line 284 of file ResourceLink.php.

References ILIAS\Repository\settings().

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

    {
        $this->title = '';
        $this->settings = array();
        $this->groupSets = null;
        $this->groups = null;
        $this->primaryResourceLinkId = null;
        $this->shareApproved = 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\ResourceLink::load ( int  $id = null )

private

Load the resource link from the database.

Parameters

int | null

$id

Record ID of resource link (optional, default is null)

Returns

bool True if resource link was successfully loaded

Definition at line 1453 of file ResourceLink.php.

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

                                         : bool
    {
        $this->initialize();
        $this->id = $id;

        return $this->getDataConnector()->loadResourceLink($this);
    }

Here is the call graph for this function:

save()

ILIAS\LTI\ToolProvider\ResourceLink::save

(

)

Save the resource link to the database.

Returns

bool True if the resource link was successfully saved.

Definition at line 311 of file ResourceLink.php.

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

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

                          : bool
    {
        $ok = $this->getDataConnector()->saveResourceLink($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\ResourceLink::saveSettings

(

)

Save setting values.

Returns

bool True if the settings were successfully saved

Definition at line 580 of file ResourceLink.php.

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

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

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

        return $ok;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContext()

ILIAS\LTI\ToolProvider\ResourceLink::setContext

(

Context

$context

)

Set context.

Parameters

Context

$context

Context for this resource link.

Definition at line 447 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$context, and ILIAS\LTI\ToolProvider\Context\getRecordId().

    {
        $this->context = $context;
        $this->contextId = $context->getRecordId();
    }

Here is the call graph for this function:

setContextId()

ILIAS\LTI\ToolProvider\ResourceLink::setContextId

(

?int

$contextId

)

Set context ID.

Parameters

int | null

$contextId

Context ID for this resource link. //UK: added |null

Definition at line 457 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\$contextId.

Referenced by ilLTIDataConnector\loadResourceLink().

    {
        if ($this->contextId !== $contextId) {
            $this->context = null;
            $this->contextId = $contextId;
        }
    }

Here is the caller graph for this function:

setPlatformId()

ILIAS\LTI\ToolProvider\ResourceLink::setPlatformId

(

?int

$platformId

)

Set platform ID.

Parameters

int | null

$platformId

Platform ID for this resource link. //UK: added |null

Definition at line 409 of file ResourceLink.php.

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

Referenced by ilLTIDataConnector\loadResourceLink().

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

Here is the caller graph for this function:

setRecordId()

ILIAS\LTI\ToolProvider\ResourceLink::setRecordId

(

int

$id

)

Set resource link record ID.

Parameters

int

$id

Record ID for this resource link.

Definition at line 499 of file ResourceLink.php.

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

Referenced by ilLTIDataConnector\loadResourceLink(), and ilLTIDataConnector\saveResourceLink().

    {
        $this->id = $id;
    }

Here is the caller graph for this function:

setSetting()

ILIAS\LTI\ToolProvider\ResourceLink::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 543 of file ResourceLink.php.

References ILIAS\LTI\ToolProvider\ResourceLink\getSetting(), and ILIAS\Repository\settings().

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

    {
        $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:

Here is the caller graph for this function:

setSettings()

ILIAS\LTI\ToolProvider\ResourceLink::setSettings

(

array

$settings

)

Set an array of all setting values.

Parameters

array

$settings

Associative array of setting values

Definition at line 570 of file ResourceLink.php.

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

Referenced by ilLTIDataConnector\loadResourceLink().

    {
        $this->settings = $settings;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setToolSettings()

ILIAS\LTI\ToolProvider\ResourceLink::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 1001 of file ResourceLink.php.

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

                                                              : bool
    {
        $ok = false;
        if (!empty($this->getSetting('custom_link_setting_url'))) {
            $url = $this->getSetting('custom_link_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

$context

Context null ILIAS\LTI\ToolProvider\ResourceLink::$context = null

private

Context for this resource link.

Definition at line 229 of file ResourceLink.php.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\getContext(), and ILIAS\LTI\ToolProvider\ResourceLink\setContext().

$contextId

int null ILIAS\LTI\ToolProvider\ResourceLink::$contextId = null

private

Context ID for this resource link.

Definition at line 236 of file ResourceLink.php.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\getContextId(), and ILIAS\LTI\ToolProvider\ResourceLink\setContextId().

$created

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

Timestamp for when the object was created.

Definition at line 194 of file ResourceLink.php.

$dataConnector

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

private

Data connector object or string.

Definition at line 271 of file ResourceLink.php.

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

$extDoc

DOMDocument null ILIAS\LTI\ToolProvider\ResourceLink::$extDoc = null

private

XML document for the last extension service request.

Definition at line 257 of file ResourceLink.php.

$extNodes

array null ILIAS\LTI\ToolProvider\ResourceLink::$extNodes = null

private

XML node array for the last extension service request.

Definition at line 264 of file ResourceLink.php.

$extRequest

string null ILIAS\LTI\ToolProvider\ResourceLink::$extRequest = null

Request for last service request.

Definition at line 152 of file ResourceLink.php.

$extRequestHeaders

array null string ILIAS\LTI\ToolProvider\ResourceLink::$extRequestHeaders = null

Request headers for last service request.

Definition at line 159 of file ResourceLink.php.

$extResponse

string null ILIAS\LTI\ToolProvider\ResourceLink::$extResponse = null

Response from last service request.

Definition at line 166 of file ResourceLink.php.

$extResponseHeaders

array null string ILIAS\LTI\ToolProvider\ResourceLink::$extResponseHeaders = null

Response header from last service request.

Definition at line 173 of file ResourceLink.php.

$groups

array null ILIAS\LTI\ToolProvider\ResourceLink::$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 138 of file ResourceLink.php.

$groupSets

array null ILIAS\LTI\ToolProvider\ResourceLink::$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 126 of file ResourceLink.php.

$id

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

private

Record ID for this resource link.

Definition at line 208 of file ResourceLink.php.

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

$lastServiceRequest

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

HttpMessage object for last service request.

Definition at line 145 of file ResourceLink.php.

$ltiResourceLinkId

string null ILIAS\LTI\ToolProvider\ResourceLink::$ltiResourceLinkId = null

Resource link ID as supplied in the last connection request.

Definition at line 111 of file ResourceLink.php.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\createLineItem(), ILIAS\LTI\ToolProvider\ResourceLink\fromContext(), ILIAS\LTI\ToolProvider\ResourceLink\fromPlatform(), and ILIAS\LTI\ToolProvider\ResourceLink\getId().

$platform

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

private

Platform for this resource link.

Definition at line 215 of file ResourceLink.php.

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

$platformId

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

private

Platform ID for this resource link.

Definition at line 222 of file ResourceLink.php.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\getPlatformId(), and ILIAS\LTI\ToolProvider\ResourceLink\setPlatformId().

$primaryResourceLinkId

string null ILIAS\LTI\ToolProvider\ResourceLink::$primaryResourceLinkId = null

Primary key value for resource link being shared (if any).

Definition at line 180 of file ResourceLink.php.

$settings

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

private

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

Definition at line 243 of file ResourceLink.php.

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

$settingsChanged

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

private

Whether the settings value have changed since last saved.

Definition at line 250 of file ResourceLink.php.

$shareApproved

bool null ILIAS\LTI\ToolProvider\ResourceLink::$shareApproved = null

Whether the sharing request has been approved by the primary resource link.

Definition at line 187 of file ResourceLink.php.

$title

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

Context title.

Definition at line 104 of file ResourceLink.php.

$updated

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

Timestamp for when the object was last updated.

Definition at line 201 of file ResourceLink.php.

EXT_CREATE

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_CREATE = 4

Create action.

Definition at line 57 of file ResourceLink.php.

EXT_DELETE

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_DELETE = 3

Delete action.

Definition at line 52 of file ResourceLink.php.

EXT_READ

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_READ = 1

Read action.

Definition at line 42 of file ResourceLink.php.

EXT_TYPE_DECIMAL

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_DECIMAL = 'decimal'

Decimal outcome type.

Definition at line 67 of file ResourceLink.php.

EXT_TYPE_LETTER_AF

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_LETTER_AF = 'letteraf'

Letter (A-F) outcome type.

Definition at line 82 of file ResourceLink.php.

EXT_TYPE_LETTER_AF_PLUS

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_LETTER_AF_PLUS = 'letterafplus'

Letter (A-F) with optional +/- outcome type.

Definition at line 87 of file ResourceLink.php.

EXT_TYPE_PASS_FAIL

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_PASS_FAIL = 'passfail'

Pass/fail outcome type.

Definition at line 92 of file ResourceLink.php.

EXT_TYPE_PERCENTAGE

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_PERCENTAGE = 'percentage'

Percentage outcome type.

Definition at line 72 of file ResourceLink.php.

EXT_TYPE_RATIO

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_RATIO = 'ratio'

Ratio outcome type.

Definition at line 77 of file ResourceLink.php.

EXT_TYPE_TEXT

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_TYPE_TEXT = 'freetext'

Free text outcome type.

Definition at line 97 of file ResourceLink.php.

EXT_UPDATE

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_UPDATE = 5

Update action.

Definition at line 62 of file ResourceLink.php.

EXT_WRITE

const ILIAS\LTI\ToolProvider\ResourceLink::EXT_WRITE = 2

Write (create/update) action.

Definition at line 47 of file ResourceLink.php.

---

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

• Services/LTI/src/ToolProvider/ResourceLink.php