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.
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 {@link Zend_Server_Reflection_Prototype prototypes}.

__call(
string $method, array $args
)
:
mixed
Proxy reflection calls
Inherited from: \Zend_Server_Reflection_Function_Abstract::__call()Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
mixed |

__construct(
\Zend_Server_Reflection_Class $class, \ReflectionMethod $r, string $namespace
=
null, array $argv
=
array
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$class | \Zend_Server_Reflection_Class | |
$r | \ReflectionMethod | |
$namespace | string | |
$argv | array |

__get(
string $key
)
:
mixed
Retrieve configuration parameters
Inherited from: \Zend_Server_Reflection_Function_Abstract::__get()Values are retrieved by key from {@link $_config}. Returns null if no value found.
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

__set(
string $key, mixed $value
)
:
void
Set configuration parameters
Inherited from: \Zend_Server_Reflection_Function_Abstract::__set()Values are stored by $key in {@link $_config}.
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |

__wakeup(
)
:
void
Wakeup from serialization
Reflection needs explicit instantiation to work correctly. Re-instantiate reflection object on wakeup.

_addTree(
\Zend_Server_Reflection_Node $parent, int $level
=
0
)
:
void
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 {@link $_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
)
:
array
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
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(
)
:
array
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 {@link Zend_Server_Reflection_Node}s.
Type | Description |
---|---|
array |

_reflect(
)
:
array
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.
Type | Description |
---|---|
array |

getDeclaringClass(
)
:
\Zend_Server_Reflection_Class
Return the reflection for the class that defines this method
Type | Description |
---|---|
\Zend_Server_Reflection_Class |

getDescription(
)
:
void
Retrieve the description
Inherited from: \Zend_Server_Reflection_Function_Abstract::getDescription()
getInvokeArguments(
)
:
array
Retrieve additional invocation arguments
Inherited from: \Zend_Server_Reflection_Function_Abstract::getInvokeArguments()Type | Description |
---|---|
array |

getNamespace(
)
:
string
Return method's namespace
Inherited from: \Zend_Server_Reflection_Function_Abstract::getNamespace()Type | Description |
---|---|
string |

getPrototypes(
)
:
array
Retrieve 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
)
:
void
Set the description
Inherited from: \Zend_Server_Reflection_Function_Abstract::setDescription()Name | Type | Description |
---|---|---|
$string | string |

setNamespace(
string $namespace
)
:
void
Set method's namespace
Inherited from: \Zend_Server_Reflection_Function_Abstract::setNamespace()Name | Type | Description |
---|---|---|
$namespace | string |