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

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

	getConsumer ()
	Get tool consumer. More...

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

	getContext ()
	Get context. More...

	getContextId ()
	Get context record ID. More...

	setContextId ($contextId)
	Set context ID. More...

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

	getId ()
	Get resource link ID. More...

	getRecordId ()
	Get resource link record ID. More...

	setRecordId ($id)
	Set resource link record ID. More...

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

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

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

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

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

	saveSettings ()
	Save setting values. More...

	hasOutcomesService ()
	Check if the Outcomes service is supported. More...

	hasMembershipsService ()
	Check if the Memberships extension service is supported. More...

	hasSettingService ()
	Check if the Setting extension service is supported. More...

	doOutcomesService ($action, $ltiOutcome, $user)
	Perform an Outcomes service request. More...

	doMembershipsService ($withGroups=false)
	Perform a Memberships service request. More...

	doSettingService ($action, $value=null)
	Perform a Setting service request. More...

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

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

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

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

	getMembership ()
	Get Memberships. More...

	getUserResultSourcedIDs ($localOnly=false, $idScope=null)
	Obtain an array of User 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...

Static Public Member Functions
static	fromConsumer ($consumer, $ltiResourceLinkId, $tempId=null)
	Class constructor from consumer. More...

static	fromContext ($context, $ltiResourceLinkId, $tempId=null)
	Class constructor from context. More...

static	fromRecordId ($id, $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...

	$title = null
	Context title. More...

	$ltiResourceLinkId = null
	Resource link ID as supplied in the last connection request. More...

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

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

	$extRequest = null
	Request for last service request. More...

	$extRequestHeaders = null
	Request headers for last service request. More...

	$extResponse = null
	Response from last service request. More...

	$extResponseHeaders = null
	Response header from last service request. More...

	$primaryResourceLinkId = null
	Consumer key value for resource link being shared (if any). More...

	$shareApproved = null
	Whether the sharing request has been approved by the primary resource link. More...

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

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

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

	checkValueType ($ltiOutcome, $supportedTypes=null)
	Convert data type of value to a supported type if possible. More...

	doService ($type, $url, $params)
	Send a service request to the tool consumer. More...

	doLTI11Service ($type, $url, $xml)
	Send a service request to the tool consumer. More...

	domnodeToArray ($node)
	Convert DOM nodes to array. More...

Private Attributes
	$id = null
	Record ID for this resource link. More...

	$consumer = null
	Tool Consumer for this resource link. More...

	$consumerId = null
	Tool Consumer ID for this resource link. More...

	$context = null
	Context for this resource link. More...

	$contextId = null
	Context ID for this resource link. More...

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

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

	$extDoc = null
	XML document for the last extension service request. More...

	$extNodes = null
	XML node array for the last extension service request. More...

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

Detailed Description

Class to represent a tool consumer resource link.

Author: Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright: IMS Global Learning Consortium Inc

Date: 2016

Version: 3.0.2 @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 21 of file ResourceLink.php.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor.

Definition at line 211 of file ResourceLink.php.

    {
 
        $this->initialize();
 
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ checkValueType()

IMSGlobal\LTI\ToolProvider\ResourceLink::checkValueType	(	$ltiOutcome,
		$supportedTypes = `null`
	)

private

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

Parameters

Outcome	$ltiOutcome	Outcome object
string[]	$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: boolean True if the type/value are valid and supported

Definition at line 1082 of file ResourceLink.php.

    {
 
        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) || (strlen($value) <= 0);
        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;
                }
            } else if ($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
            } else if ($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;
                } else if (in_array(self::EXT_TYPE_TEXT, $supportedTypes)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_TEXT;
                }
// Convert letter_af_plus to letter_af or text
            } else if ($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;
                } else if (in_array(self::EXT_TYPE_TEXT, $supportedTypes)) {
                    $ok = true;
                    $ltiOutcome->type = self::EXT_TYPE_TEXT;
                }
