interface/modules/zend_modules/library/Zend/Server/Method/Definition.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 use Zend\Server;
  13
  14 /**
  15  * Method definition metadata
  16  */
  17 class Definition
  18 {
  19     /**
  20      * @var \Zend\Server\Method\Callback
  21      */
  22     protected $callback;
  23
  24     /**
  25      * @var array
  26      */
  27     protected $invokeArguments = array();
  28
  29     /**
  30      * @var string
  31      */
  32     protected $methodHelp = '';
  33
  34     /**
  35      * @var string
  36      */
  37     protected $name;
  38
  39     /**
  40      * @var null|object
  41      */
  42     protected $object;
  43
  44     /**
  45      * @var array Array of \Zend\Server\Method\Prototype objects
  46      */
  47     protected $prototypes = array();
  48
  49     /**
  50      * Constructor
  51      *
  52      * @param  null|array $options
  53      */
  54     public function __construct($options = null)
  55     {
  56         if ((null !== $options) && is_array($options)) {
  57             $this->setOptions($options);
  58         }
  59     }
  60
  61     /**
  62      * Set object state from options
  63      *
  64      * @param  array $options
  65      * @return \Zend\Server\Method\Definition
  66      */
  67     public function setOptions(array $options)
  68     {
  69         foreach ($options as $key => $value) {
  70             $method = 'set' . ucfirst($key);
  71             if (method_exists($this, $method)) {
  72                 $this->$method($value);
  73             }
  74         }
  75         return $this;
  76     }
  77
  78     /**
  79      * Set method name
  80      *
  81      * @param  string $name
  82      * @return \Zend\Server\Method\Definition
  83      */
  84     public function setName($name)
  85     {
  86         $this->name = (string) $name;
  87         return $this;
  88     }
  89
  90     /**
  91      * Get method name
  92      *
  93      * @return string
  94      */
  95     public function getName()
  96     {
  97         return $this->name;
  98     }
  99
 100     /**
 101      * Set method callback
 102      *
 103      * @param  array|\Zend\Server\Method\Callback $callback
 104      * @throws Server\Exception\InvalidArgumentException
 105      * @return \Zend\Server\Method\Definition
 106      */
 107     public function setCallback($callback)
 108     {
 109         if (is_array($callback)) {
 110             $callback = new Callback($callback);
 111         } elseif (!$callback instanceof Callback) {
 112             throw new Server\Exception\InvalidArgumentException('Invalid method callback provided');
 113         }
 114         $this->callback = $callback;
 115         return $this;
 116     }
 117
 118     /**
 119      * Get method callback
 120      *
 121      * @return \Zend\Server\Method\Callback
 122      */
 123     public function getCallback()
 124     {
 125         return $this->callback;
 126     }
 127
 128     /**
 129      * Add prototype to method definition
 130      *
 131      * @param  array|\Zend\Server\Method\Prototype $prototype
 132      * @throws Server\Exception\InvalidArgumentException
 133      * @return \Zend\Server\Method\Definition
 134      */
 135     public function addPrototype($prototype)
 136     {
 137         if (is_array($prototype)) {
 138             $prototype = new Prototype($prototype);
 139         } elseif (!$prototype instanceof Prototype) {
 140             throw new Server\Exception\InvalidArgumentException('Invalid method prototype provided');
 141         }
 142         $this->prototypes[] = $prototype;
 143         return $this;
 144     }
 145
 146     /**
 147      * Add multiple prototypes at once
 148      *
 149      * @param  array $prototypes Array of \Zend\Server\Method\Prototype objects or arrays
 150      * @return \Zend\Server\Method\Definition
 151      */
 152     public function addPrototypes(array $prototypes)
 153     {
 154         foreach ($prototypes as $prototype) {
 155             $this->addPrototype($prototype);
 156         }
 157         return $this;
 158     }
 159
 160     /**
 161      * Set all prototypes at once (overwrites)
 162      *
 163      * @param  array $prototypes Array of \Zend\Server\Method\Prototype objects or arrays
 164      * @return \Zend\Server\Method\Definition
 165      */
 166     public function setPrototypes(array $prototypes)
 167     {
 168         $this->prototypes = array();
 169         $this->addPrototypes($prototypes);
 170         return $this;
 171     }
 172
 173     /**
 174      * Get all prototypes
 175      *
 176      * @return array $prototypes Array of \Zend\Server\Method\Prototype objects or arrays
 177      */
 178     public function getPrototypes()
 179     {
 180         return $this->prototypes;
 181     }
 182
 183     /**
 184      * Set method help
 185      *
 186      * @param  string $methodHelp
 187      * @return \Zend\Server\Method\Definition
 188      */
 189     public function setMethodHelp($methodHelp)
 190     {
 191         $this->methodHelp = (string) $methodHelp;
 192         return $this;
 193     }
 194
 195     /**
 196      * Get method help
 197      *
 198      * @return string
 199      */
 200     public function getMethodHelp()
 201     {
 202         return $this->methodHelp;
 203     }
 204
 205     /**
 206      * Set object to use with method calls
 207      *
 208      * @param  object $object
 209      * @throws Server\Exception\InvalidArgumentException
 210      * @return \Zend\Server\Method\Definition
 211      */
 212     public function setObject($object)
 213     {
 214         if (!is_object($object) && (null !== $object)) {
 215             throw new Server\Exception\InvalidArgumentException('Invalid object passed to ' . __CLASS__ . '::' . __METHOD__);
 216         }
 217         $this->object = $object;
 218         return $this;
 219     }
 220
 221     /**
 222      * Get object to use with method calls
 223      *
 224      * @return null|object
 225      */
 226     public function getObject()
 227     {
 228         return $this->object;
 229     }
 230
 231     /**
 232      * Set invoke arguments
 233      *
 234      * @param  array $invokeArguments
 235      * @return \Zend\Server\Method\Definition
 236      */
 237     public function setInvokeArguments(array $invokeArguments)
 238     {
 239         $this->invokeArguments = $invokeArguments;
 240         return $this;
 241     }
 242
 243     /**
 244      * Retrieve invoke arguments
 245      *
 246      * @return array
 247      */
 248     public function getInvokeArguments()
 249     {
 250         return $this->invokeArguments;
 251     }
 252
 253     /**
 254      * Serialize to array
 255      *
 256      * @return array
 257      */
 258     public function toArray()
 259     {
 260         $prototypes = $this->getPrototypes();
 261         $signatures = array();
 262         foreach ($prototypes as $prototype) {
 263             $signatures[] = $prototype->toArray();
 264         }
 265
 266         return array(
 267             'name'            => $this->getName(),
 268             'callback'        => $this->getCallback()->toArray(),
 269             'prototypes'      => $signatures,
 270             'methodHelp'      => $this->getMethodHelp(),
 271             'invokeArguments' => $this->getInvokeArguments(),
 272             'object'          => $this->getObject(),
 273         );
 274     }
 275 }