Class shardimage\shardimagephp\services\SuperBackupService

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

Shardimage superbackup 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
create()	Creates a new superbackup.	shardimage\shardimagephp\services\SuperBackupService
delete()	Deletes a superbackup.	shardimage\shardimagephp\services\SuperBackupService
exists()	Returns whether the specified superbackup exists.	shardimage\shardimagephp\services\SuperBackupService
getController()	Shardimage controller	shardimage\shardimagephp\services\SuperBackupService
getLastError()	Returns the last error in the service.	shardimage\shardimagephp\services\Service
getModule()	Shardimage module	shardimage\shardimagephp\services\SuperBackupService
index()	Fetches all existing backups.	shardimage\shardimagephp\services\SuperBackupService
toArray()	Converts the object an array.	shardimage\shardimagephpapi\base\BaseObject
update()	Updates a superbackup.	shardimage\shardimagephp\services\SuperBackupService
view()	Fetches a superbackup.	shardimage\shardimagephp\services\SuperBackupService

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

create() public method

Creates a new superbackup.

public shardimage\shardimagephp\models\superbackup\SuperBackup\|shardimage\shardimagephpapi\api\Response create ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\superbackup\SuperBackup	SuperBackup object
$optParams	array	Optional API parameters
throws	\shardimage\shardimagephpapi\base\InvalidParamException

delete() public method

Deletes a superbackup.

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

exists() public method

Returns whether the specified superbackup exists.

public boolean exists ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\superbackup\SuperBackup\|string	SuperBackup object or SuperBackup 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 ( )

index() public method

Fetches all existing backups.

public shardimage\shardimagephp\models\superbackup\Index index ( $params = [], $optParams = [] )
$params	array	Required API parameters
$optParams	array	Optional API parameters

update() public method

Updates a superbackup.

public shardimage\shardimagephp\models\superbackup\SuperBackup\|shardimage\shardimagephpapi\api\Response update ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\superbackup\SuperBackup	SuperBackup object
$optParams	array	Optional API parameters
throws	\shardimage\shardimagephpapi\base\InvalidParamException

view() public method

Fetches a superbackup.

public shardimage\shardimagephp\models\superbackup\SuperBackup\|shardimage\shardimagephpapi\api\Response view ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\superbackup\SuperBackup\|string	SuperBackup object or SuperBackup ID
$optParams	shardimage\shardimagephp\models\superbackup\SuperBackup\|array	Optional API parameters