// Convert text to decimal
            } else if ($type === self::EXT_TYPE_TEXT) {
                $ok = is_numeric($value) && ($value >= 0) && ($value <=1);
                if ($ok) {
                    $ltiOutcome->type = self::EXT_TYPE_DECIMAL;
                } else if (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;
 
    }

References $ok, $type, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_TYPE_DECIMAL, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_TYPE_LETTER_AF, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_TYPE_LETTER_AF_PLUS, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_TYPE_PERCENTAGE, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_TYPE_TEXT, and IMSGlobal\LTI\ToolProvider\ResourceLink\getSetting().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

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

Delete the resource link from the database.

Returns: boolean True if the resource link was successfully deleted.

Definition at line 269 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ doLTI11Service()

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

private

Send a service request to the tool consumer.

Parameters

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

Returns: boolean True if the request successfully obtained a response

Definition at line 1215 of file ResourceLink.php.

    {
 
        $ok = false;
        $this->extRequest = null;
        $this->extRequestHeaders = '';
        $this->extResponse = null;
        $this->extResponseHeaders = '';
        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;
// Calculate body hash
            $hash = base64_encode(sha1($xmlRequest, true));
            $params = array('oauth_body_hash' => $hash);
 
// Add OAuth signature
            $hmacMethod = new OAuth\OAuthSignatureMethod_HMAC_SHA1();
            $consumer = new OAuth\OAuthConsumer($this->getConsumer()->getKey(), $this->getConsumer()->secret, null);
            $req = OAuth\OAuthRequest::from_consumer_and_token($consumer, null, 'POST', $url, $params);
            $req->sign_request($hmacMethod, $consumer, null);
            $params = $req->get_parameters();
            $header = $req->to_header();
            $header .= "\nContent-Type: application/xml";
// Connect to tool consumer
            $http = new HTTPMessage($url, 'POST', $xmlRequest, $header);
 
                        \ilLoggerFactory::getLogger('lti')->debug('Sending post: ' . $header);
            \ilLoggerFactory::getLogger('lti')->debug('Sending post: ' . $xmlRequest);
 
// Parse XML response
            if ($http->send()) {
                $this->extResponse = $http->response;
                $this->extResponseHeaders = $http->responseHeaders;
                                \ilLoggerFactory::getLogger('lti')->debug('Got response: ' . $http->response);
                                \ilLoggerFactory::getLogger('lti')->debug('Got response: ' . $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) {
                        \ilLoggerFactory::getLogger('lti')->warning('lti 1.1 outcome failed with message: ' . $e->getMessage());
                }
            }
            else {
                                \ilLoggerFactory::getLogger('lti')->debug('Got response: ' . $http->response);
                                \ilLoggerFactory::getLogger('lti')->debug('Got response: ' . $http->responseHeaders);
                        }
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
        }
 
        return $ok;
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLink\$consumer, $header, $http, IMSGlobal\LTI\ToolProvider\ResourceLink\$id, $ok, PHPMailer\PHPMailer\$params, $req, $type, $url, $xml, IMSGlobal\LTI\ToolProvider\ResourceLink\domnodeToArray(), IMSGlobal\LTI\OAuth\OAuthRequest\from_consumer_and_token(), IMSGlobal\LTI\ToolProvider\ResourceLink\getConsumer(), IMSGlobal\LTI\ToolProvider\ResourceLink\getKey(), and ilLoggerFactory\getLogger().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doMembershipsService()

IMSGlobal\LTI\ToolProvider\ResourceLink::doMembershipsService ( $withGroups = false )

Perform a Memberships service request.

The user table is updated with the new list of user objects.

Parameters

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

Returns: mixed Array of User objects or False if the request was not successful

Set the user roles

Definition at line 693 of file ResourceLink.php.

    {
 
        $users = array();
        $oldUsers = $this->getUserResultSourcedIDs(true, ToolProvider::ID_SCOPE_RESOURCE);
        $this->extResponse = null;
        $url = $this->getSetting('ext_ims_lis_memberships_url');
        $params = array();
        $params['id'] = $this->getSetting('ext_ims_lis_memberships_id');
        $ok = false;
        if ($withGroups) {
            $ok = $this->doService('basic-lis-readmembershipsforcontextwithgroups', $url, $params);
        }
        if ($ok) {
            $this->groupSets = array();
            $this->groups = array();
        } else {
            $ok = $this->doService('basic-lis-readmembershipsforcontext', $url, $params);
        }
 
        if ($ok) {
            if (!isset($this->extNodes['memberships']['member'])) {
                $members = array();
            } else if (!isset($this->extNodes['memberships']['member'][0])) {
                $members = array();
                $members[0] = $this->extNodes['memberships']['member'];
            } else {
                $members = $this->extNodes['memberships']['member'];
            }
 
            for ($i = 0; $i < count($members); $i++) {
 
                $user = User::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'] : '';
                $user->setNames($firstname, $lastname, $fullname);
 
// Set the user email
                $email = (isset($members[$i]['person_contact_email_primary'])) ? $members[$i]['person_contact_email_primary'] : '';
                $user->setEmail($email, $this->getConsumer()->defaultEmail);
 
                if (isset($members[$i]['roles'])) {
                    $user->roles = ToolProvider::parseRoles($members[$i]['roles']);
                }
 
// Set the user groups
                if (!isset($members[$i]['groups']['group'])) {
                    $groups = array();
                } else if (!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 ($user->isStaff()) {
                            $this->groupSets[$set_id]['num_staff']++;
                        }
                        if ($user->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']);
                    }
                    $user->groups[] = $group['id'];
                }
 
// If a result sourcedid is provided save the user
                if (isset($members[$i]['lis_result_sourcedid'])) {
                    $user->ltiResultSourcedId = $members[$i]['lis_result_sourcedid'];
                    $user->save();
                }
                $users[] = $user;
 
// Remove old user (if it exists)
                unset($oldUsers[$user->getId(ToolProvider::ID_SCOPE_RESOURCE)]);
            }
 
// Delete any old users which were not in the latest list from the tool consumer
            foreach ($oldUsers as $id => $user) {
                $user->delete();
            }
        } else {
            $users = false;
        }
 
        return $users;
 
    }

Here is the call graph for this function:

◆ domnodeToArray()

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

private

Convert DOM nodes to array.

Parameters

DOMElement $node XML element

Returns: array Array of XML document elements

Definition at line 1296 of file ResourceLink.php.

    {
 
        $output = '';
        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)) {
                        $t = $child->tagName;
                        if (!isset($output[$t])) {
                            $output[$t] = array();
                        }
                        $output[$t][] = $v;
                    } else {
                        $s = (string) $v;
                        if (strlen($s) > 0) {
                            $output = $s;
                        }
                    }
                }
                if (is_array($output)) {
                    if ($node->attributes->length) {
                        $a = array();
                        foreach ($node->attributes as $attrName => $attrNode) {
                            $a[$attrName] = (string) $attrNode->value;
                        }
                        $output['@attributes'] = $a;
                    }
                    foreach ($output as $t => $v) {
                        if (is_array($v) && count($v)==1 && $t!='@attributes') {
                            $output[$t] = $v[0];
                        }
                    }
                }
                break;
        }
 
        return $output;
 
    }

