CanvasApiContext Class Reference

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

Inheritance diagram for CanvasApiContext:

Public Member Functions
	__construct (Context $context)
	Class constructor.
bool	getGroups ()
	Get course group sets and groups.
array bool	getMemberships (bool $withGroups)
	Get memberships.
Public Member Functions inherited from ApiContext
bool	isConfigured ()
	Check if the API hook has been configured.
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 ApiContext
Context	$context
	Context 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

Copyright

SPV Software Products

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

Constructor & Destructor Documentation

__construct()

__construct

(

Context

$context

)

Class constructor.

Parameters

Context

$context

Reimplemented from ApiContext.

Member Function Documentation

getGroups()

bool getGroups

(

)

Get course group sets and groups.

Returns

bool True if the request was successful

Reimplemented from ApiContext.

getMemberships()

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