Class shardimage\shardimagephp\services\FirewallService

Inheritanceshardimage\shardimagephp\services\FirewallService » shardimage\shardimagephp\services\Service » shardimage\shardimagephpapi\base\BaseObject

Shardimage firewall service.

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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

Hide inherited methods

MethodDescriptionDefined 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 firewall. shardimage\shardimagephp\services\FirewallService
delete() Deletes a firewall. shardimage\shardimagephp\services\FirewallService
exists() Returns whether the firewall exists. shardimage\shardimagephp\services\FirewallService
getController() Shardimage controller shardimage\shardimagephp\services\FirewallService
getLastError() Returns the last error in the service. shardimage\shardimagephp\services\Service
getModule() Shardimage module shardimage\shardimagephp\services\FirewallService
index() Fetches all firewalls. shardimage\shardimagephp\services\FirewallService
toArray() Converts the object an array. shardimage\shardimagephpapi\base\BaseObject
update() Updates a firewall. shardimage\shardimagephp\services\FirewallService
view() Fetches a firewall. shardimage\shardimagephp\services\FirewallService

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

create() public method

Creates a firewall.

public shardimage\shardimagephp\models\firewall\Firewall|shardimage\shardimagephpapi\api\Response create ( $params, $optParams = [] )
$params shardimage\shardimagephp\models\firewall\Firewall

Firewall object

$optParams array

Optional API parameters

throws shardimage\shardimagephpapi\base\exceptions\InvalidParamException
delete() public method

Deletes a firewall.

public boolean delete ( $params, $optParams = [] )
$params shardimage\shardimagephp\models\firewall\Firewall|string

Firewall object or Firewall ID

$optParams array

Optional API parameters

exists() public method

Returns whether the firewall exists.

public boolean exists ( $params, $optParams = [] )
$params shardimage\shardimagephp\models\firewall\Firewall|string

Firewall object or Firewall 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 firewalls.

public shardimage\shardimagephp\models\firewall\Index index ( $params = [], $optParams = [] )
$params array

Required API parameters

$optParams \shardimage\shardimagephp\services\FirewallIndexParams|array

Optional API parameters

  • projection - an array of projection flags: noRules, noClouds, noCloudIds
  • order - the order of results: name, -name, created, -created
  • maxResults - number of results
  • nextPageToken - token for next result page
  • update() public method

    Updates a firewall.

    public shardimage\shardimagephp\models\firewall\Firewall|shardimage\shardimagephpapi\api\Response update ( $params, $optParams = [] )
    $params shardimage\shardimagephp\models\firewall\Firewall

    Firewall object

    $optParams array

    Optional API parameters

    throws shardimage\shardimagephpapi\base\exceptions\InvalidParamException
    view() public method

    Fetches a firewall.

    public shardimage\shardimagephp\models\firewall\Firewall|shardimage\shardimagephpapi\api\Response view ( $params, $optParams = [] )
    $params shardimage\shardimagephp\models\firewall\Firewall|string

    Firewall object or Firewall ID

    $optParams array

    Optional API parameters