References $i, Sabre\VObject\$output, $s, $t, and IMSGlobal\LTI\ToolProvider\ResourceLink\domnodeToArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doOutcomesService()

IMSGlobal\LTI\ToolProvider\ResourceLink::doOutcomesService	(	$action,
		$ltiOutcome,
		$user
	)

Perform an Outcomes service request.

Parameters

int	$action	The action type constant
Outcome	$ltiOutcome	Outcome object
User	$user	User object

Returns: boolean True if the request was successfully processed

Definition at line 547 of file ResourceLink.php.

    {
        global $DIC;
        $logger = $DIC->logger()->lti();
 
        $response = false;
        $this->extResponse = null;
 
// Lookup service details from the source resource link appropriate to the user (in case the destination is being shared)
        $sourceResourceLink = $user->getResourceLink();
        $sourcedId = $user->ltiResultSourcedId;
 
// Use LTI 1.1 service in preference to extension service if it is available
        $urlLTI11 = $sourceResourceLink->getSetting('lis_outcome_service_url');
        $urlExt = $sourceResourceLink->getSetting('ext_ims_lis_basic_outcome_url');
        if ($urlExt || $urlLTI11) {
            switch ($action) {
                case self::EXT_READ:
                    if ($urlLTI11 && ($ltiOutcome->type === self::EXT_TYPE_DECIMAL)) {
                        $do = 'readResult';
                    } else if ($urlExt) {
                        $urlLTI11 = null;
                        $do = 'basic-lis-readresult';
                    }
                    break;
                case self::EXT_WRITE:
                    if ($urlLTI11 && $this->checkValueType($ltiOutcome, array(self::EXT_TYPE_DECIMAL))) {
                        $do = 'replaceResult';
                    } else if ($this->checkValueType($ltiOutcome)) {
                        $urlLTI11 = null;
                        $do = 'basic-lis-updateresult';
                    }
                    break;
                case self::EXT_DELETE:
                    if ($urlLTI11 && ($ltiOutcome->type === self::EXT_TYPE_DECIMAL)) {
                        $do = 'deleteResult';
                    } else if ($urlExt) {
                        $urlLTI11 = null;
                        $do = 'basic-lis-deleteresult';
                    }
                    break;
            }
        }
 
        $logger->debug('Command is: ' . $do);
 
        if (isset($do)) {
            $value = $ltiOutcome->getValue();
            if (is_null($value)) {
                $value = '';
            }
            if ($urlLTI11) {
                $xml = '';
                if ($action === self::EXT_WRITE) {
                    $xml = <<<EOF
 
        <result>
          <resultScore>
            <language>{$ltiOutcome->language}</language>
            <textString>{$value}</textString>
          </resultScore>
        </result>
EOF;
                }
                $sourcedId = htmlentities($sourcedId);
                $xml = <<<EOF
      <resultRecord>
        <sourcedGUID>
          <sourcedId>{$sourcedId}</sourcedId>
        </sourcedGUID>{$xml}
      </resultRecord>
EOF;
 
                $logger->debug($urlLTI11);
                $logger->debug('xml for doLTI11Service: ' . $xml);
 
                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']);
                            }
                        case self::EXT_WRITE:
                        case self::EXT_DELETE:
                            $response = true;
                            break;
                    }
                }
            } else {
                                $params = array();
                $params['sourcedid'] = $sourcedId;
                $params['result_resultscore_textstring'] = $value;
                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->data_source)) {
                    $params['result_datasource'] = $ltiOutcome->data_source;
                }
 
                $logger->debug($urlExt);
                                $logger->dump($params);
 
 
                                if ($this->doService($do, $urlExt, $params)) {
                    switch ($action) {
                        case self::EXT_READ:
                            if (isset($this->extNodes['result']['resultscore']['textstring'])) {
                                $response = $this->extNodes['result']['resultscore']['textstring'];
                            }
                            break;
                        case self::EXT_WRITE:
                        case self::EXT_DELETE:
                            $response = true;
                            break;
                    }
                }
            }
            if (is_array($response) && (count($response) <= 0)) {
                $response = '';
            }
        }
 
        return $response;
 
    }

