vendor/zendframework/zend-server/src/Method/Parameter.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 /**
  11  * Method parameter metadata
  12  */
  13 class Parameter
  14 {
  15     /**
  16      * Default parameter value
  17      *
  18      * @var mixed
  19      */
  20     protected $defaultValue;
  21
  22     /**
  23      * Parameter description
  24      *
  25      * @var string
  26      */
  27     protected $description = '';
  28
  29     /**
  30      * Parameter variable name
  31      *
  32      * @var string
  33      */
  34     protected $name;
  35
  36     /**
  37      * Is parameter optional?
  38      *
  39      * @var bool
  40      */
  41     protected $optional = false;
  42
  43     /**
  44      * Parameter type
  45      *
  46      * @var string
  47      */
  48     protected $type = 'mixed';
  49
  50     /**
  51      * Constructor
  52      *
  53      * @param  null|array $options
  54      */
  55     public function __construct($options = null)
  56     {
  57         if (is_array($options)) {
  58             $this->setOptions($options);
  59         }
  60     }
  61
  62     /**
  63      * Set object state from array of options
  64      *
  65      * @param  array $options
  66      * @return \Zend\Server\Method\Parameter
  67      */
  68     public function setOptions(array $options)
  69     {
  70         foreach ($options as $key => $value) {
  71             $method = 'set' . ucfirst($key);
  72             if (method_exists($this, $method)) {
  73                 $this->$method($value);
  74             }
  75         }
  76         return $this;
  77     }
  78
  79     /**
  80      * Set default value
  81      *
  82      * @param  mixed $defaultValue
  83      * @return \Zend\Server\Method\Parameter
  84      */
  85     public function setDefaultValue($defaultValue)
  86     {
  87         $this->defaultValue = $defaultValue;
  88         return $this;
  89     }
  90
  91     /**
  92      * Retrieve default value
  93      *
  94      * @return mixed
  95      */
  96     public function getDefaultValue()
  97     {
  98         return $this->defaultValue;
  99     }
 100
 101     /**
 102      * Set description
 103      *
 104      * @param  string $description
 105      * @return \Zend\Server\Method\Parameter
 106      */
 107     public function setDescription($description)
 108     {
 109         $this->description = (string) $description;
 110         return $this;
 111     }
 112
 113     /**
 114      * Retrieve description
 115      *
 116      * @return string
 117      */
 118     public function getDescription()
 119     {
 120         return $this->description;
 121     }
 122
 123     /**
 124      * Set name
 125      *
 126      * @param  string $name
 127      * @return \Zend\Server\Method\Parameter
 128      */
 129     public function setName($name)
 130     {
 131         $this->name = (string) $name;
 132         return $this;
 133     }
 134
 135     /**
 136      * Retrieve name
 137      *
 138      * @return string
 139      */
 140     public function getName()
 141     {
 142         return $this->name;
 143     }
 144
 145     /**
 146      * Set optional flag
 147      *
 148      * @param  bool $flag
 149      * @return \Zend\Server\Method\Parameter
 150      */
 151     public function setOptional($flag)
 152     {
 153         $this->optional = (bool) $flag;
 154         return $this;
 155     }
 156
 157     /**
 158      * Is the parameter optional?
 159      *
 160      * @return bool
 161      */
 162     public function isOptional()
 163     {
 164         return $this->optional;
 165     }
 166
 167     /**
 168      * Set parameter type
 169      *
 170      * @param  string $type
 171      * @return \Zend\Server\Method\Parameter
 172      */
 173     public function setType($type)
 174     {
 175         $this->type = (string) $type;
 176         return $this;
 177     }
 178
 179     /**
 180      * Retrieve parameter type
 181      *
 182      * @return string
 183      */
 184     public function getType()
 185     {
 186         return $this->type;
 187     }
 188
 189     /**
 190      * Cast to array
 191      *
 192      * @return array
 193      */
 194     public function toArray()
 195     {
 196         return [
 197             'type'         => $this->getType(),
 198             'name'         => $this->getName(),
 199             'optional'     => $this->isOptional(),
 200             'defaultValue' => $this->getDefaultValue(),
 201             'description'  => $this->getDescription(),
 202         ];
 203     }
 204 }