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.

	save ()
	Save the resource link to the database.

	delete ()
	Delete the resource link from the database.

	getConsumer ()
	Get tool consumer.

	getConsumerId ()
	Get tool consumer ID.

	setConsumerId ($consumerId)
	Set tool consumer ID.

	getPlatform ()
	Get platform.

	getPlatformId ()
	Get platform ID.

	setPlatformId ($platformId)
	Set platform ID.

	getContext ()
	Get context.

	getContextId ()
	Get context record ID.

	setContext ($context)
	Set context.

	setContextId ($contextId)
	Set context ID.

	getKey ()
	Get consumer key.

	getId ()
	Get resource link ID.

	getRecordId ()
	Get resource link record ID.

	setRecordId ($id)
	Set resource link record ID.

	getDataConnector ()
	Get the data connector.

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

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

	getSettings ()
	Get an array of all setting values.

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

	saveSettings ()
	Save setting values.

	hasOutcomesService ()
	Check if an Outcomes service is available.

	hasMembershipsService ()
	Check if a Memberships service is available.

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

	hasLineItemService ()
	Check if the Line-item service is available.

	hasScoreService ()
	Check if the Score service is available.

	hasResultService ()
	Check if the Result service is available.

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

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

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

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

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

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

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

	hasMembershipService ()
	Check if the Membership service is supported.

	getMembership ()
	Get Membership.

	getMemberships ($withGroups=false)
	Get Memberships.

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

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

	getLineItems ($resourceId=null, $tag=null, $limit=null)
	Get line-items.

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

	getOutcomes ($limit=null)
	Get all outcomes.

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

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

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

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

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

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

Data Fields
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.

	$title = null
	Context title.

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

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

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

	$lastServiceRequest = null
	HttpMessage object for last service request.

	$extRequest = null
	Request for last service request.

	$extRequestHeaders = null
	Request headers for last service request.

	$extResponse = null
	Response from last service request.

	$extResponseHeaders = null
	Response header from last service request.

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

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

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

	$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

Definition at line 18 of file ResourceLink.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Class constructor.

Definition at line 258 of file ResourceLink.php.

References ResourceLink\initialize().

Member Function Documentation

◆ createLineItem()

createLineItem ( $lineItem )

Create a new line-item.

Parameters

LineItem $lineItem Line-item object

Returns: bool True if successful

Definition at line 1288 of file ResourceLink.php.

References ResourceLink\$ltiResourceLinkId.

◆ delete()

delete ( )

Delete the resource link from the database.

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

Definition at line 308 of file ResourceLink.php.

References ResourceLink\getDataConnector().

◆ doAssessmentControlAction()

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

Definition at line 1339 of file ResourceLink.php.

References ResourceLink\getSetting().

◆ doMembershipsService()

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

Definition at line 887 of file ResourceLink.php.

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

◆ doOutcomesService()

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

Definition at line 709 of file ResourceLink.php.

References ResourceLink\EXT_DELETE, ResourceLink\EXT_READ, ResourceLink\EXT_WRITE, and ResourceLink\getPlatform().

◆ doSettingService()

doSettingService	(	$action,
		$value = `null`
	)

Perform a Setting service request.

Parameters

int	$action	The action type constant
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

Definition at line 902 of file ResourceLink.php.

References ResourceLink\EXT_DELETE, ResourceLink\EXT_READ, ResourceLink\EXT_WRITE, ResourceLink\getSetting(), ResourceLink\saveSettings(), and ResourceLink\setSetting().

◆ fromConsumer()

static 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 \| null	$tempId	Temporary Resource link ID value (optional, default is null)

Returns: ResourceLink

Definition at line 1374 of file ResourceLink.php.

References ResourceLink\$ltiResourceLinkId, ResourceLink\fromPlatform(), and Util\logDebug().

◆ fromContext()

static fromContext	(	$context,
		$ltiResourceLinkId,
		$tempId = `null`
	)

static

Class constructor from context.

Parameters

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

Returns: ResourceLink

Definition at line 1417 of file ResourceLink.php.

References ResourceLink\$ltiResourceLinkId.

◆ fromPlatform()