References $action, $DIC, PHPMailer\PHPMailer\$params, $response, $user, $xml, IMSGlobal\LTI\ToolProvider\ResourceLink\checkValueType(), IMSGlobal\LTI\ToolProvider\ResourceLink\doLTI11Service(), IMSGlobal\LTI\ToolProvider\ResourceLink\doService(), EOF, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_DELETE, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_READ, and IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_WRITE.

Here is the call graph for this function:

◆ doService()

IMSGlobal\LTI\ToolProvider\ResourceLink::doService	(	$type,
		$url,
		$params
	)

private

Send a service request to the tool consumer.

Parameters

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

Returns: boolean True if the request successfully obtained a response

Definition at line 1161 of file ResourceLink.php.

    {
 
        $ok = false;
        $this->extRequest = null;
        $this->extRequestHeaders = '';
        $this->extResponse = null;
        $this->extResponseHeaders = '';
        if (!empty($url)) {
            $params = $this->getConsumer()->signParameters($url, $type, $this->getConsumer()->ltiVersion, $params);
// Connect to tool consumer
            $http = new HTTPMessage($url, 'POST', $params);
            \ilLoggerFactory::getLogger('lti')->debug('Sending to ' . $url);
                        \ilLoggerFactory::getLogger('lti')->dump($params);
 
// Parse XML response
            if ($http->send()) {
                $this->extResponse = $http->response;
                $this->extResponseHeaders = $http->responseHeaders;
 
                \ilLoggerFactory::getLogger('lti')->debug('Response: ' . $http->response);
                                \ilLoggerFactory::getLogger('lti')->debug('Response: ' . $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) {
                        \ilLoggerFactory::getLogger('lti')->warning('Outcome failed with message: ' . $e->getMessage());
                }
            }
            $this->extRequest = $http->request;
            $this->extRequestHeaders = $http->requestHeaders;
 
            \ilLoggerFactory::getLogger('lti')->debug('Request: ' . $http->request);
                        \ilLoggerFactory::getLogger('lti')->debug('RequestHeaders: ' . $http->requestHeaders);
        }
 
        return $ok;
 
    }

