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.

package Default
inherited_from \Zend\Server\Reflection\AbstractFunction

 Methods

Proxy reflection calls

__call(string $method, array $args) : mixed
Inherited

Parameters

$method

string

$args

array

Exceptions

\Zend\Server\Reflection\Exception\BadMethodCallException

Returns

mixed

Constructor

__construct(\Zend\Server\Reflection\ReflectionClass $class, \ReflectionMethod $r, string $namespace = null, array $argv = array()
inherited_from \Zend\Server\Reflection\AbstractFunction::__construct()

Parameters

$class

\Zend\Server\Reflection\ReflectionClass

$r

\ReflectionMethod

$namespace

string

$argv

array

Constructor

__construct(\ReflectionFunctionAbstract $r, null|string $namespace = null, null|array $argv = array()
Inherited

Parameters

$r

\ReflectionFunctionAbstract

$namespace

nullstring

$argv

nullarray

Exceptions

\Zend\Server\Reflection\Exception\InvalidArgumentException
\Zend\Server\Reflection\Exception\RuntimeException

Retrieve configuration parameters

__get(string $key) : mixed
Inherited

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

Parameters

$key

string

Returns

mixed

Set configuration parameters

__set(string $key, mixed $value) : void
Inherited

Values are stored by $key in \$config.

Parameters

$key

string

$value

mixed

Wakeup from serialization

__wakeup() : void

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

inherited_from \Zend\Server\Reflection\AbstractFunction::__wakeup()

Wakeup from serialization

__wakeup() : void
Inherited

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

Return the reflection for the class that defines this method

getDeclaringClass() : \Zend\Server\Reflection\ReflectionClass

Returns

\Zend\Server\Reflection\ReflectionClass

Retrieve the description

getDescription() : string
Inherited

Returns

string

Retrieve additional invocation arguments

getInvokeArguments() : array
Inherited

Returns

array

Return method's namespace

getNamespace() : string
Inherited

Returns

string

Retrieve all prototypes as array of {@link \Zend\Server\Reflection\Prototype}s

getPrototypes() : array<mixed,\Zend\Server\Reflection\Prototype>
Inherited

Returns

array<mixed,\Zend\Server\Reflection\Prototype>

Set the description

setDescription(string $string) : void
Inherited

Parameters

$string

string

Exceptions

\Zend\Server\Reflection\Exception\InvalidArgumentException

Set method's namespace

setNamespace(string $namespace) : void
Inherited

Parameters

$namespace

string

Exceptions

\Zend\Server\Reflection\Exception\InvalidArgumentException

Create signature node tree

addTree(\Zend\Server\Reflection\Node $parent, integer $level = 0) : void
Inherited

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

$parent

\Zend\Server\Reflection\Node

$level

integer

Build method signatures

buildSignatures(array $return, string $returnDesc, array $paramTypes, array $paramDesc) : array
Inherited

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

Parameters

$return

array

Array of return types

$returnDesc

string

Return value description

$paramTypes

array

Array of arguments (each an array of types)

$paramDesc

array

Array of parameter descriptions

Returns

array

Build the signature tree

buildTree() : array
Inherited

Builds a signature tree starting at the return values and descending through each method argument. Returns an array of \Zend\Server\Reflection\Nodes.

Returns

array

Use code reflection to create method signatures

reflect() : array
Inherited

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.

Exceptions

\Zend\Server\Reflection\Exception\RuntimeException

Returns

array

 Properties

 

Additional arguments to pass to method on invocation

$argv : array

Default

array()
 

Parent class name

$class : string

Default

inherited_from \Zend\Server\Reflection\AbstractFunction::class
 

Declaring class (needed for when serialization occurs)

$class : string

Default

 

Parent class reflection

$classReflection : \Zend\Server\Reflection\ReflectionClass

Default

 

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).

$config : array

Default

array()

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

 

Function/method description

$description : string

Default

''
 

Namespace with which to prefix function/method name

$namespace : string

Default

 

Prototypes

$prototypes : array

Default

array()
 

$reflection

$reflection : \ReflectionFunctionAbstract

Default

 

$paramDesc

$paramDesc 

Default

 

$return

$return 

Default

 

$returnDesc

$returnDesc 

Default

 

$sigParams

$sigParams 

Default

 

$sigParamsDepth

$sigParamsDepth 

Default