Class shardimage\shardimagephp\services\JobService

All Classes | Properties | Methods

Inheritance	shardimage\shardimagephp\services\JobService » shardimage\shardimagephp\services\Service » shardimage\shardimagephpapi\base\BaseObject

Shardimage job service.

Protected Properties

Property	Type	Description	Defined By
$client	shardimage\shardimagephp\auth\Client	Shardimage API Client	shardimage\shardimagephp\services\Service
$lastError	mixed	Last error in the service	shardimage\shardimagephp\services\Service
$version	string	Shardimage module version	shardimage\shardimagephp\services\Service

Method	Description	Defined By
__construct()	Creates the service.	shardimage\shardimagephp\services\Service
__get()	Returns the value of a non-defined property, it there is a getter method.	shardimage\shardimagephpapi\base\BaseObject
__isset()	Does the non-defined property with a getter exist and is it not NULL?	shardimage\shardimagephpapi\base\BaseObject
__set()	Sets the value of a non-defined property, if there is a setter method.	shardimage\shardimagephpapi\base\BaseObject
__unset()	Sets the value of a non-defined property to NULL, if there is a setter.	shardimage\shardimagephpapi\base\BaseObject
delete()	Deletes a job.	shardimage\shardimagephp\services\JobService
exists()	Returns whether the job exists.	shardimage\shardimagephp\services\JobService
getController()	Shardimage controller	shardimage\shardimagephp\services\JobService
getLastError()	Returns the last error in the service.	shardimage\shardimagephp\services\Service
getModule()	Shardimage module	shardimage\shardimagephp\services\JobService
toArray()	Converts the object an array.	shardimage\shardimagephpapi\base\BaseObject
view()	Fetches a job.	shardimage\shardimagephp\services\JobService

Method	Description	Defined By
ensureClass()	Creates an object from the given parameters.	shardimage\shardimagephpapi\base\BaseObject
init()	Custom initialization.	shardimage\shardimagephpapi\base\BaseObject
sendRequest()	Sends the request to the Shardimage API and returns with the Response object or the ID for the request if deferred.	shardimage\shardimagephp\services\Service

delete() public method

Deletes a job.

public boolean delete ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\job\Job\|string	Job object or Job ID
$optParams	array	Optional API parameters

exists() public method

Returns whether the job exists.

public boolean exists ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\job\Job\|string	Job object or Job ID
$optParams	array	Optional API parameters

getController() public static method

Shardimage controller

public static void getController ( )

getModule() public static method

Shardimage module

public static void getModule ( )

view() public method

Fetches a job.

public shardimage\shardimagephp\models\job\Job\|null view ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\job\Job\|string	Job object or Job ID
$optParams	array	Optional API parameters