Source of file Parameter.php
Size: 3,915 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Server/Method/Parameter.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Server\Method; /** * Method parameter metadata */ class Parameter { /** * Default parameter value * * @var mixed */ protected $defaultValue; /** * Parameter description * * @var string */ protected $description = ''; /** * Parameter variable name * * @var string */ protected $name; /** * Is parameter optional? * * @var bool */ protected $optional = false; /** * Parameter type * * @var string */ protected $type = 'mixed'; /** * Constructor * * @param null|array $options */ public function __construct($options = null) { if (is_array($options)) { $this->setOptions($options); } } /** * Set object state from array of options * * @param array $options * @return \Zend\Server\Method\Parameter */ public function setOptions(array $options) { foreach ($options as $key => $value) { $method = 'set' . ucfirst($key); if (method_exists($this, $method)) { $this->$method($value); } } return $this; } /** * Set default value * * @param mixed $defaultValue * @return \Zend\Server\Method\Parameter */ public function setDefaultValue($defaultValue) { $this->defaultValue = $defaultValue; return $this; } /** * Retrieve default value * * @return mixed */ public function getDefaultValue() { return $this->defaultValue; } /** * Set description * * @param string $description * @return \Zend\Server\Method\Parameter */ public function setDescription($description) { $this->description = (string) $description; return $this; } /** * Retrieve description * * @return string */ public function getDescription() { return $this->description; } /** * Set name * * @param string $name * @return \Zend\Server\Method\Parameter */ public function setName($name) { $this->name = (string) $name; return $this; } /** * Retrieve name * * @return string */ public function getName() { return $this->name; } /** * Set optional flag * * @param bool $flag * @return \Zend\Server\Method\Parameter */ public function setOptional($flag) { $this->optional = (bool) $flag; return $this; } /** * Is the parameter optional? * * @return bool */ public function isOptional() { return $this->optional; } /** * Set parameter type * * @param string $type * @return \Zend\Server\Method\Parameter */ public function setType($type) { $this->type = (string) $type; return $this; } /** * Retrieve parameter type * * @return string */ public function getType() { return $this->type; } /** * Cast to array * * @return array */ public function toArray() { return array( 'type' => $this->getType(), 'name' => $this->getName(), 'optional' => $this->isOptional(), 'defaultValue' => $this->getDefaultValue(), 'description' => $this->getDescription(), ); } } |