interface/modules/zend_modules/library/Zend/Server/Method/Prototype.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Server\Method;
  11
  12 /**
  13  * Method prototype metadata
  14  */
  15 class Prototype
  16 {
  17     /**
  18      * @var string Return type
  19      */
  20     protected $returnType = 'void';
  21
  22     /**
  23      * @var array Map parameter names to parameter index
  24      */
  25     protected $parameterNameMap = array();
  26
  27     /**
  28      * @var array Method parameters
  29      */
  30     protected $parameters = array();
  31
  32     /**
  33      * Constructor
  34      *
  35      * @param  null|array $options
  36      */
  37     public function __construct($options = null)
  38     {
  39         if ((null !== $options) && is_array($options)) {
  40             $this->setOptions($options);
  41         }
  42     }
  43
  44     /**
  45      * Set return value
  46      *
  47      * @param  string $returnType
  48      * @return \Zend\Server\Method\Prototype
  49      */
  50     public function setReturnType($returnType)
  51     {
  52         $this->returnType = $returnType;
  53         return $this;
  54     }
  55
  56     /**
  57      * Retrieve return type
  58      *
  59      * @return string
  60      */
  61     public function getReturnType()
  62     {
  63         return $this->returnType;
  64     }
  65
  66     /**
  67      * Add a parameter
  68      *
  69      * @param  string $parameter
  70      * @return \Zend\Server\Method\Prototype
  71      */
  72     public function addParameter($parameter)
  73     {
  74         if ($parameter instanceof Parameter) {
  75             $this->parameters[] = $parameter;
  76             if (null !== ($name = $parameter->getName())) {
  77                 $this->parameterNameMap[$name] = count($this->parameters) - 1;
  78             }
  79         } else {
  80             $parameter = new Parameter(array(
  81                 'type' => (string) $parameter,
  82             ));
  83             $this->parameters[] = $parameter;
  84         }
  85         return $this;
  86     }
  87
  88     /**
  89      * Add parameters
  90      *
  91      * @param  array $parameters
  92      * @return \Zend\Server\Method\Prototype
  93      */
  94     public function addParameters(array $parameters)
  95     {
  96         foreach ($parameters as $parameter) {
  97             $this->addParameter($parameter);
  98         }
  99         return $this;
 100     }
 101
 102     /**
 103      * Set parameters
 104      *
 105      * @param  array $parameters
 106      * @return \Zend\Server\Method\Prototype
 107      */
 108     public function setParameters(array $parameters)
 109     {
 110         $this->parameters       = array();
 111         $this->parameterNameMap = array();
 112         $this->addParameters($parameters);
 113         return $this;
 114     }
 115
 116     /**
 117      * Retrieve parameters as list of types
 118      *
 119      * @return array
 120      */
 121     public function getParameters()
 122     {
 123         $types = array();
 124         foreach ($this->parameters as $parameter) {
 125             $types[] = $parameter->getType();
 126         }
 127         return $types;
 128     }
 129
 130     /**
 131      * Get parameter objects
 132      *
 133      * @return array
 134      */
 135     public function getParameterObjects()
 136     {
 137         return $this->parameters;
 138     }
 139
 140     /**
 141      * Retrieve a single parameter by name or index
 142      *
 143      * @param  string|int $index
 144      * @return null|\Zend\Server\Method\Parameter
 145      */
 146     public function getParameter($index)
 147     {
 148         if (!is_string($index) && !is_numeric($index)) {
 149             return null;
 150         }
 151         if (array_key_exists($index, $this->parameterNameMap)) {
 152             $index = $this->parameterNameMap[$index];
 153         }
 154         if (array_key_exists($index, $this->parameters)) {
 155             return $this->parameters[$index];
 156         }
 157         return null;
 158     }
 159
 160     /**
 161      * Set object state from array
 162      *
 163      * @param  array $options
 164      * @return \Zend\Server\Method\Prototype
 165      */
 166     public function setOptions(array $options)
 167     {
 168         foreach ($options as $key => $value) {
 169             $method = 'set' . ucfirst($key);
 170             if (method_exists($this, $method)) {
 171                 $this->$method($value);
 172             }
 173         }
 174         return $this;
 175     }
 176
 177     /**
 178      * Serialize to array
 179      *
 180      * @return array
 181      */
 182     public function toArray()
 183     {
 184         return array(
 185             'returnType' => $this->getReturnType(),
 186             'parameters' => $this->getParameters(),
 187         );
 188     }
 189 }