References $http, $ok, PHPMailer\PHPMailer\$params, $type, $url, IMSGlobal\LTI\ToolProvider\ResourceLink\domnodeToArray(), IMSGlobal\LTI\ToolProvider\ResourceLink\getConsumer(), and ilLoggerFactory\getLogger().

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), IMSGlobal\LTI\ToolProvider\ResourceLink\doOutcomesService(), and IMSGlobal\LTI\ToolProvider\ResourceLink\doSettingService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doSettingService()

IMSGlobal\LTI\ToolProvider\ResourceLink::doSettingService	(	$action,
		$value = `null`
	)

Perform a Setting service request.

Parameters

int	$action	The action type constant
string	$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 807 of file ResourceLink.php.

    {
 
        $response = false;
        $this->extResponse = null;
        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)) {
                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;
 
    }

References $action, PHPMailer\PHPMailer\$params, $response, $url, IMSGlobal\LTI\ToolProvider\ResourceLink\doService(), IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_DELETE, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_READ, IMSGlobal\LTI\ToolProvider\ResourceLink\EXT_WRITE, IMSGlobal\LTI\ToolProvider\ResourceLink\getSetting(), IMSGlobal\LTI\ToolProvider\ResourceLink\saveSettings(), and IMSGlobal\LTI\ToolProvider\ResourceLink\setSetting().

Here is the call graph for this function:

◆ fromConsumer()

static IMSGlobal\LTI\ToolProvider\ResourceLink::fromConsumer	(	$consumer,
		$ltiResourceLinkId,
		$tempId = `null`
	)

static

Class constructor from consumer.

Parameters

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

Returns: ResourceLink

Definition at line 986 of file ResourceLink.php.

    {
 
        $resourceLink = new ResourceLink();
        $resourceLink->consumer = $consumer;
        $resourceLink->dataConnector = $consumer->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;
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLink\$consumer, and IMSGlobal\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), and IMSGlobal\LTI\ToolProvider\ToolProvider\checkForShare().

Here is the caller graph for this function:

◆ fromContext()

static IMSGlobal\LTI\ToolProvider\ResourceLink::fromContext	(	$context,
		$ltiResourceLinkId,
		$tempId = `null`
	)

static

Class constructor from context.

Parameters

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

Returns: ResourceLink

Definition at line 1014 of file ResourceLink.php.

    {
 
        $resourceLink = new ResourceLink();
        $resourceLink->setContextId($context->getRecordId());
        $resourceLink->context = $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;
            }
        }
 
        return $resourceLink;
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLink\$context, and IMSGlobal\LTI\ToolProvider\ResourceLink\$ltiResourceLinkId.

◆ fromRecordId()

static IMSGlobal\LTI\ToolProvider\ResourceLink::fromRecordId	(	$id,
		$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 1043 of file ResourceLink.php.

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

References IMSGlobal\LTI\ToolProvider\ResourceLink\$dataConnector, and IMSGlobal\LTI\ToolProvider\ResourceLink\$id.

Referenced by IMSGlobal\LTI\ToolProvider\User\getResourceLink(), ilLTIAppEventListener\handleOutcomeWithoutLP(), and ilLTIAppEventListener\tryOutcomeService().

Here is the caller graph for this function:

◆ getConsumer()

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

Get tool consumer.

Returns: ToolConsumer Tool consumer object for this resource link.

Definition at line 281 of file ResourceLink.php.

    {
 
        if (is_null($this->consumer)) {
                // begin-patch ilias
            #if (!is_null($this->context) || !is_null($this->contextId)) {
                        if($this->context || $this->contextId) {
                $this->consumer = $this->getContext()->getConsumer();
            } else {
                $this->consumer = ToolConsumer::fromRecordId($this->consumerId, $this->getDataConnector());
            }
        }
 
        return $this->consumer;
 
    }

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

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\doLTI11Service(), IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), IMSGlobal\LTI\ToolProvider\ResourceLink\doService(), and IMSGlobal\LTI\ToolProvider\ResourceLink\getKey().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContext()

IMSGlobal\LTI\ToolProvider\ResourceLink::getContext ( )

Get context.

Returns: object LTIContext object for this resource link.

