vendor/zendframework/zend-server/src/Method/Callback.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-server for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-server/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Server\Method;
   9
  10 use Zend\Server;
  11
  12 /**
  13  * Method callback metadata
  14  */
  15 class Callback
  16 {
  17     /**
  18      * @var string Class name for class method callback
  19      */
  20     protected $class;
  21
  22     /**
  23      * @var string|callable Function name or callable for function callback
  24      */
  25     protected $function;
  26
  27     /**
  28      * @var string Method name for class method callback
  29      */
  30     protected $method;
  31
  32     /**
  33      * @var string Callback type
  34      */
  35     protected $type;
  36
  37     /**
  38      * @var array Valid callback types
  39      */
  40     protected $types = ['function', 'static', 'instance'];
  41
  42     /**
  43      * Constructor
  44      *
  45      * @param  null|array $options
  46      */
  47     public function __construct($options = null)
  48     {
  49         if ((null !== $options) && is_array($options)) {
  50             $this->setOptions($options);
  51         }
  52     }
  53
  54     /**
  55      * Set object state from array of options
  56      *
  57      * @param  array $options
  58      * @return \Zend\Server\Method\Callback
  59      */
  60     public function setOptions(array $options)
  61     {
  62         foreach ($options as $key => $value) {
  63             $method = 'set' . ucfirst($key);
  64             if (method_exists($this, $method)) {
  65                 $this->$method($value);
  66             }
  67         }
  68         return $this;
  69     }
  70
  71     /**
  72      * Set callback class
  73      *
  74      * @param  string $class
  75      * @return \Zend\Server\Method\Callback
  76      */
  77     public function setClass($class)
  78     {
  79         if (is_object($class)) {
  80             $class = get_class($class);
  81         }
  82         $this->class = $class;
  83         return $this;
  84     }
  85
  86     /**
  87      * Get callback class
  88      *
  89      * @return string|null
  90      */
  91     public function getClass()
  92     {
  93         return $this->class;
  94     }
  95
  96     /**
  97      * Set callback function
  98      *
  99      * @param  string|callable $function
 100      * @return \Zend\Server\Method\Callback
 101      */
 102     public function setFunction($function)
 103     {
 104         $this->function = is_callable($function) ? $function : (string) $function;
 105         $this->setType('function');
 106         return $this;
 107     }
 108
 109     /**
 110      * Get callback function
 111      *
 112      * @return null|string|callable
 113      */
 114     public function getFunction()
 115     {
 116         return $this->function;
 117     }
 118
 119     /**
 120      * Set callback class method
 121      *
 122      * @param  string $method
 123      * @return \Zend\Server\Method\Callback
 124      */
 125     public function setMethod($method)
 126     {
 127         $this->method = $method;
 128         return $this;
 129     }
 130
 131     /**
 132      * Get callback class  method
 133      *
 134      * @return null|string
 135      */
 136     public function getMethod()
 137     {
 138         return $this->method;
 139     }
 140
 141     /**
 142      * Set callback type
 143      *
 144      * @param  string $type
 145      * @return \Zend\Server\Method\Callback
 146      * @throws Server\Exception\InvalidArgumentException
 147      */
 148     public function setType($type)
 149     {
 150         if (! in_array($type, $this->types)) {
 151             throw new Server\Exception\InvalidArgumentException(sprintf(
 152                 'Invalid method callback type "%s" passed to %s',
 153                 $type,
 154                 __METHOD__
 155             ));
 156         }
 157         $this->type = $type;
 158         return $this;
 159     }
 160
 161     /**
 162      * Get callback type
 163      *
 164      * @return string
 165      */
 166     public function getType()
 167     {
 168         return $this->type;
 169     }
 170
 171     /**
 172      * Cast callback to array
 173      *
 174      * @return array
 175      */
 176     public function toArray()
 177     {
 178         $type = $this->getType();
 179         $array = [
 180             'type' => $type,
 181         ];
 182         if ('function' == $type) {
 183             $array['function'] = $this->getFunction();
 184         } else {
 185             $array['class']  = $this->getClass();
 186             $array['method'] = $this->getMethod();
 187         }
 188         return $array;
 189     }
 190 }