Class shardimage\shardimagephp\services\SystemService
| Inheritance | shardimage\shardimagephp\services\SystemService » shardimage\shardimagephp\services\Service » shardimage\shardimagephpapi\base\BaseObject |
|---|
Shardimage system 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 |
Public Methods
| 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 |
| getController() | Shardimage controller | shardimage\shardimagephp\services\SystemService |
| getLastError() | Returns the last error in the service. | shardimage\shardimagephp\services\Service |
| getModule() | Shardimage module | shardimage\shardimagephp\services\SystemService |
| ping() | Pings a Shardimage server and fetches statistical data about the request. | shardimage\shardimagephp\services\SystemService |
| toArray() | Converts the object an array. | shardimage\shardimagephpapi\base\BaseObject |
Protected Methods
| 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 |
Method Details
Shardimage controller
| public static void getController ( ) |
Shardimage module
| public static void getModule ( ) |
Pings a Shardimage server and fetches statistical data about the request.
| public shardimage\shardimagephp\models\system\ping\Ping|shardimage\shardimagephpapi\api\Response ping ( $params = [], $optParams = [] ) | ||
| $params | array | Required API parameters |
| $optParams | array | Optional API parameters |