ApiPlatform Class Reference

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

Inheritance diagram for ApiPlatform:

Public Member Functions
	__construct ($platform)
	Class constructor.
	isConfigured ()
	Check if the API hook has been configured.
mixed	getToolSettings ($simple=true)
	Get Tool Settings.
bool	setToolSettings ($settings=array())
	Perform a Tool Settings service request.

Protected Attributes
ceLTIc LTI Platform null	$platform = null
	Platform object.

Detailed Description

Class to implement services for a platform 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

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

Constructor & Destructor Documentation

__construct()

__construct

(

$platform

)

Class constructor.

Parameters

\ceLTIc\LTI\Platform

$platform

Reimplemented in ApiToolConsumer.

Member Function Documentation

getToolSettings()

mixed 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

setToolSettings()

bool 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

Member Data Documentation

$platform

ceLTIc LTI Platform null $platform = null

protected

Platform object.

$platform

---

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

• ApiPlatform.php