Definition at line 316 of file ResourceLink.php.

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

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

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\getConsumer(), IMSGlobal\LTI\ToolProvider\ResourceLink\getMembership(), and IMSGlobal\LTI\ToolProvider\ResourceLink\hasMembershipService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContextId()

IMSGlobal\LTI\ToolProvider\ResourceLink::getContextId ( )

Get context record ID.

Returns: int Context record ID for this resource link.

Definition at line 332 of file ResourceLink.php.

    {
 
        return $this->contextId;
 
    }

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

◆ getDataConnector()

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

Get the data connector.

Returns: mixed Data connector object or string

Definition at line 405 of file ResourceLink.php.

    {
 
        return $this->dataConnector;
 
    }

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

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\delete(), IMSGlobal\LTI\ToolProvider\ResourceLink\getConsumer(), IMSGlobal\LTI\ToolProvider\ResourceLink\getContext(), IMSGlobal\LTI\ToolProvider\ResourceLink\getShares(), IMSGlobal\LTI\ToolProvider\ResourceLink\getUserResultSourcedIDs(), IMSGlobal\LTI\ToolProvider\ResourceLink\load(), and IMSGlobal\LTI\ToolProvider\ResourceLink\save().

Here is the caller graph for this function:

◆ getId()

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

Get resource link ID.

Returns: string ID for this resource link.

Definition at line 369 of file ResourceLink.php.

    {
 
        return $this->ltiResourceLinkId;
 
    }

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

◆ getKey()

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

Get tool consumer key.

Returns: string Consumer key value for this resource link.

Definition at line 357 of file ResourceLink.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembership()

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

Get Memberships.

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

Definition at line 932 of file ResourceLink.php.

    {
 
        $response = false;
        if (!empty($this->contextId)) {
            $url = $this->getContext()->getSetting('custom_context_memberships_url');
            if (!empty($url)) {
                $service = new Service\Membership($this, $url);
                $response = $service->get();
            }
        }
 
        return $response;
 
    }

References $response, $url, and IMSGlobal\LTI\ToolProvider\ResourceLink\getContext().

Here is the call graph for this function:

◆ getRecordId()

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

Get resource link record ID.

Returns: int Record ID for this resource link.

Definition at line 381 of file ResourceLink.php.

    {
 
        return $this->id;
 
    }

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

◆ getSetting()

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

Get a setting value.

Parameters

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

Returns: string Setting value

Definition at line 420 of file ResourceLink.php.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettings()

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

Get an array of all setting values.

Returns: array Associative array of setting values

Definition at line 459 of file ResourceLink.php.

    {
 
        return $this->settings;
 
    }

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

◆ getShares()

IMSGlobal\LTI\ToolProvider\ResourceLink::getShares ( )

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

Returns: array Array of ResourceLinkShare objects

Definition at line 971 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ getToolSettings()

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

Get Tool Settings.

Parameters

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

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

Definition at line 881 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ getUserResultSourcedIDs()

IMSGlobal\LTI\ToolProvider\ResourceLink::getUserResultSourcedIDs	(	$localOnly = `false`,
		$idScope = `null`
	)

Obtain an array of User 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

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

Returns: array Array of User objects

Definition at line 959 of file ResourceLink.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasMembershipService()

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

Check if the Membership service is supported.

Returns: boolean True if this resource link supports the Membership service

Definition at line 915 of file ResourceLink.php.

    {
 
        $has = !empty($this->contextId);
        if ($has) {
            $has = !empty($this->getContext()->getSetting('custom_context_memberships_url'));
        }
 
        return $has;
 
    }

References IMSGlobal\LTI\ToolProvider\ResourceLink\getContext(), and IMSGlobal\LTI\ToolProvider\ResourceLink\getSetting().

Here is the call graph for this function:

◆ hasMembershipsService()

IMSGlobal\LTI\ToolProvider\ResourceLink::hasMembershipsService ( )

Check if the Memberships extension service is supported.

Returns: boolean True if this resource link supports the Memberships extension service

Definition at line 515 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ hasOutcomesService()

IMSGlobal\LTI\ToolProvider\ResourceLink::hasOutcomesService ( )

Check if the Outcomes service is supported.

Returns: boolean True if this resource link supports the Outcomes service (either the LTI 1.1 or extension service)

Definition at line 501 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ hasSettingService()

IMSGlobal\LTI\ToolProvider\ResourceLink::hasSettingService ( )

