Filter methods¶
Filter API actions provide external actors with ways to query and manipulate filters and their definitions.
- filterGetByType
- filterSave
- filtersDelete
The filterGetByType Method¶
Retrieve and display a list of filters.
Method filterGetByType definition¶
<?php
public function filterGetByType($type) { }
Parameter | Data Type | Default value | Required | Description |
---|---|---|---|---|
$type | string | yes | Type of a filter (issue,job) |
filterGetByType information¶
Return value | \ZendService\ZendServerAPI\DataTypes\Filters (Filters api doc) |
Online reference | filterGetByType online reference |
Available in Version |
|
Example¶
<?php
use ZendService\ZendServerAPI\Filter;
$server = new Filter();
$filters = $server->filterGetByType("issue");
foreach($filters as $filter) {
echo $filter->getName() . PHP_EOL;
}
The filterSave Method¶
Save a filter.
Method filterSave definition¶
<?php
public function filterSave($type, $name, $id = null, $data = array()) { }
Parameter | Data Type | Default value | Required | Description |
---|---|---|---|---|
$type | string | yes | Type of a filter (issue,job) | |
$name | string | yes | Name of filter. | |
$id | int | no | ID of a filter. | |
$data | array | array() | no | Array of parameters to be saved. |
filterSave information¶
Return value | \ZendService\ZendServerAPI\DataTypes\Filter (Filter api doc) |
Online reference | filterSave online reference |
Available in Version |
|
Example¶
<?php
use ZendService\ZendServerAPI\Filter;
$server = new Filter();
$filter = $server->filterSave("issue", "foo", array("eventTypes" => array("function-slow-exec")));
echo $filter->getName() . " successfully added with id " . $filter->getId() . PHP_EOL;
The filterDelete Method¶
Deletes a filter.
Method filterDelete definition¶
<?php
public function filterDelete($name) { }
Parameter | Data Type | Default value | Required | Description |
---|---|---|---|---|
$name | string | yes | Name of filter. |
filterDelete information¶
Return value | \ZendService\ZendServerAPI\DataTypes\Filter (Filter api doc) |
Online reference | filterDelete online reference |
Available in Version |
|
Example¶
<?php
use ZendService\ZendServerAPI\Filter;
$server = new Filter();
$filter = $server->filterDelete("foo");
echo $filter->getName() . " successfully removed" . PHP_EOL;