Class to implement Resource Link services for a Canvas platform via its proprietary API. More...

Inheritance diagram for CanvasApiResourceLink:

Public Member Functions
	__construct (ResourceLink $resourceLink)
	Class constructor.

array bool	getMemberships (bool $withGroups)
	Get memberships.

Public Member Functions inherited from ApiResourceLink
bool	isConfigured ()
	Check if the API hook has been configured.

string bool	doOutcomesService (ServiceAction $action, Outcome $ltiOutcome, UserResult $userResult)
	Perform an Outcomes service request.

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

bool	setToolSettings (array $settings=[])
	Perform a Tool Settings service request.

Public Member Functions inherited from CanvasApi
bool	isConfigured ()
	Check if the API hook has been configured.

Additional Inherited Members
Protected Attributes inherited from ApiResourceLink
ResourceLink	$resourceLink
	Resource link object.

Detailed Description

Class to implement Resource Link services for a Canvas platform via its proprietary API.

Author: Simon Booth s.p.b.nosp@m.ooth.nosp@m.@stir.nosp@m..ac..nosp@m.uk; Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

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

Constructor & Destructor Documentation

__construct ( ResourceLink $resourceLink )

Class constructor.

Parameters

ResourceLink $resourceLink

Reimplemented from ApiResourceLink.

array bool getMemberships ( bool $withGroups )

Get memberships.

Parameters

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

Returns: array|bool Array of UserResult objects or false if the request was not successful

Reimplemented from ApiResourceLink.