Skip to content

zend-patterns/ZendServerWebApiModule

Folders and files

NameName
Last commit message
Last commit date
Nov 23, 2021
Mar 26, 2025
Jun 24, 2013
Jun 27, 2013
May 11, 2020
Jan 28, 2014
Apr 21, 2020
Sep 20, 2013
Sep 20, 2013

Repository files navigation

ZendServerWebApi

ZF2 module that ease Zend Server API usage

Zend Framework 2 API

To use a Zend Server API, call the APIManager form the service locator :

$apiManager = $serviceLocator->get('zend_server_api');

And then send the request and retrieve the response like this :

$apiResponse = $apiManager->apiMethodName();

Where ApiMethodName is the API method : getNotifications, cacheClear, etc.... see Zend Server Web API documentation. $apiResponse will be ApiResponse instance and can be used a SimpleXMLElement to get XML Data. By exemple the clusterGetServerStatus method will return a response in which you can acces data like that :

$nodeCount = $apiResponse->responseData->serverList->count(); //To know the number a nodes in the cluster
$serverStatus = $apiResponse->responseData->serverList->serverInfo[0]->status // To know the status of the first node

API Request parameters POST or GET can be passed to the ApiManger by using an array :

$response = $apiManager->auditGetList(array(
        'limit' => 5,
        'order' => 'creation_time',
        'direction' => 'DESC'
    ));

Setting

You can set a default configuration of your environment in the zendserverwebapi.conf.php file under the 'zsapi' key:

'zsapi' => array (
    //Configuratin of the HTTP client that will connect to the Zend Server
    'client' => array (
        'adapter' => 'Zend\Http\Client\Adapter\Curl',
    ),
    // Target - the Zend Server you want to reach through API
    'target' => new ArrayObject(array (
        'zsurl' => 'http://localhost:10081', //
        'zskey' => '<SECRET-NAME>',
        'zssecret' => '<SECRET-HASH>',
        'zsversion' => '6.1',
)),