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

Inheritance diagram for ResourceLink:

Public Member Functions
	__construct ()
	Class constructor.

void	initialize ()
	Initialise the resource link.

void	initialise ()
	Initialise the resource link.

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

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

Platform	getPlatform ()
	Get platform.

int null	getPlatformId ()
	Get platform ID.

void	setPlatformId (?int $platformId)
	Set platform ID.

Context null	getContext ()
	Get context.

int null	getContextId ()
	Get context record ID.

void	setContext (Context $context)
	Set context.

void	setContextId (?int $contextId)
	Set context ID.

string	getKey ()
	Get consumer key.

string null	getId ()
	Get resource link ID.

int null	getRecordId ()
	Get resource link record ID.

	setRecordId (int\|string $id)
	Set resource link record ID.

DataConnector null	getDataConnector ()
	Get the data connector.

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

void	setSetting (string $name, string\|array\|null $value=null)
	Set a setting value.

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

void	setSettings (array $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 (ServiceAction $action, Outcome $ltiOutcome, UserResult $userResult)
	Perform an Outcomes service request.

string bool	doSettingService (ServiceAction $action, ?string $value=null)
	Perform a Setting service request.

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

array bool	getToolSettings (?ToolSettingsMode $mode=null, bool $simple=true)
	Get Tool Settings.

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

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

UserResult[]	getUserResultSourcedIDs (bool $localOnly=false, ?IdScope $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 (?string $resourceId=null, ?string $tag=null, ?int $limit=null)
	Get line-items.

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

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

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

Static Public Member Functions
static ResourceLink	fromPlatform (Platform $platform, string $ltiResourceLinkId, ?string $tempId=null)
	Class constructor from platform.

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

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

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

Public Attributes
string	$title = null
	Context title.

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

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

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

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

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

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

string	$extResponse = null
	Response from last service request.

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

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

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

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

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

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

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

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

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

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

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

static string	$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 $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.

◆ doAssessmentControlAction()

string bool 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

◆ doOutcomesService()

bool doOutcomesService	(	ServiceAction	$action,
		Outcome	$ltiOutcome,
		UserResult	$userResult )

Perform an Outcomes service request.

Parameters

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

Returns: bool True if the request was successfully processed

◆ doSettingService()

string bool doSettingService	(	ServiceAction	$action,
		?string	$value = null )

Perform a Setting service request.

Parameters

ServiceAction	$action	The action type
string \| null	$value	The setting value (optional, default is null)

Returns: string|bool The setting value for a read action, true if a write or delete action was successful, otherwise false

◆ fromContext()

static 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

◆ fromPlatform()

static ResourceLink fromPlatform	(	Platform	$platform,
		string	$ltiResourceLinkId,
		?string	$tempId = null )

static

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

◆ fromRecordId()

static 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

◆ getContext()

Context null getContext ( )

Get context.

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

Referenced by ResourceLink\initialise().

◆ getContextId()

int null getContextId ( )

Get context record ID.

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

Referenced by ResourceLink\setSettings().

◆ getDataConnector()

DataConnector null getDataConnector ( )

Get the data connector.

Returns: DataConnector|null Data connector object or string

Referenced by ResourceLink\initialize().

◆ getId()

string null getId ( )

Get resource link ID.

Returns: string|null ID for this resource link.

Referenced by DataConnector_sql\saveResourceLink().

◆ getKey()

string getKey ( )

Get consumer key.

Returns: string Consumer key value for this resource link.

◆ getLineItems()

LineItem[] bool getLineItems	(	?string	$resourceId = null,
		?string	$tag = null,
		?int	$limit = null )

Get line-items.

Parameters

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

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

◆ getMemberships()

array bool getMemberships ( bool $withGroups = false )

Get Memberships.

Parameters

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

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

◆ getOutcomes()

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

◆ getPlatform()

Platform getPlatform ( )

Get platform.

Returns: Platform Platform object for this resource link.

Referenced by ResourceLink\getSettings().

◆ 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.

Referenced by DataConnector_mysqli\getUserResultSourcedIDsResourceLink(), DataConnector_pgsql\getUserResultSourcedIDsResourceLink(), DataConnector_mysqli\loadUserResult(), DataConnector_oci8\loadUserResult(), and DataConnector_pdo\loadUserResult().

◆ getSetting()

string 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

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

◆ getSettings()

array getSettings ( )

Get an array of all setting values.

Returns: array Associative array of setting values

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

Referenced by DataConnector_sql\saveResourceLink().

◆ 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()

array bool getToolSettings	(	?ToolSettingsMode	$mode = null,
		bool	$simple = true )

Get Tool Settings.

Parameters

ToolSettingsMode \| null	$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: array|bool The array of settings if successful, otherwise false

◆ getUserResultSourcedIDs()

UserResult[] getUserResultSourcedIDs	(	bool	$localOnly = false,
		?IdScope	$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)
IdScope \| null	$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

◆ hasLineItemService()

bool hasLineItemService ( )

Check if the Line-item service is available.

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

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

◆ hasMembershipsService()

bool hasMembershipsService ( )

Check if a Memberships service is available.

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

References ResourceLink\getSetting().

◆ 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 Outcome\setValue().

◆ hasScoreService()

bool hasScoreService ( )

Check if the Score service is available.

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

◆ hasSettingService()

bool hasSettingService ( )

Check if the Setting extension service is available.

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

◆ hasToolSettingsService()

bool hasToolSettingsService ( )

Check if the Tool Settings service is available.

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

◆ initialise()

void initialise ( )

Initialise the resource link.

Synonym for initialize().

References ResourceLink\getContext(), and Context\getPlatform().

◆ 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

◆ setContext()

void setContext ( Context $context )

Set context.

Parameters

Context $context Context for this resource link.

◆ setContextId()

void setContextId ( ?int $contextId )

Set context ID.

Parameters

int | null $contextId Context ID for this resource link.

◆ setPlatformId()

void setPlatformId ( ?int $platformId )

Set platform ID.

Parameters

int | null $platformId Platform ID for this resource link.

◆ setRecordId()

setRecordId ( int|string $id )

Set resource link record ID.

Parameters

int | string $id Record ID for this resource link.

◆ setSetting()

void setSetting	(	string	$name,
		string\|array\|null	$value = null )

Set a setting value.

Parameters

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

◆ setSettings()

void setSettings ( array $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

References ResourceLink\getContextId().

◆ setToolSettings()

bool setToolSettings ( array $settings = [] )

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

◆ $extRequest

string null $extRequest = null

Request for last service request.

$extRequest

◆ $groups

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

◆ $groupSets

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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createLineItem()

◆ delete()

◆ doAssessmentControlAction()

◆ doOutcomesService()

◆ doSettingService()

◆ fromContext()

◆ fromPlatform()

◆ fromRecordId()

◆ getContext()

◆ getContextId()

◆ getDataConnector()

◆ getId()

◆ getKey()

◆ getLineItems()

◆ getMemberships()

◆ getOutcomes()

◆ getPlatform()

◆ getPlatformId()

◆ getRecordId()

◆ getSetting()

◆ getSettings()

◆ getShares()

◆ getToolSettings()

◆ getUserResultSourcedIDs()

◆ hasAssessmentControlService()

◆ hasLineItemService()

◆ hasMembershipsService()

◆ hasOutcomesService()

◆ hasResultService()

◆ hasScoreService()

◆ hasSettingService()

◆ hasToolSettingsService()

◆ initialise()

◆ save()

◆ saveSettings()

◆ setContext()

◆ setContextId()

◆ setPlatformId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Member Data Documentation

◆ $extRequest

◆ $groups

◆ $groupSets