Check if the Setting extension service is supported.

Returns: boolean True if this resource link supports the Setting extension service

Definition at line 529 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ hasToolSettingsService()

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

Check if the Tool Settings service is supported.

Returns: boolean True if this resource link supports the Tool Settings service

Definition at line 864 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ initialise()

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

Initialise the resource link.

Pseudonym for initialize().

Definition at line 240 of file ResourceLink.php.

    {
 
        $this->initialize();
 
    }

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

Here is the call graph for this function:

◆ initialize()

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

Initialise the resource link.

Definition at line 221 of file ResourceLink.php.

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

References settings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load()

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

private

Load the resource link from the database.

Parameters

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

Returns: boolean True if resource link was successfully loaded

Definition at line 1064 of file ResourceLink.php.

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

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

Here is the call graph for this function:

◆ save()

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

Save the resource link to the database.

Returns: boolean True if the resource link was successfully saved.

Definition at line 252 of file ResourceLink.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

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

Save setting values.

Returns: boolean True if the settings were successfully saved

Definition at line 483 of file ResourceLink.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConsumerId()

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

Set tool consumer ID.

Parameters

int $consumerId Tool Consumer ID for this resource link.

Definition at line 303 of file ResourceLink.php.

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

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

◆ setContextId()

IMSGlobal\LTI\ToolProvider\ResourceLink::setContextId ( $contextId )

Set context ID.

Parameters

int $contextId Context ID for this resource link.

Definition at line 344 of file ResourceLink.php.

    {
 
        $this->context = null;
        $this->contextId = $contextId;
 
    }

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

◆ setRecordId()

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

Set resource link record ID.

Parameters

int $id Record ID for this resource link.

Definition at line 393 of file ResourceLink.php.

    {
 
        $this->id = $id;
 
  }

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

◆ setSetting()

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

Set a setting value.

Parameters

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

Definition at line 439 of file ResourceLink.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSettings()

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

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

Definition at line 471 of file ResourceLink.php.

    {
 
        $this->settings = $settings;
 
    }

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

Here is the call graph for this function:

◆ setToolSettings()

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

Perform a Tool Settings service request.

Parameters

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

Returns: boolean True if action was successful, otherwise false

Definition at line 899 of file ResourceLink.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $consumer

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

private

Tool Consumer for this resource link.

Definition at line 158 of file ResourceLink.php.

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

◆ $consumerId

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

private

Tool Consumer ID for this resource link.

Definition at line 164 of file ResourceLink.php.

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

◆ $context

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

private

Context for this resource link.

Definition at line 170 of file ResourceLink.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\fromContext(), and IMSGlobal\LTI\ToolProvider\ResourceLink\getContext().

◆ $contextId

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

private

Context ID for this resource link.

Definition at line 176 of file ResourceLink.php.

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

◆ $created

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

Date/time when the object was created.

Definition at line 139 of file ResourceLink.php.

◆ $dataConnector

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

private

Data connector object or string.

Definition at line 206 of file ResourceLink.php.

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

◆ $extDoc

string IMSGlobal\LTI\ToolProvider\ResourceLink::$extDoc = null

private

XML document for the last extension service request.

Definition at line 194 of file ResourceLink.php.

◆ $extNodes

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

private

XML node array for the last extension service request.

Definition at line 200 of file ResourceLink.php.

◆ $extRequest

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

Request for last service request.

Definition at line 103 of file ResourceLink.php.

◆ $extRequestHeaders

array IMSGlobal\LTI\ToolProvider\ResourceLink::$extRequestHeaders = null

Request headers for last service request.

Definition at line 109 of file ResourceLink.php.

◆ $extResponse

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

Response from last service request.

Definition at line 115 of file ResourceLink.php.

◆ $extResponseHeaders

array IMSGlobal\LTI\ToolProvider\ResourceLink::$extResponseHeaders = null

Response header from last service request.

Definition at line 121 of file ResourceLink.php.

◆ $groups

array IMSGlobal\LTI\ToolProvider\ResourceLink::$groups = null

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

Definition at line 97 of file ResourceLink.php.

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

◆ $groupSets

array IMSGlobal\LTI\ToolProvider\ResourceLink::$groupSets = null

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

Definition at line 91 of file ResourceLink.php.

◆ $id

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

private

Record ID for this resource link.

