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.
	getToolSettings ($simple=true)
	Get Tool Settings.
	setToolSettings ($settings=array())
	Perform a Tool Settings service request.

Protected Attributes
	$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

Definition at line 14 of file ApiPlatform.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$platform

)

Class constructor.

Parameters

Platform

$platform

Reimplemented in ApiToolConsumer.

Definition at line 29 of file ApiPlatform.php.

References ApiPlatform\$platform.

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

array|bool The array of settings if successful, otherwise false

Definition at line 51 of file ApiPlatform.php.

isConfigured()

isConfigured

(

)

Check if the API hook has been configured.

Returns

bool True if the API hook has been configured

Definition at line 39 of file ApiPlatform.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 63 of file ApiPlatform.php.

Field Documentation

$platform

Platform null $platform = null

protected

Platform object.

Definition at line 22 of file ApiPlatform.php.

Referenced by ApiPlatform\__construct().

---

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

• ApiPlatform.php