static fromPlatform	(	$platform,
		$ltiResourceLinkId,
		$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

Definition at line 1390 of file ResourceLink.php.

References ResourceLink\$ltiResourceLinkId.

Referenced by ResourceLink\fromConsumer().

◆ fromRecordId()

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

Referenced by UserResult\getResourceLink().

◆ getConsumer()

getConsumer ( )

Get tool consumer.

Deprecated:: Use getPlatform() instead

See also: Context::getPlatform()

Returns: ToolConsumer Tool consumer object for this resource link.

Definition at line 321 of file ResourceLink.php.

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

◆ getConsumerId()

getConsumerId ( )

Get tool consumer ID.

Deprecated:: Use getPlatformId() instead

See also: Context::getPlatformId()

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

Definition at line 336 of file ResourceLink.php.

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

◆ getContext()

getContext ( )

Get context.

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

Definition at line 402 of file ResourceLink.php.

References Context\fromRecordId(), and ResourceLink\getDataConnector().

Referenced by ResourceLink\getMemberships(), ResourceLink\getPlatform(), and ResourceLink\hasMembershipsService().

◆ getContextId()

getContextId ( )

Get context record ID.

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

Definition at line 416 of file ResourceLink.php.

Referenced by ResourceLink\getMemberships(), and ResourceLink\hasMembershipsService().

◆ getDataConnector()

getDataConnector ( )

Get the data connector.

Returns: DataConnector|null Data connector object or string

Definition at line 494 of file ResourceLink.php.

References ResourceLink\getPlatform().

Referenced by ResourceLink\delete(), ResourceLink\getContext(), ResourceLink\getPlatform(), ResourceLink\getShares(), ResourceLink\getUserResultSourcedIDs(), and ResourceLink\save().

◆ getId()

getId ( )

Get resource link ID.

Returns: string ID for this resource link.

Definition at line 464 of file ResourceLink.php.

References ResourceLink\$ltiResourceLinkId.

◆ getKey()

getKey ( )

Get consumer key.

Returns: string Consumer key value for this resource link.

Definition at line 454 of file ResourceLink.php.

References ResourceLink\getPlatform().

◆ getLineItems()

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

Definition at line 1259 of file ResourceLink.php.

◆ getMembership()

getMembership ( )

Get Membership.

Deprecated:: Use getMemberships() instead

See also: ResourceLink::getMemberships()

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

Definition at line 1042 of file ResourceLink.php.

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

◆ getMemberships()

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

Definition at line 1056 of file ResourceLink.php.

References ResourceLink\$groups, UserResult\fromResourceLink(), ResourceLink\getContext(), ResourceLink\getContextId(), ResourceLink\getPlatform(), ResourceLink\getSetting(), ResourceLink\getUserResultSourcedIDs(), Tool\ID_SCOPE_RESOURCE, and System\parseRoles().

Referenced by ResourceLink\doMembershipsService(), and ResourceLink\getMembership().

◆ getOutcomes()

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

Definition at line 1307 of file ResourceLink.php.

References ResourceLink\getPlatform(), and ResourceLink\getSetting().

◆ getPlatform()

getPlatform ( )

Get platform.

Returns: Platform Platform object for this resource link.

Definition at line 363 of file ResourceLink.php.

References Platform\fromRecordId(), ResourceLink\getContext(), and ResourceLink\getDataConnector().

Referenced by ResourceLink\doOutcomesService(), ResourceLink\getConsumer(), ResourceLink\getDataConnector(), ResourceLink\getKey(), ResourceLink\getMemberships(), ResourceLink\getOutcomes(), ResourceLink\getToolSettings(), ResourceLink\hasMembershipsService(), ResourceLink\hasOutcomesService(), ResourceLink\hasToolSettingsService(), and ResourceLink\setToolSettings().

◆ getPlatformId()

getPlatformId ( )

Get platform ID.

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

Definition at line 381 of file ResourceLink.php.

Referenced by ResourceLink\getConsumerId().

◆ getRecordId()

getRecordId ( )

Get resource link record ID.

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

Definition at line 474 of file ResourceLink.php.

◆ getSetting()

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

◆ getSettings()

getSettings ( )

Get an array of all setting values.

Returns: array Associative array of setting values

Definition at line 549 of file ResourceLink.php.

◆ getShares()

getShares ( )

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

Returns: ResourceLinkShare[] Array of ResourceLinkShare objects

Definition at line 1245 of file ResourceLink.php.

References ResourceLink\getDataConnector().

◆ getToolSettings()

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

Definition at line 974 of file ResourceLink.php.

References ResourceLink\getPlatform(), and ResourceLink\getSetting().

◆ getUserResultSourcedIDs()

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 \| null	$idScope	Scope to use for ID values (optional, default is null for platform default)

Returns: UserResult[] Array of UserResult objects

Definition at line 1235 of file ResourceLink.php.

References ResourceLink\getDataConnector().

Referenced by ResourceLink\getMemberships().

◆ hasAssessmentControlService()

hasAssessmentControlService ( )

Check if the Assessment Control service is available.

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

Definition at line 693 of file ResourceLink.php.

References ResourceLink\getSetting().

◆ hasLineItemService()

hasLineItemService ( )

Check if the Line-item service is available.

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

Definition at line 639 of file ResourceLink.php.

References ResourceLink\getSetting().

◆ hasMembershipService()

hasMembershipService ( )

Check if the Membership service is supported.

Deprecated:: Use hasMembershipsService() instead

See also: ResourceLink::hasMembershipsService()

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

Definition at line 1027 of file ResourceLink.php.

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

◆ hasMembershipsService()

hasMembershipsService ( )

Check if a Memberships service is available.

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

Definition at line 603 of file ResourceLink.php.

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

Referenced by ResourceLink\hasMembershipService().

◆ hasOutcomesService()

hasOutcomesService ( )

Check if an Outcomes service is available.

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

Definition at line 585 of file ResourceLink.php.

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

◆ hasResultService()

hasResultService ( )

Check if the Result service is available.

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

Definition at line 675 of file ResourceLink.php.

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

◆ hasScoreService()

hasScoreService ( )

Check if the Score service is available.

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

Definition at line 657 of file ResourceLink.php.

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

◆ hasSettingService()

hasSettingService ( )

Check if the Setting extension service is available.

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

Definition at line 627 of file ResourceLink.php.

References ResourceLink\getSetting().

◆ hasToolSettingsService()

hasToolSettingsService ( )

Check if the Tool Settings service is available.

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

Definition at line 957 of file ResourceLink.php.

References ResourceLink\getPlatform(), and ResourceLink\getSetting().

◆ initialise()

initialise ( )

Initialise the resource link.

Synonym for initialize().

Definition at line 283 of file ResourceLink.php.

References ResourceLink\initialize().

◆ initialize()

initialize ( )

Initialise the resource link.

Definition at line 266 of file ResourceLink.php.

Referenced by ResourceLink\__construct(), and ResourceLink\initialise().

◆ save()

save ( )

Save the resource link to the database.

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

Definition at line 293 of file ResourceLink.php.

References ResourceLink\getDataConnector().

Referenced by ResourceLink\saveSettings().

◆ saveSettings()

saveSettings ( )

Save setting values.

Returns: bool True if the settings were successfully saved

Definition at line 569 of file ResourceLink.php.

References ResourceLink\save().

Referenced by ResourceLink\doSettingService().

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

Definition at line 351 of file ResourceLink.php.

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

◆ setContext()

setContext ( $context )

Set context.

Parameters

Context $context Context for this resource link.

Definition at line 430 of file ResourceLink.php.

◆ setContextId()

setContextId ( $contextId )

Set context ID.

Parameters

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

Definition at line 441 of file ResourceLink.php.

◆ setPlatformId()

setPlatformId ( $platformId )

Set platform ID.

Parameters

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

Definition at line 391 of file ResourceLink.php.

Referenced by ResourceLink\setConsumerId().

◆ setRecordId()

setRecordId ( $id )

Set resource link record ID.

Parameters

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

Definition at line 484 of file ResourceLink.php.

◆ setSetting()

setSetting	(	$name,
		$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)

Definition at line 531 of file ResourceLink.php.

References ResourceLink\getSetting().

Referenced by ResourceLink\doSettingService().

◆ setSettings()

setSettings ( $settings )

Set an array of all setting values.

Parameters

array $settings Associative array of setting values

Definition at line 559 of file ResourceLink.php.

◆ setToolSettings()

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

Definition at line 1001 of file ResourceLink.php.

References ResourceLink\getPlatform(), and ResourceLink\getSetting().

Field Documentation

◆ $created

int null $created = null

Timestamp for when the object was created.

Definition at line 176 of file ResourceLink.php.

◆ $extRequest

string null $extRequest = null

Request for last service request.

Definition at line 134 of file ResourceLink.php.

◆ $extRequestHeaders

array null $extRequestHeaders = null

Request headers for last service request.

Definition at line 141 of file ResourceLink.php.

◆ $extResponse

string null $extResponse = null

Response from last service request.

Definition at line 148 of file ResourceLink.php.

◆ $extResponseHeaders

array null $extResponseHeaders = null

Response header from last service request.

Definition at line 155 of file ResourceLink.php.

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

Definition at line 120 of file ResourceLink.php.

Referenced by ResourceLink\getMemberships().

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

Definition at line 108 of file ResourceLink.php.

◆ $lastServiceRequest

HttpMessage null $lastServiceRequest = null

HttpMessage object for last service request.

Definition at line 127 of file ResourceLink.php.

◆ $ltiResourceLinkId

string null $ltiResourceLinkId = null

Resource link ID as supplied in the last connection request.

Definition at line 93 of file ResourceLink.php.

Referenced by ResourceLink\createLineItem(), ResourceLink\fromConsumer(), ResourceLink\fromContext(), ResourceLink\fromPlatform(), and ResourceLink\getId().

◆ $primaryResourceLinkId

string null $primaryResourceLinkId = null

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

Definition at line 162 of file ResourceLink.php.

◆ $shareApproved

bool null $shareApproved = null

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

Definition at line 169 of file ResourceLink.php.

◆ $title

string null $title = null

Context title.

Definition at line 86 of file ResourceLink.php.

◆ $updated

int null $updated = null

Timestamp for when the object was last updated.

Definition at line 183 of file ResourceLink.php.

◆ EXT_CREATE

const EXT_CREATE = 4

Create action.

Definition at line 39 of file ResourceLink.php.

◆ EXT_DELETE

const EXT_DELETE = 3

Delete action.

Definition at line 34 of file ResourceLink.php.

Referenced by ResourceLink\doOutcomesService(), and ResourceLink\doSettingService().

◆ EXT_READ

const EXT_READ = 1

Read action.

Definition at line 24 of file ResourceLink.php.

Referenced by ResourceLink\doOutcomesService(), and ResourceLink\doSettingService().

◆ EXT_TYPE_DECIMAL

const EXT_TYPE_DECIMAL = 'decimal'

Decimal outcome type.

Definition at line 49 of file ResourceLink.php.

◆ EXT_TYPE_LETTER_AF

const EXT_TYPE_LETTER_AF = 'letteraf'

Letter (A-F) outcome type.

Definition at line 64 of file ResourceLink.php.

◆ EXT_TYPE_LETTER_AF_PLUS

const EXT_TYPE_LETTER_AF_PLUS = 'letterafplus'

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

Definition at line 69 of file ResourceLink.php.

◆ EXT_TYPE_PASS_FAIL

const EXT_TYPE_PASS_FAIL = 'passfail'

Pass/fail outcome type.

Definition at line 74 of file ResourceLink.php.

◆ EXT_TYPE_PERCENTAGE

const EXT_TYPE_PERCENTAGE = 'percentage'

Percentage outcome type.

Definition at line 54 of file ResourceLink.php.

◆ EXT_TYPE_RATIO

const EXT_TYPE_RATIO = 'ratio'

Ratio outcome type.

Definition at line 59 of file ResourceLink.php.

◆ EXT_TYPE_TEXT

const EXT_TYPE_TEXT = 'freetext'

Free text outcome type.

Definition at line 79 of file ResourceLink.php.

◆ EXT_UPDATE

const EXT_UPDATE = 5

Update action.

Definition at line 44 of file ResourceLink.php.

◆ EXT_WRITE

const EXT_WRITE = 2

Write (create/update) action.

Definition at line 29 of file ResourceLink.php.

Referenced by ResourceLink\doOutcomesService(), and ResourceLink\doSettingService().

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

ResourceLink.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

◆ initialize()

◆ save()

◆ saveSettings()

◆ setConsumerId()

◆ setContext()

◆ setContextId()

◆ setPlatformId()

◆ setRecordId()

◆ setSetting()

◆ setSettings()

◆ setToolSettings()

Field Documentation

◆ $created

◆ $extRequest

◆ $extRequestHeaders

◆ $extResponse

◆ $extResponseHeaders

◆ $groups

◆ $groupSets

◆ $lastServiceRequest

◆ $ltiResourceLinkId

◆ $primaryResourceLinkId

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