Definition at line 152 of file ResourceLink.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\doLTI11Service(), IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), IMSGlobal\LTI\ToolProvider\ResourceLink\fromRecordId(), IMSGlobal\LTI\ToolProvider\ResourceLink\getRecordId(), IMSGlobal\LTI\ToolProvider\ResourceLink\load(), and IMSGlobal\LTI\ToolProvider\ResourceLink\setRecordId().

◆ $ltiResourceLinkId

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

Resource link ID as supplied in the last connection request.

Definition at line 85 of file ResourceLink.php.

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

◆ $primaryResourceLinkId

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

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

Definition at line 127 of file ResourceLink.php.

◆ $settings

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

private

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

Definition at line 182 of file ResourceLink.php.

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

◆ $settingsChanged

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

private

Whether the settings value have changed since last saved.

Definition at line 188 of file ResourceLink.php.

◆ $shareApproved

boolean IMSGlobal\LTI\ToolProvider\ResourceLink::$shareApproved = null

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

Definition at line 133 of file ResourceLink.php.

◆ $title

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

Context title.

Definition at line 79 of file ResourceLink.php.

◆ $updated

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

Date/time when the object was last updated.

Definition at line 145 of file ResourceLink.php.

◆ EXT_CREATE

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

Create action.

Definition at line 39 of file ResourceLink.php.

◆ EXT_DELETE

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

Delete action.

Definition at line 35 of file ResourceLink.php.

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

◆ EXT_READ

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

Read action.

Definition at line 27 of file ResourceLink.php.

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

◆ EXT_TYPE_DECIMAL

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

Decimal outcome type.

Definition at line 48 of file ResourceLink.php.

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

◆ EXT_TYPE_LETTER_AF

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

Letter (A-F) outcome type.

Definition at line 60 of file ResourceLink.php.

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

◆ EXT_TYPE_LETTER_AF_PLUS

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

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

Definition at line 64 of file ResourceLink.php.

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

◆ EXT_TYPE_PASS_FAIL

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

Pass/fail outcome type.

Definition at line 68 of file ResourceLink.php.

◆ EXT_TYPE_PERCENTAGE

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

Percentage outcome type.

Definition at line 52 of file ResourceLink.php.

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

◆ EXT_TYPE_RATIO

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

Ratio outcome type.

Definition at line 56 of file ResourceLink.php.

◆ EXT_TYPE_TEXT

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

Free text outcome type.

Definition at line 72 of file ResourceLink.php.

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

◆ EXT_UPDATE

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

Update action.

Definition at line 43 of file ResourceLink.php.

◆ EXT_WRITE

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

Write (create/update) action.

Definition at line 31 of file ResourceLink.php.

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

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkValueType()

◆ delete()

◆ doLTI11Service()

◆ doMembershipsService()

◆ domnodeToArray()

◆ doOutcomesService()

◆ doService()

◆ doSettingService()

◆ fromConsumer()

◆ fromContext()

◆ fromRecordId()

◆ getConsumer()

◆ getContext()

◆ getContextId()

◆ getDataConnector()

◆ getId()

◆ getKey()

◆ getMembership()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getShares()

◆ getToolSettings()

◆ getUserResultSourcedIDs()

◆ hasMembershipService()

◆ hasMembershipsService()

◆ hasOutcomesService()

◆ hasSettingService()

◆ hasToolSettingsService()

◆ initialise()

◆ initialize()

◆ load()

◆ save()

◆ saveSettings()

◆ setConsumerId()

◆ setContextId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Field Documentation

◆ $consumer

◆ $consumerId

◆ $context

◆ $contextId

◆ $created

◆ $dataConnector

◆ $extDoc

◆ $extNodes

◆ $extRequest

◆ $extRequestHeaders

◆ $extResponse

◆ $extResponseHeaders

◆ $groups

◆ $groupSets

◆ $id

◆ $ltiResourceLinkId

◆ $primaryResourceLinkId

◆ $settings

◆ $settingsChanged

◆ $shareApproved

◆ $title

◆ $updated

◆ EXT_CREATE

◆ EXT_DELETE

◆ EXT_READ

◆ EXT_TYPE_DECIMAL

◆ EXT_TYPE_LETTER_AF

◆ EXT_TYPE_LETTER_AF_PLUS

◆ EXT_TYPE_PASS_FAIL

◆ EXT_TYPE_PERCENTAGE