vendor/zendframework/zend-server/src/Reflection/ReflectionParameter.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\Reflection;
   9
  10 /**
  11  * Parameter Reflection
  12  *
  13  * Decorates a ReflectionParameter to allow setting the parameter type
  14  */
  15 class ReflectionParameter
  16 {
  17     /**
  18      * @var \ReflectionParameter
  19      */
  20     protected $reflection;
  21
  22     /**
  23      * Parameter position
  24      * @var int
  25      */
  26     protected $position;
  27
  28     /**
  29      * Parameter type
  30      * @var string
  31      */
  32     protected $type;
  33
  34     /**
  35      * Parameter description
  36      * @var string
  37      */
  38     protected $description;
  39
  40     /**
  41      * Constructor
  42      *
  43      * @param \ReflectionParameter $r
  44      * @param string $type Parameter type
  45      * @param string $description Parameter description
  46      */
  47     public function __construct(\ReflectionParameter $r, $type = 'mixed', $description = '')
  48     {
  49         $this->reflection = $r;
  50         $this->setType($type);
  51         $this->setDescription($description);
  52     }
  53
  54     /**
  55      * Proxy reflection calls
  56      *
  57      * @param string $method
  58      * @param array $args
  59      * @throws Exception\BadMethodCallException
  60      * @return mixed
  61      */
  62     public function __call($method, $args)
  63     {
  64         if (method_exists($this->reflection, $method)) {
  65             return call_user_func_array([$this->reflection, $method], $args);
  66         }
  67
  68         throw new Exception\BadMethodCallException('Invalid reflection method');
  69     }
  70
  71     /**
  72      * Retrieve parameter type
  73      *
  74      * @return string
  75      */
  76     public function getType()
  77     {
  78         return $this->type;
  79     }
  80
  81     /**
  82      * Set parameter type
  83      *
  84      * @param string|null $type
  85      * @throws Exception\InvalidArgumentException
  86      * @return void
  87      */
  88     public function setType($type)
  89     {
  90         if (! is_string($type) && (null !== $type)) {
  91             throw new Exception\InvalidArgumentException('Invalid parameter type');
  92         }
  93
  94         $this->type = $type;
  95     }
  96
  97     /**
  98      * Retrieve parameter description
  99      *
 100      * @return string
 101      */
 102     public function getDescription()
 103     {
 104         return $this->description;
 105     }
 106
 107     /**
 108      * Set parameter description
 109      *
 110      * @param string|null $description
 111      * @throws Exception\InvalidArgumentException
 112      * @return void
 113      */
 114     public function setDescription($description)
 115     {
 116         if (! is_string($description) && (null !== $description)) {
 117             throw new Exception\InvalidArgumentException('Invalid parameter description');
 118         }
 119
 120         $this->description = $description;
 121     }
 122
 123     /**
 124      * Set parameter position
 125      *
 126      * @param int $index
 127      * @return void
 128      */
 129     public function setPosition($index)
 130     {
 131         $this->position = (int) $index;
 132     }
 133
 134     /**
 135      * Return parameter position
 136      *
 137      * @return int
 138      */
 139     public function getPosition()
 140     {
 141         return $this->position;
 142     }
 143 }