ToolSettings Class Reference

Class to implement the Tool Settings service. More...

Inheritance diagram for ToolSettings:

Public Member Functions
	__construct ($source, $endpoint, $simple=true)
	Class constructor.
mixed	get ($mode=self::MODE_CURRENT_LEVEL)
	Get the tool settings.
bool	set ($settings)
	Set the tool settings.
Public Member Functions inherited from Service
	__construct ($platform, $endpoint)
	Class constructor.
ToolConsumer	getConsumer ()
	Get tool consumer.
Platform	getPlatform ()
	Get platform.
string	getScope ()
	Get access scope.
HttpMessage	send ($method, $parameters=array(), $body=null)
	Send a service request.
HttpMessage	getHttpMessage ()
	Get HttpMessage object for last request.

Public Attributes
const	MODE_CURRENT_LEVEL = 1
	Settings at current level mode.
const	MODE_ALL_LEVELS = 2
	Settings at all levels mode.
const	MODE_DISTINCT_NAMES = 3
	Settings with distinct names at all levels mode.
Public Attributes inherited from Service
bool	$unsigned = false
	Whether service request should be sent unsigned.

Static Public Attributes
static	$SCOPE = 'https://purl.imsglobal.org/spec/lti-ts/scope/toolsetting'
	Access scope.

Additional Inherited Members
Protected Member Functions inherited from Service
array	parseContextsInArray ($contexts, $arr)
	Parse the JSON for context references.
Protected Attributes inherited from Service
string	$endpoint = null
	Service endpoint.
string	$scope = null
	Service access scope.
string	$mediaType = null
	Media type of message body.

Detailed Description

Class to implement the Tool Settings service.

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

Constructor & Destructor Documentation

__construct()

__construct	(		$source,
			$endpoint,
			$simple = true
	)

Class constructor.

Parameters

Platform | Context | ResourceLink	$source	The object to which the settings apply (ResourceLink, Context or Platform)
string	$endpoint	Service endpoint
bool	$simple	True if the simple media type is to be used (optional, default is true)

Member Function Documentation

get()

mixed get

(

$mode = self::MODE_CURRENT_LEVEL

)

Get the tool settings.

Parameters

int

$mode

Mode for request (optional, default is current level only)

Returns

mixed The array of settings if successful, otherwise false

set()

bool set

(

$settings

)

Set the tool settings.

Parameters

array

$settings

An associative array of settings (optional, default is null)

Returns

bool True if request was successful

---

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

• ToolSettings.php