Server/Reflection/Function/Abstract.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_Abstract
Function/Method 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.
- Children
- \Zend_Server_Reflection_Method
- \Zend_Server_Reflection_Function
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
Properties
array $_argv = array()Additional arguments to pass to method on invocation
array()Details- Type
- array
string $_class = Declaring class (needed for when serialization occurs)
- Type
- string
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).
string $_description = ''Function/method description
''Details- Type
- string
string $_namespace = Namespace with which to prefix function/method name
- Type
- string
$_paramDesc =
- Type
- n/a
array $_prototypes = array()Prototypes
array()Details- Type
- array
$_return =
- Type
- n/a
$_returnDesc =
- Type
- n/a
$_sigParams =
- Type
- n/a
$_sigParamsDepth =
- Type
- n/a
Methods
__call(string $method, array $args) : mixedProxy reflection calls
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| mixed |
__construct(\ReflectionFunction $r, $namespace = null, $argv = array()) : voidConstructor
| Name | Type | Description |
|---|---|---|
| $r | \ReflectionFunction | |
| $namespace | ||
| $argv |
__get(string $key) : mixedRetrieve configuration parameters
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
Values are stored by $key in $_config.
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
__wakeup() : voidWakeup from serialization
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
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
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
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
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
getInvokeArguments() : arrayRetrieve additional invocation arguments
| Type | Description |
|---|---|
| array |
getNamespace() : stringReturn method's namespace
| Type | Description |
|---|---|
| string |
getPrototypes() : arrayRetrieve all prototypes as array of {@link Zend_Server_Reflection_Prototype Zend_Server_Reflection_Prototypes}
| Type | Description |
|---|---|
| array |
setDescription(string $string) : voidSet the description
| Name | Type | Description |
|---|---|---|
| $string | string |
setNamespace(string $namespace) : voidSet method's namespace
| Name | Type | Description |
|---|---|---|
| $namespace | string |