Server/Reflection/Function.php

Show: PublicProtectedPrivateinherited
Table of Contents
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  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Server  

\Zend_Server_Reflection_Function

Package: Zend\Server\Reflection
Function Reflection

Decorates a ReflectionFunction. Allows setting and retrieving an alternate 'service' name (i.e., the name to be used when calling via a service), setting and retrieving the description (originally set using the docblock contents), retrieving the callback and callback type, retrieving additional method invocation arguments, and retrieving the method prototypes.

Parent(s)
\Zend_Server_Reflection_Function_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Server_Reflection_Function_Abstract  
Version
$Id: Function.php 24593 2012-01-05 20:35:02Z matthew $  

Properties

>VPropertyprotectedarray $_argv = array()
inherited
Additional arguments to pass to method on invocation
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_argv
Default valuearray()Details
Type
array
Inherited_from
\Zend_Server_Reflection_Function_Abstract::$$_argv  
>VPropertyprotectedstring $_class
inherited
Declaring class (needed for when serialization occurs)
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_class
Details
Type
string
Inherited_from
\Zend_Server_Reflection_Function_Abstract::$$_class  
>VPropertyprotectedarray $_config = array()
inherited
Used to store extra configuration for the method (typically done by the server class, e.g., to indicate whether or not to instantiate a class).
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_config

Associative array; access is as properties via __get() and __set()

Default valuearray()Details
Type
array
Inherited_from
\Zend_Server_Reflection_Function_Abstract::$$_config  
>VPropertyprotectedstring $_description = ''
inherited
Function/method description
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_description
Default value''Details
Type
string
Inherited_from
\Zend_Server_Reflection_Function_Abstract::$$_description  
>VPropertyprotectedstring $_namespace
inherited
Namespace with which to prefix function/method name
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_namespace
>VPropertyprotectedarray $_prototypes = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Server_Reflection_Function_Abstract::$$_prototypes  

Methods

methodpublic__call(string $method, array $args) : mixed
inherited

Proxy reflection calls

Inherited from: \Zend_Server_Reflection_Function_Abstract::__call()
Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
methodpublic__construct(\ReflectionFunction $r,  $namespace = null,  $argv = array()) : void
Parameters
NameTypeDescription
$r\ReflectionFunction
$namespace
$argv
methodpublic__get(string $key) : mixed
inherited

Retrieve configuration parameters

Inherited from: \Zend_Server_Reflection_Function_Abstract::__get()

Values are retrieved by key from $_config. Returns null if no value found.

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublic__set(string $key, mixed $value) : void
inherited

Set configuration parameters

Inherited from: \Zend_Server_Reflection_Function_Abstract::__set()

Values are stored by $key in $_config.

Parameters
NameTypeDescription
$keystring
$valuemixed
methodpublic__wakeup() : void
inherited

Wakeup from serialization

Inherited from: \Zend_Server_Reflection_Function_Abstract::__wakeup()

Reflection needs explicit instantiation to work correctly. Re-instantiate reflection object on wakeup.

methodprotected_addTree(\Zend_Server_Reflection_Node $parent, int $level = 0) : void
inherited

Create signature node tree

Inherited from: \Zend_Server_Reflection_Function_Abstract::_addTree()

Recursive method to build the signature node tree. Increments through each array in $_sigParams, adding every value of the next level to the current value (unless the current value is null).

Parameters
NameTypeDescription
$parent\Zend_Server_Reflection_Node
$levelint
methodprotected_buildSignatures(array $return, string $returnDesc,  $paramTypes, array $paramDesc) : array
inherited

Build method signatures

Inherited from: \Zend_Server_Reflection_Function_Abstract::_buildSignatures()

Builds method signatures using the array of return types and the array of parameters types

Parameters
NameTypeDescription
$returnarray

Array of return types

$returnDescstring

Return value description

$paramTypes
$paramDescarray

Array of parameter descriptions

Returns
TypeDescription
array
methodprotected_buildTree() : array
inherited

Build the signature tree

Inherited from: \Zend_Server_Reflection_Function_Abstract::_buildTree()

Builds a signature tree starting at the return values and descending through each method argument. Returns an array of Zend_Server_Reflection_Nodes.

Returns
TypeDescription
array
methodprotected_reflect() : array
inherited

Use code reflection to create method signatures

Inherited from: \Zend_Server_Reflection_Function_Abstract::_reflect()

Determines the method help/description text from the function DocBlock comment. Determines method signatures using a combination of ReflectionFunction and parsing of DocBlock @param and @return values.

Returns
TypeDescription
array
methodpublicgetDescription() : void
inherited

Retrieve the description

Inherited from: \Zend_Server_Reflection_Function_Abstract::getDescription()
methodpublicgetInvokeArguments() : array
inherited

Retrieve additional invocation arguments

Inherited from: \Zend_Server_Reflection_Function_Abstract::getInvokeArguments()
Returns
TypeDescription
array
methodpublicgetNamespace() : string
inherited

Return method's namespace

Inherited from: \Zend_Server_Reflection_Function_Abstract::getNamespace()
Returns
TypeDescription
string
methodpublicgetPrototypes() : array
inherited

Retrieve all prototypes as array of {@link Zend_Server_Reflection_Prototype Zend_Server_Reflection_Prototypes}

Inherited from: \Zend_Server_Reflection_Function_Abstract::getPrototypes()
Returns
TypeDescription
array
methodpublicsetDescription(string $string) : void
inherited

Set the description

Inherited from: \Zend_Server_Reflection_Function_Abstract::setDescription()
Parameters
NameTypeDescription
$stringstring
methodpublicsetNamespace(string $namespace) : void
inherited

Set method's namespace

Inherited from: \Zend_Server_Reflection_Function_Abstract::setNamespace()
Parameters
NameTypeDescription
$namespacestring
Documentation was generated by phpDocumentor 2.0.0a12.