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

Inheritance diagram for ResourceLink:

Public Member Functions
	__construct ()
	Class constructor.

	initialize ()
	Initialise the resource link.

	initialise ()
	Initialise the resource link.

bool	save ()
	Save the resource link to the database.

bool	delete ()
	Delete the resource link from the database.

ToolConsumer	getConsumer ()
	Get tool consumer.

int null	getConsumerId ()
	Get tool consumer ID.

	setConsumerId ($consumerId)
	Set tool consumer ID.

Platform	getPlatform ()
	Get platform.

int null	getPlatformId ()
	Get platform ID.

	setPlatformId ($platformId)
	Set platform ID.

Context null	getContext ()
	Get context.

int null	getContextId ()
	Get context record ID.

	setContext ($context)
	Set context.

	setContextId ($contextId)
	Set context ID.

string	getKey ()
	Get consumer key.

string	getId ()
	Get resource link ID.

int null	getRecordId ()
	Get resource link record ID.

	setRecordId ($id)
	Set resource link record ID.

DataConnector null	getDataConnector ()
	Get the data connector.

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

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

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

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

bool	saveSettings ()
	Save setting values.

bool	hasOutcomesService ()
	Check if an Outcomes service is available.

bool	hasMembershipsService ()
	Check if a Memberships service is available.

bool	hasSettingService ()
	Check if the Setting extension service is available.

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

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

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

bool	hasAssessmentControlService ()
	Check if the Assessment Control service is available.

bool	doOutcomesService ($action, $ltiOutcome, $userResult)
	Perform an Outcomes service request.

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

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

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

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

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

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

mixed	getMembership ()
	Get Membership.

mixed	getMemberships ($withGroups=false)
	Get Memberships.

UserResult[]	getUserResultSourcedIDs ($localOnly=false, $idScope=null)
	Obtain an array of UserResult objects for users with a result sourcedId.

ResourceLinkShare[]	getShares ()
	Get an array of ResourceLinkShare objects for each resource link which is sharing this context.

LineItem[] bool	getLineItems ($resourceId=null, $tag=null, $limit=null)
	Get line items.

bool	createLineItem ($lineItem)
	Create a new line item.

Outcome[] bool	getOutcomes ($limit=null)
	Get all outcomes.

string bool	doAssessmentControlAction ($assessmentControlAction, $user, $attemptNumber)
	Perform an Assessment Control action.

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

static ResourceLink	fromPlatform ($platform, $ltiResourceLinkId, $tempId=null)
	Class constructor from platform.

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

static ResourceLink	fromRecordId ($id, $dataConnector)
	Load the resource link from the database.

Static Public Member Functions inherited from ApiHook
static void	registerApiHook ($hookName, $familyCode, $className)
	Register the availability of an API hook.

Public Attributes
const	EXT_READ = 1
	Read action.

const	EXT_WRITE = 2
	Write (create/update) action.

const	EXT_DELETE = 3
	Delete action.

const	EXT_CREATE = 4
	Create action.

const	EXT_UPDATE = 5
	Update action.

const	EXT_TYPE_DECIMAL = 'decimal'
	Decimal outcome type.

const	EXT_TYPE_PERCENTAGE = 'percentage'
	Percentage outcome type.

const	EXT_TYPE_RATIO = 'ratio'
	Ratio outcome type.

const	EXT_TYPE_LETTER_AF = 'letteraf'
	Letter (A-F) outcome type.

const	EXT_TYPE_LETTER_AF_PLUS = 'letterafplus'
	Letter (A-F) with optional +/- outcome type.

const	EXT_TYPE_PASS_FAIL = 'passfail'
	Pass/fail outcome type.

const	EXT_TYPE_TEXT = 'freetext'
	Free text outcome type.

string null	$title = null
	Context title.

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

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

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

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Static Public Attributes inherited from ApiHook
static	$USER_ID_HOOK = "UserId"
	User Id hook name.

static	$CONTEXT_ID_HOOK = "ContextId"
	Context Id hook name.

static	$GROUPS_SERVICE_HOOK = "Groups"
	Course Groups service hook name.

static	$MEMBERSHIPS_SERVICE_HOOK = "Memberships"
	Memberships service hook name.

static	$OUTCOMES_SERVICE_HOOK = "Outcomes"
	Outcomes service hook name.

static	$TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"
	Tool Settings service hook name.

static	$ACCESS_TOKEN_SERVICE_HOOK = "AccessToken"
	Access Token service hook name.

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

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Member Function Documentation

◆ createLineItem()

bool createLineItem ( $lineItem )

Create a new line item.

Parameters

LineItem $lineItem Line item object

Returns: bool True if successful

◆ delete()

bool delete ( )

Delete the resource link from the database.

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

References ResourceLink\initialize().

◆ doAssessmentControlAction()

