Parameter.php

Go to the documentation of this file.

<?php
class Zend_Server_Method_Parameter
{
    protected $_defaultValue;

    protected $_description = '';

    protected $_name;

    protected $_optional = false;

    protected $_type = 'mixed';

    public function __construct($options = null)
    {
        if (is_array($options)) {
            $this->setOptions($options);
        }
    }

    public function setOptions(array $options)
    {
        foreach ($options as $key => $value) {
            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }
        return $this;
    }

    public function setDefaultValue($defaultValue)
    {
        $this->_defaultValue = $defaultValue;
        return $this;
    }

    public function getDefaultValue()
    {
        return $this->_defaultValue;
    }

    public function setDescription($description)
    {
        $this->_description = (string) $description;
        return $this;
    }

    public function getDescription()
    {
        return $this->_description;
    }

    public function setName($name)
    {
        $this->_name = (string) $name;
        return $this;
    }

    public function getName()
    {
        return $this->_name;
    }

    public function setOptional($flag)
    {
        $this->_optional = (bool) $flag;
        return $this;
    }

    public function isOptional()
    {
        return $this->_optional;
    }

    public function setType($type)
    {
        $this->_type = (string) $type;
        return $this;
    }

    public function getType()
    {
        return $this->_type;
    }

    public function toArray()
    {
        return array(
            'type'         => $this->getType(),
            'name'         => $this->getName(),
            'optional'     => $this->isOptional(),
            'defaultValue' => $this->getDefaultValue(),
            'description'  => $this->getDescription(),
        );
    }
}