ApiToolConsumer Class Reference

Class to implement Tool Consumer services for a tool consumer via its proprietary API. More...

Public Member Functions
	__construct ($consumer)
	Class constructor. More...
	getToolSettings ($simple=true)
	Get Tool Settings. More...
	setToolSettings ($settings=array())
	Perform a Tool Settings service request. More...

Protected Attributes
	$consumer = null
	Tool Consumer object. More...

Detailed Description

Class to implement Tool Consumer services for a tool consumer via its proprietary API.

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

Version

3.1.0

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

Definition at line 13 of file ApiToolConsumer.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$consumer

)

Class constructor.

Parameters

\ceLTIc\LTI\ToolConsmumer

$consumer

Definition at line 28 of file ApiToolConsumer.php.

References ApiToolConsumer\$consumer.

Member Function Documentation

getToolSettings()

getToolSettings

(

$simple = true

)

Get Tool Settings.

Parameters

bool

$simple

True if all the simple media type is to be used (optional, default is true)

Returns

mixed The array of settings if successful, otherwise false

Definition at line 40 of file ApiToolConsumer.php.

setToolSettings()

setToolSettings

(

$settings = array()

)

Perform a Tool Settings service request.

Parameters

array

$settings

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

Returns

bool True if action was successful, otherwise false

Definition at line 52 of file ApiToolConsumer.php.

Field Documentation

$consumer

ceLTIc LTI ToolConsumer null $consumer = null

protected

Tool Consumer object.

Definition at line 21 of file ApiToolConsumer.php.

Referenced by ApiToolConsumer\__construct().

---

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

• ApiToolConsumer.php