Zend_Server_Method_Prototype Class Reference

Public Member Functions
	__construct ($options=null)
	setReturnType ($returnType)
	getReturnType ()
	addParameter ($parameter)
	addParameters (array $parameters)
	setParameters (array $parameters)
	getParameters ()
	getParameterObjects ()
	getParameter ($index)
	setOptions (array $options)
	toArray ()

Protected Attributes
	$_returnType = 'void'
	$_parameterNameMap = array()
	$_parameters = array()

Detailed Description

Definition at line 32 of file Prototype.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

null | array

$options

Returns

void

Definition at line 55 of file Prototype.php.

    {
        if ((null !== $options) && is_array($options)) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

addParameter()

addParameter

(

$parameter

)

Add a parameter

Parameters

string

$parameter

Returns

Zend_Server_Method_Prototype

Definition at line 90 of file Prototype.php.

    {
        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;
    }

addParameters()

addParameters

(

array

$parameters

)

Add parameters

Parameters

array

$parameter

Returns

Zend_Server_Method_Prototype

Definition at line 113 of file Prototype.php.

    {
        foreach ($parameters as $parameter) {
            $this->addParameter($parameter);
        }
        return $this;
    }

getParameter()

getParameter

(

$index

)

Retrieve a single parameter by name or index

Parameters

string | int

$index

Returns

null|Zend_Server_Method_Parameter

Definition at line 165 of file Prototype.php.

    {
        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;
    }

getParameterObjects()

getParameterObjects

(

)

Get parameter objects

Returns

array

Definition at line 154 of file Prototype.php.

    {
        return $this->_parameters;
    }

getParameters()

getParameters

(

)

Retrieve parameters as list of types

Returns

array

Definition at line 140 of file Prototype.php.

    {
        $types = array();
        foreach ($this->_parameters as $parameter) {
            $types[] = $parameter->getType();
        }
        return $types;
    }

getReturnType()

getReturnType

(

)

Retrieve return type

Returns

string

Definition at line 79 of file Prototype.php.

    {
        return $this->_returnType;
    }

setOptions()

setOptions

(

array

$options

)

Set object state from array

Parameters

array

$options

Returns

Zend_Server_Method_Prototype

Definition at line 185 of file Prototype.php.

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

setParameters()

setParameters

(

array

$parameters

)

Set parameters

Parameters

array

$parameters

Returns

Zend_Server_Method_Prototype

Definition at line 127 of file Prototype.php.

    {
        $this->_parameters       = array();
        $this->_parameterNameMap = array();
        $this->addParameters($parameters);
        return $this;
    }

setReturnType()

setReturnType

(

$returnType

)

Set return value

Parameters

string

$returnType

Returns

Zend_Server_Method_Prototype

Definition at line 68 of file Prototype.php.

    {
        $this->_returnType = $returnType;
        return $this;
    }

toArray()

toArray

(

)

Serialize to array

Returns

array

Definition at line 201 of file Prototype.php.

    {
        return array(
            'returnType' => $this->getReturnType(),
            'parameters' => $this->getParameters(),
        );
    }

Field Documentation

$_parameterNameMap

$_parameterNameMap = array()

protected

Definition at line 42 of file Prototype.php.

$_parameters

$_parameters = array()

protected

Definition at line 47 of file Prototype.php.

$_returnType

$_returnType = 'void'

protected

Definition at line 37 of file Prototype.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Server/Method/Prototype.php