Server/Reflection/Function.php
inherited
Classes
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 [email protected] 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
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
array $_argv = array()Additional arguments to pass to method on invocation
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_argvarray()Details- Type
- array
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_argv
string $_class = Declaring class (needed for when serialization occurs)
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_class- Type
- string
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_class
array $_config = array()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::$$_configarray()Details- Type
- array
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_config
string $_description = ''Function/method description
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_description''Details- Type
- string
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_description
string $_namespace = Namespace with which to prefix function/method name
Inherited from: \Zend_Server_Reflection_Function_Abstract::$$_namespace- Type
- string
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_namespace
$_paramDesc = - Type
- n/a
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_paramDesc
array $_prototypes = array()
array()Details- Type
- array
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_prototypes
\ReflectionFunction $_reflection = - Type
- \ReflectionFunction
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_reflection
$_return = - Type
- n/a
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_return
$_returnDesc = - Type
- n/a
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_returnDesc
$_sigParams = - Type
- n/a
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_sigParams
$_sigParamsDepth = - Type
- n/a
- Inherited_from
- \Zend_Server_Reflection_Function_Abstract::$$_sigParamsDepth
Methods
__call(string $method, array $args) : mixed| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| mixed |
__construct(\ReflectionFunction $r, $namespace = null, $argv = array()) : void
| Name | Type | Description |
|---|---|---|
| $r | \ReflectionFunction | |
| $namespace | ||
| $argv |
__get(string $key) : mixedRetrieve configuration parameters
Inherited from: \Zend_Server_Reflection_Function_Abstract::__get()Values are retrieved by key from $_config. Returns null if no value found.
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |
__set(string $key, mixed $value) : voidSet configuration parameters
Inherited from: \Zend_Server_Reflection_Function_Abstract::__set()Values are stored by $key in $_config.
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
__wakeup() : voidWakeup from serialization
Inherited from: \Zend_Server_Reflection_Function_Abstract::__wakeup()Reflection needs explicit instantiation to work correctly. Re-instantiate reflection object on wakeup.
_addTree(\Zend_Server_Reflection_Node $parent, int $level = 0) : voidCreate 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).
| Name | Type | Description |
|---|---|---|
| $parent | \Zend_Server_Reflection_Node | |
| $level | int |
_buildSignatures(array $return, string $returnDesc, $paramTypes, array $paramDesc) : arrayBuild 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
| Name | Type | Description |
|---|---|---|
| $return | array | Array of return types |
| $returnDesc | string | Return value description |
| $paramTypes | ||
| $paramDesc | array | Array of parameter descriptions |
| Type | Description |
|---|---|
| array |
_buildTree() : arrayBuild 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.
| Type | Description |
|---|---|
| array |
_reflect() : arrayUse 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.
| Type | Description |
|---|---|
| array |
getDescription() : voidRetrieve the description
Inherited from: \Zend_Server_Reflection_Function_Abstract::getDescription()getInvokeArguments() : arrayRetrieve additional invocation arguments
Inherited from: \Zend_Server_Reflection_Function_Abstract::getInvokeArguments()| Type | Description |
|---|---|
| array |
getNamespace() : stringReturn method's namespace
Inherited from: \Zend_Server_Reflection_Function_Abstract::getNamespace()| Type | Description |
|---|---|
| string |
getPrototypes() : arrayRetrieve all prototypes as array of {@link Zend_Server_Reflection_Prototype Zend_Server_Reflection_Prototypes}
Inherited from: \Zend_Server_Reflection_Function_Abstract::getPrototypes()| Type | Description |
|---|---|
| array |
setDescription(string $string) : voidSet the description
Inherited from: \Zend_Server_Reflection_Function_Abstract::setDescription()| Name | Type | Description |
|---|---|---|
| $string | string |
setNamespace(string $namespace) : voidSet method's namespace
Inherited from: \Zend_Server_Reflection_Function_Abstract::setNamespace()| Name | Type | Description |
|---|---|---|
| $namespace | string |