API Documentation

Zend/Server/Reflection/Function/Abstract.php

Show: inherited
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_Abstract

Package: Zend\Server\Reflection

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 {@link Zend_Server_Reflection_Prototype 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  
Used_by
\Zend_Server_Reflection_Method  
Used_by
\Zend_Server_Reflection_Function  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedarray  $_argv= 'array()'

Additional arguments to pass to method on invocation

Default valuearray()Details
Type
array
Propertyprotectedstring  $_class= ''

Declaring class (needed for when serialization occurs)

Details
Type
string
Propertyprotectedarray  $_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).

Associative array; access is as properties via {@link __get()} and {@link __set()}

Default valuearray()Details
Type
array
Propertyprotectedstring  $_description= ''''

Function/method description

Default value''Details
Type
string
Propertyprotectedstring  $_namespace= ''

Namespace with which to prefix function/method name

Details
Type
string
Propertyprivate  $_paramDesc= ''
Details
Type
Propertyprotectedarray  $_prototypes= 'array()'

Prototypes

Default valuearray()Details
Type
array
Propertyprotected\ReflectionFunction  $_reflection= ''

Details
Type
\ReflectionFunction
Propertyprivate  $_return= ''
Details
Type
Propertyprivate  $_returnDesc= ''
Details
Type
Propertyprivate  $_sigParams= ''
Details
Type
Propertyprivate  $_sigParamsDepth= ''
Details
Type

Methods

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

Proxy reflection calls

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__construct( \ReflectionFunction $r,  $namespace = null,  $argv = array() ) : void

Constructor

Parameters
Name Type Description
$r \ReflectionFunction
$namespace
$argv
methodpublic__get( string $key ) : mixed

Retrieve configuration parameters

Values are retrieved by key from {@link $_config}. Returns null if no value found.

Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublic__set( string $key, mixed $value ) : void

Set configuration parameters

Values are stored by $key in {@link $_config}.

Parameters
Name Type Description
$key string
$value mixed
methodpublic__wakeup( ) : void

Wakeup from serialization

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

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

Create signature node tree

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

Parameters
Name Type Description
$parent \Zend_Server_Reflection_Node
$level int
methodprotected_buildSignatures( array $return, string $returnDesc,  $paramTypes, array $paramDesc ) : array

Build method signatures

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

Parameters
Name Type Description
$return array

Array of return types

$returnDesc string

Return value description

$paramTypes
$paramDesc array

Array of parameter descriptions

Returns
Type Description
array
methodprotected_buildTree( ) : array

Build the signature tree

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.

Returns
Type Description
array
methodprotected_reflect( ) : array

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

Returns
Type Description
array
methodpublicgetDescription( ) : void

Retrieve the description

methodpublicgetInvokeArguments( ) : array

Retrieve additional invocation arguments

Returns
Type Description
array
methodpublicgetNamespace( ) : string

Return method's namespace

Returns
Type Description
string
methodpublicgetPrototypes( ) : array

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

Returns
Type Description
array
methodpublicsetDescription( string $string ) : void

Set the description

Parameters
Name Type Description
$string string
methodpublicsetNamespace( string $namespace ) : void

Set method's namespace

Parameters
Name Type Description
$namespace string
Documentation was generated by DocBlox 0.15.1.