You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
209 lines
5.0 KiB
PHP
209 lines
5.0 KiB
PHP
<?php
|
|
/**
|
|
* Zend Framework
|
|
*
|
|
* LICENSE
|
|
*
|
|
* This source file is subject to the new BSD license that is bundled
|
|
* with this package in the file LICENSE.txt.
|
|
* It is also available through the world-wide-web at this URL:
|
|
* http://framework.zend.com/license/new-bsd
|
|
* If you did not receive a copy of the license and are unable to
|
|
* obtain it through the world-wide-web, please send an email
|
|
* to license@zend.com so we can send you a copy immediately.
|
|
*
|
|
* @category Zend
|
|
* @package Zend_Server
|
|
* @subpackage Method
|
|
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
* @version $Id: Prototype.php 16971 2009-07-22 18:05:45Z mikaelkael $
|
|
*/
|
|
|
|
/**
|
|
* Method prototype metadata
|
|
*
|
|
* @category Zend
|
|
* @package Zend_Server
|
|
* @subpackage Method
|
|
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
*/
|
|
class Zend_Server_Method_Prototype
|
|
{
|
|
/**
|
|
* @var string Return type
|
|
*/
|
|
protected $_returnType = 'void';
|
|
|
|
/**
|
|
* @var array Map parameter names to parameter index
|
|
*/
|
|
protected $_parameterNameMap = array();
|
|
|
|
/**
|
|
* @var array Method parameters
|
|
*/
|
|
protected $_parameters = array();
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param null|array $options
|
|
* @return void
|
|
*/
|
|
public function __construct($options = null)
|
|
{
|
|
if ((null !== $options) && is_array($options)) {
|
|
$this->setOptions($options);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set return value
|
|
*
|
|
* @param string $returnType
|
|
* @return Zend_Server_Method_Prototype
|
|
*/
|
|
public function setReturnType($returnType)
|
|
{
|
|
$this->_returnType = $returnType;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Retrieve return type
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getReturnType()
|
|
{
|
|
return $this->_returnType;
|
|
}
|
|
|
|
/**
|
|
* Add a parameter
|
|
*
|
|
* @param string $parameter
|
|
* @return Zend_Server_Method_Prototype
|
|
*/
|
|
public function addParameter($parameter)
|
|
{
|
|
if ($parameter instanceof Zend_Server_Method_Parameter) {
|
|
$this->_parameters[] = $parameter;
|
|
if (null !== ($name = $parameter->getName())) {
|
|
$this->_parameterNameMap[$name] = count($this->_parameters) - 1;
|
|
}
|
|
} else {
|
|
require_once 'Zend/Server/Method/Parameter.php';
|
|
$parameter = new Zend_Server_Method_Parameter(array(
|
|
'type' => (string) $parameter,
|
|
));
|
|
$this->_parameters[] = $parameter;
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add parameters
|
|
*
|
|
* @param array $parameter
|
|
* @return Zend_Server_Method_Prototype
|
|
*/
|
|
public function addParameters(array $parameters)
|
|
{
|
|
foreach ($parameters as $parameter) {
|
|
$this->addParameter($parameter);
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set parameters
|
|
*
|
|
* @param array $parameters
|
|
* @return Zend_Server_Method_Prototype
|
|
*/
|
|
public function setParameters(array $parameters)
|
|
{
|
|
$this->_parameters = array();
|
|
$this->_parameterNameMap = array();
|
|
$this->addParameters($parameters);
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Retrieve parameters as list of types
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getParameters()
|
|
{
|
|
$types = array();
|
|
foreach ($this->_parameters as $parameter) {
|
|
$types[] = $parameter->getType();
|
|
}
|
|
return $types;
|
|
}
|
|
|
|
/**
|
|
* Get parameter objects
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getParameterObjects()
|
|
{
|
|
return $this->_parameters;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a single parameter by name or index
|
|
*
|
|
* @param string|int $index
|
|
* @return null|Zend_Server_Method_Parameter
|
|
*/
|
|
public function getParameter($index)
|
|
{
|
|
if (!is_string($index) && !is_numeric($index)) {
|
|
return null;
|
|
}
|
|
if (array_key_exists($index, $this->_parameterNameMap)) {
|
|
$index = $this->_parameterNameMap[$index];
|
|
}
|
|
if (array_key_exists($index, $this->_parameters)) {
|
|
return $this->_parameters[$index];
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Set object state from array
|
|
*
|
|
* @param array $options
|
|
* @return Zend_Server_Method_Prototype
|
|
*/
|
|
public function setOptions(array $options)
|
|
{
|
|
foreach ($options as $key => $value) {
|
|
$method = 'set' . ucfirst($key);
|
|
if (method_exists($this, $method)) {
|
|
$this->$method($value);
|
|
}
|
|
}
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Serialize to array
|
|
*
|
|
* @return array
|
|
*/
|
|
public function toArray()
|
|
{
|
|
return array(
|
|
'returnType' => $this->getReturnType(),
|
|
'parameters' => $this->getParameters(),
|
|
);
|
|
}
|
|
}
|