Zend Framework by examples (ZfEx)

Processing a controller action

2010-05-19T17:49:00.009+02:00

In this example, we create a controller and a view script. The controller passes the URL parameters to the view script.

Components used in this example

MyActionController MyController MyHtml Entry point HTML | Try it | View source code

Using the action controller


class MyActionController
{
    const BASE_URL = 'http://domain/';

    public static $uri = array(
        'my/script/param1/one/param2/two',
        'my/script/param1/123',
        'my/script/param1/456',
    );

Processing the controller action

We get the URL.
We create the front controller.
We create the request.
We dispatch the action and we get the rendered data.
If we catch an exception, we return the error message.


    public function process()
    {
        // We get the URL.
        list($uri) = $this->_getParameters();

        try {
            // We create the front controller.
            $front = Zend_Controller_Front::getInstance();
            $front->setControllerDirectory('.')
                ->returnResponse(true);

            // We create the request.
            $request = new Zend_Controller_Request_Http(self::BASE_URL . $uri);

            // We dispatch the action and we get the rendered data.
            $result = $front->dispatch($request, new Zend_Controller_Response_Http)->getBody();

            } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = $e->getMessage();
        }

        return array($uri, $result);
    }

Extraction of the parameters from the GET request


    private function _getParameters()
    {
        $uri = isset($_GET['uri'])? $_GET['uri'] : self::$uri[0];

        return array($uri);
    }

Action controller


class MyController extends Zend_Controller_Action
{

Definition of the name and the location of the view script


    const DIR = './data/action-controller';
    const BASE_NAME = 'myscript-%s';
    const FILE_NAME = '%s/%s.phtml';

Creation of the content of the view script


    const CONTENT =
'
File: <?php echo basename(__FILE__); ?> <br >
Generated: <?php echo date(DATE_COOKIE); ?> <br >
Controller: <?php echo $this->controller; ?> <br >
Action: <?php echo $this->action; ?> <br >
Param1: <?php echo $this->param1; ?> <br >
Param2: <?php echo $this->param2; ?> <br >
';

    public $baseName;
    public $fileName;

Initialization of the controller

We set the path to the view script.
We set the default time zone to UTC.


    public function init()
    {
        // We set the path to the view script.
        $this->view->addScriptPath(self::DIR);
        // We set the default time zone to UTC.
        date_default_timezone_set('UTC');
    }

Pre-dispatch

We create a temporary unique name for the view script.
We create the view script.


    public function preDispatch()
    {
        // We create a temporary unique name for the view script.
        $this->baseName = sprintf(self::BASE_NAME, rand(1000, 9999));
        $this->fileName = sprintf(self::FILE_NAME, self::DIR, $this->baseName);
        // We create the view script.
        file_put_contents($this->fileName, self::CONTENT);
    }

Rendering of the view script

We pass the URL parameters to the view script.
We render the content of the view script.


    public function scriptAction()
    {
        // We pass the URL parameters to the view script.
        $this->view->fileName = $this->fileName;
        $this->view->controller = __CLASS__;
        $this->view->action = __FUNCTION__;
        $this->view->param1 = $this->_getParam('param1', 'null');
        $this->view->param2 = $this->_getParam('param2', 'null');

        // We render the content of the view script.
        $this->render($this->baseName, null, true);
    }

Post-dispatch

We remove the view script.