string bool doAssessmentControlAction	(	$assessmentControlAction,
		$user,
		$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

◆ doMembershipsService()

mixed doMembershipsService ( $withGroups = false )

Perform a Memberships extension service request.

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

Deprecated:: Use getMemberships() instead

See also: ResourceLink::getMemberships()

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

◆ doOutcomesService()

bool doOutcomesService	(	$action,
		$ltiOutcome,
		$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

◆ doSettingService()

mixed 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

◆ fromConsumer()

static ResourceLink fromConsumer	(	$consumer,
		$ltiResourceLinkId,
		$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

◆ fromContext()

static 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

References ResourceLink\$ltiResourceLinkId.

◆ fromPlatform()

static ResourceLink fromPlatform	(	$platform,
		$ltiResourceLinkId,
		$tempId = `null`
	)

static

Class constructor from platform.

Parameters

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

Returns: ResourceLink

◆ fromRecordId()

static 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

References ResourceLink\$ltiResourceLinkId.

◆ getConsumer()

ToolConsumer getConsumer ( )

Get tool consumer.

Deprecated:: Use getPlatform() instead

See also: Context::getPlatform()

Returns: ToolConsumer Tool consumer object for this resource link.

◆ getConsumerId()

int null getConsumerId ( )

Get tool consumer ID.

Deprecated:: Use getPlatformId() instead

See also: Context::getPlatformId()

Returns: int|null Tool Consumer ID for this resource link.

References ResourceLink\getPlatform(), and Util\logDebug().

◆ getContext()

Context null getContext ( )

Get context.

Returns: Context|null LTIContext object for this resource link.

Referenced by ResourceLink\hasSettingService().

◆ getContextId()

int null getContextId ( )

Get context record ID.

Returns: int|null Context record ID for this resource link.

Referenced by ResourceLink\hasSettingService().

◆ getDataConnector()

DataConnector null getDataConnector ( )

Get the data connector.

Returns: DataConnector|null Data connector object or string

Referenced by ResourceLink\getLineItems().

◆ getId()

string getId ( )

Get resource link ID.

Returns: string ID for this resource link.

◆ getKey()

string getKey ( )

Get consumer key.

Returns: string Consumer key value for this resource link.

References Context\getRecordId().

◆ getLineItems()

LineItem[] bool getLineItems	(	$resourceId = `null`,
		$tag = `null`,
		$limit = `null`
	)

Get line items.

Parameters

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

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

References ResourceLink\getDataConnector(), and DataConnector\getUserResultSourcedIDsResourceLink().

◆ getMembership()

mixed getMembership ( )

Get Membership.

Deprecated:: Use getMemberships() instead

See also: ResourceLink::getMemberships()

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

References ResourceLink\hasMembershipsService(), and Util\logDebug().

◆ getMemberships()

mixed getMemberships ( $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

◆ getOutcomes()

Outcome[] bool getOutcomes ( $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

◆ getPlatform()

Platform getPlatform ( )

Get platform.

Returns: Platform Platform object for this resource link.

Referenced by ResourceLink\getConsumerId(), ResourceLink\hasLineItemService(), and ResourceLink\hasMembershipsService().

◆ getPlatformId()

int null getPlatformId ( )

Get platform ID.

Returns: int|null Platform ID for this resource link.

◆ getRecordId()

int null getRecordId ( )

Get resource link record ID.

Returns: int|null Record ID for this resource link.

◆ getSetting()

string 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

Referenced by ResourceLink\hasAssessmentControlService(), ResourceLink\hasMembershipService(), ResourceLink\hasMembershipsService(), ResourceLink\hasResultService(), ResourceLink\hasScoreService(), and ResourceLink\hasSettingService().

◆ getSettings()

array getSettings ( )

Get an array of all setting values.

Returns: array Associative array of setting values

◆ getShares()

ResourceLinkShare[] getShares ( )

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

Returns: ResourceLinkShare[] Array of ResourceLinkShare objects

◆ getToolSettings()

mixed getToolSettings	(	$mode = `Service\ToolSettings::MODE_CURRENT_LEVEL`,
		$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

◆ getUserResultSourcedIDs()

UserResult[] getUserResultSourcedIDs	(	$localOnly = `false`,
		$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	$idScope	Scope to use for ID values (optional, default is null for platform default)

Returns: UserResult[] Array of UserResult objects

◆ hasAssessmentControlService()

bool hasAssessmentControlService ( )

Check if the Assessment Control service is available.

Returns: bool True if this resource link supports the Assessment Control service

References Result\$SCOPE, and ResourceLink\getSetting().

◆ hasLineItemService()

bool hasLineItemService ( )

Check if the Line Item service is available.

Returns: bool True if this resource link supports the Line Item service

References ResourceLink\getPlatform().

◆ hasMembershipService()

bool 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

References ResourceLink\getSetting().

◆ hasMembershipsService()

bool hasMembershipsService ( )

Check if a Memberships service is available.

Returns: bool True if this resource link supports a Memberships service

References Result\$SCOPE, Score\$SCOPE, ResourceLink\getPlatform(), and ResourceLink\getSetting().

Referenced by ResourceLink\getMembership().

◆ hasOutcomesService()

bool hasOutcomesService ( )

Check if an Outcomes service is available.

Returns: bool True if this resource link supports an Outcomes service

◆ hasResultService()

bool hasResultService ( )

Check if the Result service is available.

Returns: bool True if this resource link supports the Result service

References Score\$SCOPE, and ResourceLink\getSetting().

◆ hasScoreService()

bool hasScoreService ( )

Check if the Score service is available.

Returns: bool True if this resource link supports the Score service

References ResourceLink\getSetting().

◆ hasSettingService()

bool hasSettingService ( )

Check if the Setting extension service is available.

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

References ResourceLink\getContext(), ResourceLink\getContextId(), and ResourceLink\getSetting().

◆ hasToolSettingsService()

bool hasToolSettingsService ( )

Check if the Tool Settings service is available.

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

◆ initialise()

initialise ( )

Initialise the resource link.

Synonym for initialize().

References ResourceLink\initialize().

◆ save()

bool save ( )

Save the resource link to the database.

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

◆ saveSettings()

bool saveSettings ( )

Save setting values.

Returns: bool True if the settings were successfully saved

◆ setConsumerId()

setConsumerId ( $consumerId )

Set tool consumer ID.

Deprecated:: Use setPlatformId() instead

See also: Context::setPlatformId()

Parameters

int $consumerId Tool Consumer ID for this resource link.

References Util\logDebug().

◆ setContext()

setContext ( $context )

Set context.

Parameters

Context $context Context for this resource link.

◆ setContextId()

setContextId ( $contextId )

Set context ID.

Parameters

int $contextId Context ID for this resource link.

◆ setPlatformId()

setPlatformId ( $platformId )

Set platform ID.

Parameters

int $platformId Platform ID for this resource link.

◆ setRecordId()

setRecordId ( $id )

Set resource link record ID.

Parameters

int $id Record ID for this resource link.

◆ setSetting()

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)

◆ setSettings()

setSettings ( $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

◆ setToolSettings()

bool setToolSettings ( $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

Member Data Documentation

◆ $created

int null $created = null

Timestamp for when the object was created.

$created

◆ $extRequest

string null $extRequest = null

Request for last service request.

$extRequest

◆ $extRequestHeaders

array null $extRequestHeaders = null

Request headers for last service request.

$extRequestHeaders

◆ $extResponse

string null $extResponse = null

Response from last service request.

$extResponse

◆ $extResponseHeaders

array null $extResponseHeaders = null

Response header from last service request.

$extResponseHeaders

◆ $groups

array null $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.

$groups

◆ $groupSets

array null $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.

$groupSets

◆ $lastServiceRequest

HttpMessage null $lastServiceRequest = null

HttpMessage object for last service request.

$lastServiceRequest

◆ $ltiResourceLinkId

string null $ltiResourceLinkId = null

Resource link ID as supplied in the last connection request.

$ltiResourceLinkId

Referenced by ResourceLink\fromContext(), and ResourceLink\fromRecordId().

◆ $primaryResourceLinkId

string null $primaryResourceLinkId = null

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

$primaryResourceLinkId

◆ $shareApproved

bool null $shareApproved = null

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

$shareApproved

◆ $title

string null $title = null

Context title.

$title

◆ $updated

int null $updated = null

Timestamp for when the object was last updated.

$updated

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

ResourceLink.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createLineItem()

◆ delete()

◆ doAssessmentControlAction()

◆ doMembershipsService()

◆ doOutcomesService()

◆ doSettingService()

◆ fromConsumer()

◆ fromContext()

◆ fromPlatform()

◆ fromRecordId()

◆ getConsumer()

◆ getConsumerId()

◆ getContext()

◆ getContextId()

◆ getDataConnector()

◆ getId()

◆ getKey()

◆ getLineItems()

◆ getMembership()

◆ getMemberships()

◆ getOutcomes()

◆ getPlatform()

◆ getPlatformId()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getShares()

◆ getToolSettings()

◆ getUserResultSourcedIDs()

◆ hasAssessmentControlService()

◆ hasLineItemService()

◆ hasMembershipService()

◆ hasMembershipsService()

◆ hasOutcomesService()

◆ hasResultService()

◆ hasScoreService()

◆ hasSettingService()

◆ hasToolSettingsService()

◆ initialise()

◆ save()

◆ saveSettings()

◆ setConsumerId()

◆ setContext()

◆ setContextId()

◆ setPlatformId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Member Data Documentation

◆ $created

◆ $extRequest

◆ $extRequestHeaders

◆ $extResponse

◆ $extResponseHeaders

◆ $groups

◆ $groupSets

◆ $lastServiceRequest

◆ $ltiResourceLinkId

◆ $primaryResourceLinkId

◆ $shareApproved

◆ $title

◆ $updated