ApiPlatform Class Reference

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

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

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

$platform

)

Class constructor.

Parameters

Platform

$platform

Member Function Documentation

getToolSettings()

array bool getToolSettings

(

bool

$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

isConfigured()

bool isConfigured

(

)

Check if the API hook has been configured.

Returns

bool True if the API hook has been configured

setToolSettings()

bool setToolSettings

(

array

$settings = []

)

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