    public function postDispatch()
    {
        // We remove the view script.
        unlink($this->fileName);
    }

Displaying items


class MyHtml
{

Displaying the title of the page based on the file name.


    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying the selected option


    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Colorization of data

We export the data as valid PHP code.
We add the PHP tag, we colorize the code, we remove the PHP tag.
We display the data.


    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = str_replace("\'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace("'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace('"', 'ZFEX_DQUOTE', $mixed);
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('ZFEX_QUOTE', '&#039;', $mixed);
        $mixed = str_replace('ZFEX_DQUOTE', '&quot;', $mixed);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

Entry point

We process the controller action , and we get all the parameters, to display in the form.


// We process the controller action , and we get all the parameters, to display in the form.
$controller = new MyActionController();
list($uri, $result) = $controller->process();


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>URI</td>
          <td>
            <select name="uri">
              <?php foreach(MyActionController::$uri as $targetUri) :?>
                  <option value="<?php echo $targetUri;?>"
                          <?php MyHtml::printSelected($uri, $targetUri);?>>
                    <?php echo MyActionController::BASE_URL . $targetUri;?>
                  </option>
              <?php endforeach;?>
            </select>
          </td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>


      </table>

      <br />
      <span style="font-size:75%">Change ZF Version</span>
      <select style="font-size:75%" name="zf-version">
        <?php foreach(array_map('basename', glob("$zfDir/*", GLOB_ONLYDIR)) as $dir) :?>
              <option <?php MyHtml::printSelected($zfVersion, $dir);?>>
                <?php echo $dir;?>
              </option>
          <?php endforeach;?>
      </select>

    </form>

    <hr />
    RESULT
    <br /> <br />
    <?php echo $result;?>

  </body>
</html>

Routing of a controller action

2010-05-18T21:17:00.005+02:00

In this example, we create routes and we compare URLs against those routes.

Components used in this example

MyRouter MyHtml Entry point HTML | Try it | View source code

Using the router


class MyRouter
{
    const BASE_URL = 'http://domain/';

Description of the routes


    public static $routes = array(
        0 => array('default'),
        array(
            'author/USER-NAME [controller="profile", action="userinfo"]',
            'Zend_Controller_Router_Route',
            'author/:username',
            array(
                'controller' => 'profile',
                'action' => 'userinfo',
            )
        ),
        array(
            'archive/YYYY [controller="archive", action="show", YEAR=2006]',
            'Zend_Controller_Router_Route',
            'archive/:year',
            array(
                'year' => 2006,
                'controller' => 'archive',
                'action' => 'show',
            ),
            array('year' => '\d+')
        ),
        array(
            'case/NNN-DESCRIPTION.html [controller="case", action="view"]',
            'Zend_Controller_Router_Route_Regex',
            'case/(\d+)-(.+)\.html',
            array(
                'controller' => 'case',
                'action'     => 'view'
            ),
            array(
                1 => 'id',
                2 => 'description'
            )
        ),
    );

Definition of the URLs


    public static $uri = array(
        'default route' => array(
            '',
            'news',
            'blog/archive',
            'blog/archive/list',
            'blog/archive/list/sort/alpha/date/desc',
            'foo',
        ),
        'author route' => array(
            'author/martel',
            'author/john/param/unexpected',
        ),
        'archive route' => array(
            'archive',
            'archive/2008',
            'archive/bad',
        ),
        'case route' => array(
            'case/123-the-good-case.html',
            'case/xyz-the-bad-case.html',
        ),
    );

Processing the routing request

We get the route, the option to disable of the default routes, the option to ignore modules, the URL.
We create the front controller.
We ignore the modules if requested.
We instantiate the router.
We remove the default routes if requested.
We add the route.
We extract from the URL, the module, the controller, the action and the parameters.
If we catch an exception, we return the error message.


    public function process()
    {
        // We get the route, the option to disable of the default routes,
        // the option to ignore modules, the URL.
        list($route, $disableDefault, $disableModule, $uri) = $this->_getParameters();

        try {
            // We create the front controller.
            $front = Zend_Controller_Front::getInstance();

            if (!$disableModule) {
                // We ignore the modules if requested.
                $front->addControllerDirectory('dummy', 'blog');
                $front->addControllerDirectory('dummy', 'news');
            }

            // We instantiate the router.
            $router = $front->getRouter();
            // We remove the default routes if requested.
            $disableDefault and $route and $router->removeDefaultRoutes();

            // We add the route.
            @list(, $class, $pattern, $defaults, $reqs) = self::$routes[$route];
            $class and $router->addRoute('route',
                new $class($pattern, $defaults, $reqs));

            // We extract from the URL,  the module, the controller, the action and the parameters.
            $request = new Zend_Controller_Request_Http(self::BASE_URL . $uri);
            $params = $router->route($request)->getParams();
            $result = array_diff_key($params, $_GET);

            } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = $e->getMessage();
        }

        return array($route, $disableDefault, $disableModule, $uri, $result);
    }

Extraction of the parameters from the GET request


    private function _getParameters()
    {
        $route = (isset($_GET['route']) and isset(self::$routes[$_GET['route']]))?
            $_GET['route'] : 0;

        $disableDefault = empty($_GET)? 1 : !empty($_GET['disable-default']);
        $disableModule = empty($_GET)? 0 : !empty($_GET['disable-module']);

        $uri = isset($_GET['uri'])? $_GET['uri'] : '';

        return array($route, $disableDefault, $disableModule, $uri);
    }

Displaying items


class MyHtml
{

Displaying the title of the page based on the file name.


    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying a check mark


    public static function printChecked($value)
    {
        empty($value) or print 'checked="checked"';
    }

Displaying the selected option


    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Colorization of data

We export the data as valid PHP code.
We add the PHP tag, we colorize the code, we remove the PHP tag.
We display the data.


    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = str_replace("\'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace("'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace('"', 'ZFEX_DQUOTE', $mixed);
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('ZFEX_QUOTE', '&#039;', $mixed);
        $mixed = str_replace('ZFEX_DQUOTE', '&quot;', $mixed);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

Entry point

We process the routing request, and we get all the parameters, to display in the form.


// We process the routing request, and we get all the parameters, to display in the form.
$router = new MyRouter();
list($route, $disableDefault, $disableModule, $uri, $result) = $router->process();


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>Route</td>
          <td>
            <select name="route">
              <?php foreach(MyRouter::$routes as $routeId => $details) :?>
                  <option value="<?php echo $routeId;?>"
                          <?php MyHtml::printSelected($route, $routeId);?>>
                    <?php echo $details[0];?>
                  </option>
              <?php endforeach;?>
            </select>
          </td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="disable-default" value="1"
                   <?php MyHtml::printChecked($disableDefault);?> />
            Remove default routes
          </td>
          <td>Ignored if default route selected</td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="disable-module" value="1"
                   <?php MyHtml::printChecked($disableModule);?> />
            Ignore modules (aka controller directory)
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td>URI</td>
          <td>
            <select name="uri">
              <?php foreach(MyRouter::$uri as $routeName => $uris) :?>
              <optgroup label="<?php echo $routeName;?>">
                <?php foreach($uris as $targetUri) :?>
                    <option value="<?php echo $targetUri;?>"
                            <?php MyHtml::printSelected($uri, $targetUri);?>>
                      <?php echo MyRouter::BASE_URL . $targetUri;?>
                    </option>
                <?php endforeach;?>
              </optgroup>
              <?php endforeach;?>
            </select>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>


      </table>

      <br />
      <span style="font-size:75%">Change ZF Version</span>
      <select style="font-size:75%" name="zf-version">
        <?php foreach(array_map('basename', glob("$zfDir/*", GLOB_ONLYDIR)) as $dir) :?>
              <option <?php MyHtml::printSelected($zfVersion, $dir);?>>
                <?php echo $dir;?>
              </option>
          <?php endforeach;?>
      </select>

    </form>

    <hr />
    RESULT
    <?php MyHtml::colorize($result);?>

  </body>
</html>

Using the front controller

2010-05-18T10:46:00.008+02:00

In this example, we instantiate a front controller and we dispatch an action. We also create a default controller. We customize the response to trace the calls. We have a plugin to set the default value of a parameter.

Components used in this example

MyFrontController MyPlugin MyResponse DefaultController MyController MyHtml Entry point HTML | Try it | View source code

Using the front controller


class MyFrontController
{
    const BASE_URL = 'http://domain/subpath/';

    public static $uri = array(
        '',
        'my/',
        'my/get/',
        'my/get/param/123',
    );

Processing the front controller request

We get the URI.
We create the front controller.
We create the request.
We dispatch the action.
We extract the call trace from the response.
If we catch an exception, we return the error message.


    public function process()
    {
        // We get the URI.
        list($uri) = $this->_getParameters();

        try {
            // We create the front controller.
            $front = Zend_Controller_Front::getInstance();
            $front->setControllerDirectory('.')
                ->returnResponse(true)
                ->setParam('noViewRenderer', true)
                ->setDefaultControllerName('default')
                ->setDefaultAction('default')
                ->setBaseUrl('/subpath')
                ->registerPlugin(new MyPlugin);

            // We create the request.
            $request = new Zend_Controller_Request_Http(self::BASE_URL . $uri);

            // We dispatch the action.
            $response = $front->dispatch($request, new MyResponse);
            // We extract the call trace from the response.
            $result = $response->getTrace();


        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = $e->getMessage();
        }

        return array($uri, $result);
    }

Extraction of the parameters from the GET request


    private function _getParameters()
    {
        $uri = isset($_GET['uri'])? $_GET['uri'] : '';

        return array($uri);
    }

Plugin to set the default value of a parameter


class MyPlugin extends Zend_Controller_Plugin_Abstract
{
    public function preDispatch(Zend_Controller_Request_Abstract $request)
    {
        $this->getResponse()->traceCall();
        $request->getParam('param') === null and $request->setParam('param', 'null');
    }

Customization of the response


class MyResponse extends Zend_Controller_Response_Abstract
{
    public $trace;

Returning the call trace


    public function getTrace()
    {
        return $this->trace;
    }

Tracing a call


    public function traceCall()
    {
        $backtrace = debug_backtrace();
        $this->trace[] = "class={$backtrace[1]['class']}, method={$backtrace[1]['function']}";
    }

Capturing a parameter


    public function traceParam($param)
    {
        $this->trace[] = "param=$param";
    }

Default controller: no action is really performed except tracing calls


class DefaultController extends Zend_Controller_Action
{
    public function init()
    {
        $this->getResponse()->traceCall();
    }

    public function defaultAction()
    {
        $this->getResponse()->traceCall();
    }

Action controller


class MyController extends Zend_Controller_Action
{
    public function init()
    {
        $this->getResponse()->traceCall();
    }

    public function defaultAction()
    {
        $this->getResponse()->traceCall();
    }

Extracting the parameter value


    public function getAction()
    {
        $this->getResponse()->traceCall($param);

        $param = $this->_getParam('param');
        $this->getResponse()->traceParam($param);
    }

Displaying items


class MyHtml
{

Displaying the title of the page based on the file name.


    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying the selected option


    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Colorization of data

We export the data as valid PHP code.
We add the PHP tag, we colorize the code, we remove the PHP tag.
We display the data.


    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = str_replace("\'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace("'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace('"', 'ZFEX_DQUOTE', $mixed);
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('ZFEX_QUOTE', '&#039;', $mixed);
        $mixed = str_replace('ZFEX_DQUOTE', '&quot;', $mixed);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

Entry point

We process the front controller request, and we get all the parameters, to display in the form.


// We process the front controller request, and we get all the parameters, to display in the form.
$frontController = new MyFrontController();
list($uri, $result) = $frontController->process();


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>URI</td>
          <td>
            <select name="uri">
              <?php foreach(MyFrontController::$uri as $targetUri) :?>
                  <option value="<?php echo $targetUri;?>"
                          <?php MyHtml::printSelected($uri, $targetUri);?>>
                    <?php echo MyFrontController::BASE_URL . $targetUri;?>
                  </option>
              <?php endforeach;?>
            </select>
          </td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>
        

      </table>
      
      <br />
      <span style="font-size:75%">Change ZF Version</span>
      <select style="font-size:75%" name="zf-version">
        <?php foreach(array_map('basename', glob("$zfDir/*", GLOB_ONLYDIR)) as $dir) :?>
              <option <?php MyHtml::printSelected($zfVersion, $dir);?>>
                <?php echo $dir;?>
              </option>
          <?php endforeach;?>
      </select>

    </form>

    <hr />
    RESULT
    <?php MyHtml::colorize($result);?>

  </body>
</html>

Remote services using REST

2010-01-27T16:44:00.002+01:00

In this example, we implement a REST client and a REST server.

Components used in this example

MyRestClient MyRestServer MyScalarService MyArrayService MyHtml Entry point HTML | Try it | View source code

Implementation of the client


class MyRestClient
{

Processing the user request

We get the data and the action.
We parse the data to get a scalar or an array.
We set the server name. It is the same as the client plus one parameter to indicate it is the server.
We get the list of remote methods. We remove the system methods.
We process the request.
If there is a XML node named response, we get the response that is a scalar.
Otherwise we extract the array from the XML node.
We add the response details if needed.
If we catch an exception, we return the error message.


    public function process()
    {
        // We get the data and the action.
        list($data, $action, $response) = $this->_getParameters();

        $methods = array();
        
        try {
            // We parse the data to get a scalar or an array.
            $parsed = $this->_parseData($data);
            
            // We set the server name.
            // It is the same as the client plus one parameter to indicate it is the server.
            $server = "http://{$_SERVER['HTTP_HOST']}{$_SERVER['PHP_SELF']}?server=";
            $client = new Zend_Rest_Client($server);

            // We get the list of remote methods. We remove the system methods.
            $get = $client->getFunctions()->get();
            $methods = $this->_toArray($get->getFunctions);
            $methods = preg_grep('~^(array|scalar)_\w+$~', $methods);
            sort($methods);
            
            // We process the request.
            if ($action) {
                $get = $client->$action($parsed)->get();
                
                if ($get->getStatus()) {
                    if (isset($get->response)) {
                        // If there is a XML node named response, 
                        // we get the response that is a scalar. 
                        $result['GET'] = (string)$get;
                    } else {
                        // Otherwise we extract the array from the XML node.
                        $result['GET'] = $this->_toArray($get->$action);
                    }
                } else {
                    $result['ERROR'] = (string)$get;                        
                }

                // We add the response details if needed.
                $response and $result['RESPONSE'] = $get;
                
            } else {
                $result = 'Enter some data and select an action.';
            }                        
            
        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = '[' . __CLASS__ . '] ' . $e->getMessage();
        }

        return array($data, $action, $response, $methods, $result);
    }

Extraction of the parameters from the GET request


    private function _getParameters()
    {
        $data = isset($_GET['data'])? $_GET['data'] : '';
        $action = isset($_GET['action'])? $_GET['action'] : null;
        $response = empty($_GET)? 0 : !empty($_GET['response']);

        return array($data, $action, $response);
    }

Extraction of the data into a scalar or an array.


    private function _parseData($data)
    {        
        if (strpos($data, "\n") === false) {
            return $data;
            
        } else {
            foreach(explode("\n", $data) as $line) {
                $parts = explode('=', $line, 2);
                if (count($parts) == 1) {
                    $parsed[] = trim($parts[0]);
                } else {
                    $parsed[trim($parts[0])] = trim($parts[1]);
                }
            }
            return $parsed;
        }
    }

Extraction of the array from the XML node

We ignore the status that is returned as an array element.
We explore nodes recursively.
We replace the keys generated by ZF Server with the corresponding index.
Or we keep the key as it is.


    private function _toArray($simpleXml)
    {
        $array = array();
        
        foreach((array)$simpleXml as $key => $value) {
            // We ignore the status that is returned as an array element.
            if (!($key == 'status' and strtolower($value) == 'success')) {
                // We explore nodes recursively.
                $value instanceof SimpleXMLElement and $value = $this->_toArray($value);
            
                if (preg_match('~^key_(\d+)$~', $key, $match)) {
                    // We replace the keys generated by ZF Server with the corresponding index.
                    $array[$match[1]] = $value;
                } else {
                    // Or we keep the key as it is.
                    $array[$key] = $value;
                }
            } 
        }
        
        return $array;
    }

Implementation of the server


class MyRestServer
{    
    private static $functions;

Processing the client request

We instantiate the server.
We add the class methods. Note: this method should ideally be excluded from the list.
We save the list of service methods.
We process the client request.
If we catch an exception, we return the error message.


    public function process()
    {
        try {
            // We instantiate the server.
            $server = new Zend_Rest_Server();
            // We add the class methods. 
            // Note: this method should ideally be excluded from the list.
            $server->setClass(__CLASS__);
            $server->setClass('MyArrayService');
            $server->setClass('MyScalarService');
            
            // We save the list of service methods.
            self::$functions = array_keys($server->getFunctions());
            
            // We process the client request.
            $result = $server->handle();
            
        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = '[' . __CLASS__ . '] ' . $e->getMessage();
        }

        return $result;
    }

Return the list of methods to the client


    public static function getFunctions()
    {
        return self::$functions;
    }

Implementation of the scalar methods


class MyScalarService
{

Decodes data encoded with MIME base64


    public static function scalar_base64_decode($string)
    {
        return base64_decode($string);
    }

Encodes data with MIME base64


    public static function scalar_base64_encode($string)
    {
        return base64_encode($string);
    }

Format a local time and date


    public static function scalar_date($timestamp)
    {
        return date(DATE_ISO8601, $timestamp);
    }

Calculate the md5 hash of a string


    public static function scalar_md5($string)
    {
        return md5($string);
    }

Finds whether a variable is a number or a numeric string


    public static function scalar_is_numeric($string)
    {
        return is_numeric($string);
    }

Make a string lowercase


    public static function scalar_strtolower($string)
    {
        return strtolower($string);
    }

Make a string uppercase


    public static function scalar_strtoupper($string)
    {
        return strtoupper($string);
    }

Parse about any English textual datetime description into a Unix timestamp


    public static function scalar_strtotime($string)
    {
        return strtotime($string);
    }

Implementation of the array methods


class MyArrayService
{

Calculate the sum of values in an array


    public static function array_sum($array)
    {
        return array_sum($array);
    }

Sort an array and maintain index association


    public static function array_asort($array)
    {
        asort($array);
        return $array;
    }

Sort an array by key


    public static function array_ksort($array)
    {
        ksort($array);
        return $array;
    }

Sort an array


    public static function array_sort($array)
    {
        sort($array);
        return $array;
    }

Displaying items


class MyHtml
{

Displaying the title of the page based on the file name.


    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying the selected option


    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Displaying a check mark


    public static function printChecked($value)
    {
        empty($value) or print 'checked="checked"';
    }

Colorization of data

We export the data as valid PHP code.
We add the PHP tag, we colorize the code, we remove the PHP tag.
We display the data.


    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = str_replace("\'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace("'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace('"', 'ZFEX_DQUOTE', $mixed);
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('ZFEX_QUOTE', '&#039;', $mixed);
        $mixed = str_replace('ZFEX_DQUOTE', '&quot;', $mixed);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

Displaying a string or an array

If the data is an array, we convert the array into a set of lines.
We converts special characters into HTML entities.
We convert new-line characters into line breaks.


    public static function display($mixed, $isNl2Br = true, $isStripslashes = true)
    {
        // If the data is an array, we convert the array into a set of lines.
        is_array($mixed) and $mixed = implode("\n", $mixed);
        $isStripslashes and $mixed = stripslashes($mixed);
        // We converts special characters into HTML entities.
        $mixed = htmlspecialchars($mixed, ENT_QUOTES, 'UTF-8');
        // We convert new-line characters into line breaks.
        $isNl2Br and $mixed = nl2br($mixed);
        echo $mixed;
    }

Entry point

We set the default timezone that is used by the methods handling date and time.
We capture all notices or errors. Notices and errors will be thrown as exceptions.
We start the server to process the client request.
Or we run the client interface depending on the URL parameter.
Note: the code for the client and the server would most likely run in separate environments in a real application.


// We set the default timezone that is used by the methods handling date and time.
date_default_timezone_set('UTC');

// We capture all notices or errors. 
// Notices and errors will be thrown as exceptions.
$fct = create_function('$errno, $errstr', 'throw new Exception($errstr);');
set_error_handler($fct);

if (isset($_GET['server'])) {
    // We start the server to process the client request.
    $server = new MyRestServer();
    $server->process();
    exit;
} else {
    // Or we run the client interface depending on the URL parameter.
    $client = new MyRestClient();
    list($data, $action, $response, $methods, $result) = 
        $client->process();
    // Note: the code for the client and the server would most likely run 
    // in separate environments in a real application.
}


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
      .data {
          height: 8em;
          width: 20em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>Data</td>
          <td>
            <textarea name="data"
                      class="data"><?php MyHtml::display($data, false);?></textarea>
          </td>
          <td>
             Data is one of the following:
             <ul>
               <li>A scalar value (integer, double, string, base64).</li>
               <li>A date, I.e. 1 January 1970, or a timestamp, I.e. 0.</li>
               <li>A list of values (indexed array), one value per line.</li>
               <li>A list of key=value's (associative array or struct), INI format.</li>
             </ul>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td>Action</td>
          <td>
            <select name="action">
              <option></option>
              <?php foreach($methods as $name):?>
              <option <?php MyHtml::printSelected($action, $name);?>>
                <?php echo $name;?>
              </option>
              <?php endforeach;?>
            </select>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="response" value="1"
                   <?php MyHtml::printChecked($response);?> />
            Get response
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>

      </table>
    </form>

    <hr />
    RESULT
    <?php MyHtml::colorize($result);?>

  </body>
</html>

Remote services with XML-RPC

2010-01-26T20:24:00.006+01:00

In this example, we implement an XML-RPC client and an XML-RPC server. We also use namespaces, the XMLRPC data types, and the server proxy.

Components used in this example

MyXmlRpcClient MyXmlRpcServer MyScalarService MyArrayService MyHtml Entry point HTML | Try it | View source code

Implementation of the client

We define the XMLRPC types.


class MyXmlRpcClient
{
    // We define the XMLRPC types.
    public static $types = array(
         'AUTO_DETECT_TYPE',
         'XMLRPC_TYPE_APACHEI8',
         'XMLRPC_TYPE_APACHENIL',
         'XMLRPC_TYPE_ARRAY',
         'XMLRPC_TYPE_BASE64',
         'XMLRPC_TYPE_BOOLEAN',
         'XMLRPC_TYPE_DATETIME',
         'XMLRPC_TYPE_DOUBLE',
         'XMLRPC_TYPE_I4',
         'XMLRPC_TYPE_I8',
         'XMLRPC_TYPE_INTEGER',
         'XMLRPC_TYPE_NIL',
         'XMLRPC_TYPE_STRING',
         'XMLRPC_TYPE_STRUCT',
         // 'XML_STRING',
    );

Processing the user request

We get the data, the action, the data type, etc...
We parse the data to get a scalar or an array.
We convert the data to a given XMLRPC type if requested.
We set the server name. It is the same as the client plus one parameter to indicate it is the server.
We get the list of remote methods. We remove the system methods.
We process the request.
We use the proxy server if requested.
We add the response details and the request details if needed.
If we catch an exception, we return the error message.


    public function process()
    {
        // We get the data, the action, the data type, etc...
        list($data, $action, $type, $request, $response, $proxy) = $this->_getParameters();

        $methods = array();
        
        try {
            // We parse the data to get a scalar or an array.
            $parsed = $this->_parseData($data);
            // We convert the data to a given XMLRPC type if requested.
            $type and $parsed = Zend_XmlRpc_Value::getXmlRpcValue($parsed, 
                constant("Zend_XmlRpc_Value::$type"));
            
            // We set the server name.
            // It is the same as the client plus one parameter to indicate it is the server.
            $server = "http://{$_SERVER['HTTP_HOST']}{$_SERVER['PHP_SELF']}?server=";
            $client = new Zend_XmlRpc_Client($server);

            // We get the list of remote methods. We remove the system methods.
            $methods = $client->getIntrospector()->listMethods();
            $methods = preg_grep('~^system~', $methods, PREG_GREP_INVERT);
            sort($methods);
            
            // We process the request.
            switch($action) {
                case 'listMethods':
                case 'getSignatureForEachMethod':
                    $result = $client->getIntrospector()->$action();
                    break;
                    
                case '':
                    $result = 'Enter some data and select an action.';
                    break;
                    
                default:
                    // We use the proxy server if requested.
                    if ($proxy) {
                        list($service, $method) = explode('.', $action);
                        $server = $client->getProxy($service);
                        $result['PROXY'] = $server->$method($parsed);
                    } else {
                        $result['CALL'] = $client->call($action, array($parsed));
                    }
                    // We add the response details and the request details if needed.
                    $response and $result['RESPONSE'] = $client->getLastResponse();
                    $request and $result['REQUEST'] = $client->getLastRequest();
            }
                        
            
        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = '[' . __CLASS__ . '] ' . $e->getMessage();
        }

        return array($data, $action, $type, $request, $response, $proxy, $methods, $result);
    }

Extraction of the parameters from the GET request


    private function _getParameters()
    {
        $data = isset($_GET['data'])? $_GET['data'] : '';
        $action = isset($_GET['action'])? $_GET['action'] : null;
        $type = (isset($_GET['type']) and in_array($_GET['type'], self::$types))? 
            $_GET['type'] : null;
        $request = empty($_GET)? 0 : !empty($_GET['request']);
        $response = empty($_GET)? 0 : !empty($_GET['response']);
        $proxy = empty($_GET)? 0 : !empty($_GET['proxy']);

        return array($data, $action, $type, $request, $response, $proxy);
    }

Extraction of the data into a scalar or an array.


    private function _parseData($data)
    {        
        if (strpos($data, "\n") === false) {
            return $data;
            
        } else {
            foreach(explode("\n", $data) as $line) {
                $parts = explode('=', $line, 2);
                if (count($parts) == 1) {
                    $parsed[] = trim($parts[0]);
                } else {
                    $parsed[trim($parts[0])] = trim($parts[1]);
                }
            }
            return $parsed;
        }
    }

Implementation of the server


class MyXmlRpcServer
{

Processing the client request

We allow exceptions to be reported as fault responses.
We instantiate the server.
We add the class methods. We have one namespace for scalar methods and one namespace for array methods.
We process the client request.
If we catch an exception, we return the error message.


    public function process()
    {
        try {
            // We allow exceptions to be reported as fault responses.
            Zend_XmlRpc_Server_Fault::attachFaultException('Exception');

            // We instantiate the server.
            $server = new Zend_XmlRpc_Server();
            // We add the class methods. 
            // We have one namespace for scalar methods and one namespace for array methods.
            $server->setClass('MyArrayService', 'array');
            $server->setClass('MyScalarService', 'scalar');
            // We process the client request.
            $result = $server->handle();
            
        } catch (Exception $e) {
            // If we catch an exception, we return the error message.
            $result = '[' . __CLASS__ . '] ' . $e->getMessage();
        }

        return $result;
    }

Implementation of the scalar methods


class MyScalarService
{

Decodes data encoded with MIME base64


    public static function base64_decode($string)
    {
        return base64_decode($string);
    }

Encodes data with MIME base64


    public static function base64_encode($string)
    {
        return base64_encode($string);
    }

Format a local time and date


    public static function date($timestamp)
    {
        return date(DATE_ISO8601, $timestamp);
    }

Calculate the md5 hash of a string


    public static function md5($string)
    {
        return md5($string);
    }

Finds whether a variable is a number or a numeric string


    public static function is_numeric($string)
    {
        return is_numeric($string);
    }

Make a string lowercase


    public static function strtolower($string)
    {
        return strtolower($string);
    }

Make a string uppercase


    public static function strtoupper($string)
    {
        return strtoupper($string);
    }

Parse about any English textual datetime description into a Unix timestamp


    public static function strtotime($string)
    {
        return strtotime($string);
    }

Implementation of the array methods


class MyArrayService
{

Calculate the sum of values in an array


    public static function array_sum($array)
    {
        return array_sum($array);
    }

Sort an array and maintain index association


    public static function asort($array)
    {
        asort($array);
        return $array;
    }

Sort an array by key


    public static function ksort($array)
    {
        ksort($array);
        return $array;
    }

Sort an array


    public static function sort($array)
    {
        sort($array);
        return $array;
    }

Displaying items


class MyHtml
{

Displaying the title of the page based on the file name.


    public static function printTitle()
    {
        $basename = basename(__FILE__, '.php');
        $title = ucwords(str_replace('-' , ' ', $basename));
        $zfVersion = Zend_Version::VERSION;
        $phpVersion = phpversion();
        echo "ZfEx $title (ZF/$zfVersion PHP/$phpVersion)";
    }

Displaying the selected option


    public static function printSelected($value, $target)
    {
        $value == $target and print 'selected="selected"';
    }

Displaying a check mark


    public static function printChecked($value)
    {
        empty($value) or print 'checked="checked"';
    }

Colorization of data

We export the data as valid PHP code.
We add the PHP tag, we colorize the code, we remove the PHP tag.
We display the data.


    public static function colorize($mixed)
    {
        // We export the data as valid PHP code.
        $mixed = is_object($mixed)? print_r($mixed, true) : var_export($mixed, true);
        // We add the PHP tag, we colorize the code, we remove the PHP tag.
        $mixed = '<?' . "php $mixed";
        $mixed = str_replace("\'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace("'", 'ZFEX_QUOTE', $mixed);
        $mixed = str_replace('"', 'ZFEX_DQUOTE', $mixed);
        $mixed = highlight_string($mixed, true);
        $mixed = str_replace('ZFEX_QUOTE', '&#039;', $mixed);
        $mixed = str_replace('ZFEX_DQUOTE', '&quot;', $mixed);
        $mixed = str_replace('&lt;?php&nbsp;', '', $mixed);
        // We display the data.
        echo "<pre>$mixed</pre>";
    }

Displaying a string or an array

If the data is an array, we convert the array into a set of lines.
We converts special characters into HTML entities.
We convert new-line characters into line breaks.


    public static function display($mixed, $isNl2Br = true, $isStripslashes = true)
    {
        // If the data is an array, we convert the array into a set of lines.
        is_array($mixed) and $mixed = implode("\n", $mixed);
        $isStripslashes and $mixed = stripslashes($mixed);
        // We converts special characters into HTML entities.
        $mixed = htmlspecialchars($mixed, ENT_QUOTES, 'UTF-8');
        // We convert new-line characters into line breaks.
        $isNl2Br and $mixed = nl2br($mixed);
        echo $mixed;
    }

Entry point

We set the default timezone that is used by the methods handling date and time.
We capture all notices or errors. Notices and errors will be thrown as exceptions.
We start the server to process the client request.
Or we run the client interface depending on the URL parameter.
Note: the code for the client and the server would most likely run in separate environments in a real application.


// We set the default timezone that is used by the methods handling date and time.
date_default_timezone_set('UTC');

// We capture all notices or errors. 
// Notices and errors will be thrown as exceptions.
$fct = create_function('$errno, $errstr', 'throw new Exception($errstr);');
set_error_handler($fct);

if (isset($_GET['server'])) {
    // We start the server to process the client request.
    $server = new MyXmlRpcServer();
    echo $server->process();
    exit;
} else {
    // Or we run the client interface depending on the URL parameter.
    $client = new MyXmlRpcClient();
    list($data, $action, $type, $request, $response, $proxy, $methods, $result) = 
        $client->process();
    // Note: the code for the client and the server would most likely run 
    // in separate environments in a real application.
}


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title><?php MyHtml::printTitle();?></title>
    <style type="text/css">
      body, td {
          font-family: arial, sans-serif;
          font-size: 0.9em;
      }
      .data {
          height: 8em;
          width: 20em;
      }
    </style>
  </head>

  <body>

    <p>EXAMPLE <?php MyHtml::printTitle();?></p>
    <hr />

    <form name="form">

      <table>

        <tr>
          <td>Data</td>
          <td>
            <textarea name="data"
                      class="data"><?php MyHtml::display($data, false);?></textarea>
          </td>
          <td>
             Data is one of the following:
             <ul>
               <li>A scalar value (integer, double, string, base64).</li>
               <li>A date, I.e. 1 January 1970, or a timestamp, I.e. 0.</li>
               <li>A list of values (indexed array), one value per line.</li>
               <li>A list of key=value's (associative array or struct), INI format.</li>
             </ul>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td>Action</td>
          <td>
            <select name="action">
              <option></option>
              <optgroup label="Service methods">
                <?php foreach($methods as $name):?>
                <option <?php MyHtml::printSelected($action, $name);?>>
                  <?php echo $name;?>
                </option>
                <?php endforeach;?>
              </optgroup>
              
              <optgroup label="Server introspection">
                <option <?php MyHtml::printSelected($action, 'listMethods');?>>
                  listMethods</option>
                <option <?php MyHtml::printSelected($action, 'getSignatureForEachMethod');?>>
                  getSignatureForEachMethod</option>
              </optgroup>
            </select>
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td>Type</td>
          <td>
            <select name="type">
              <option value="">Native PHP type</option>
              <optgroup label=" XMLRPC_TYPE*">
                <?php foreach(MyXmlRpcClient::$types as $name):?>
                <option <?php MyHtml::printSelected($type, $name);?>>
                  <?php echo $name;?>
                </option>
                <?php endforeach;?>
              </optgroup>
            </select>
          </td>
          <td>The XMLRPC type will be applied to the data before the call if selected.
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="response" value="1"
                   <?php MyHtml::printChecked($response);?> />
            Get last response
          </td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="request" value="1"
                   <?php MyHtml::printChecked($request);?> />
            Get last request
          </td>
        </tr>

        <tr>
          <td></td>
          <td>
            <input type="checkbox" name="proxy" value="1"
                   <?php MyHtml::printChecked($proxy);?> />
            Use proxy
          </td>
        </tr>

        <tr><td>&nbsp;</td></tr>

        <tr>
          <td></td>
          <td>
            <input type="submit" value="Submit" />
          </td>
        </tr>

      </table>
    </form>

    <hr />
    RESULT
    <?php MyHtml::colorize($result);?>

  </body>
</html>