Server/Reflection/Function/Abstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Server
Classes: Zend_Server_Reflection_Function_Abstract

Description

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.

Zend_Server_Reflection_Function_Abstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Server
subpackage: Reflection
version: $Id: Abstract.php 20637 2010-01-25 22:33:22Z matthew $
Properties: $_reflection; $_argv; $_config; $_class; $_description; $_namespace; $_prototypes; $_return; $_returnDesc; $_paramDesc; $_sigParams; $_sigParamsDepth
Methods: __construct; _addTree; _buildTree; _buildSignatures; _reflect; __call; __get; __set; setNamespace; getNamespace; setDescription; getDescription; getPrototypes; getInvokeArguments; __wakeup

Description

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

Properties

$_argv
jump to class

array $_argv = 'array'

Additional arguments to pass to method on invocation

Details

$_argv: array
visibility: protected
default: array
final: false
static: false

$_class
jump to class

string $_class = ''

Declaring class (needed for when serialization occurs)

Details

$_class: string
visibility: protected
default
final: false
static: false

$_config
jump to 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).

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

Details

$_config: array
visibility: protected
default: array
final: false
static: false

$_description
jump to class

string $_description = ''

Function/method description

Details

$_description: string
visibility: protected
default
final: false
static: false

$_namespace
jump to class

string $_namespace = ''

Namespace with which to prefix function/method name

Details

$_namespace: string
visibility: protected
default
final: false
static: false

$_paramDesc
jump to class

$_paramDesc = ''

Details

visibility: private
default
final: false
static: false

$_prototypes
jump to class

array $_prototypes = 'array'

Prototypes

Details

$_prototypes: array
visibility: protected
default: array
final: false
static: false

$_reflection
jump to class

ReflectionFunction $_reflection = ''

Details

$_reflection: ReflectionFunction
visibility: protected
default
final: false
static: false

$_return
jump to class

$_return = ''

Details

visibility: private
default
final: false
static: false

$_returnDesc
jump to class

$_returnDesc = ''

Details

visibility: private
default
final: false
static: false

$_sigParams
jump to class

$_sigParams = ''

Details

visibility: private
default
final: false
static: false

$_sigParamsDepth
jump to class

$_sigParamsDepth = ''

Details

visibility: private
default
final: false
static: false

Methods

__call
jump to class

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

Proxy reflection calls

Arguments

$method: string
$args: array

Output

mixed

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          ReflectionFunction $r,  $namespace
              =
              null,  $argv
              =
              array
          )
        
        :

Constructor

Arguments

$r: ReflectionFunction
$namespace
$argv

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $key
          )
        
        :
        mixed

Retrieve configuration parameters

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

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

__set
jump to class

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

Set configuration parameters

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

Arguments

$key: string
$value: mixed

Details

visibility: public
final: false
static: false

__wakeup
jump to class

__wakeup(
          
          )
        
        :
        void

Wakeup from serialization

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

Details

visibility: public
final: false
static: false

_addTree
jump to class

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

Arguments

$parent: Zend_Server_Reflection_Node
$level: int

Details

visibility: protected
final: false
static: false

_buildSignatures
jump to class

_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

Arguments

$return: array
Array of return types
$returnDesc: string
Return value description
$paramTypes
$paramDesc: array
Array of parameter descriptions

Output

array

Details

visibility: protected
final: false
static: false

_buildTree
jump to class

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

Output

array

Details

visibility: protected
final: false
static: false

_reflect
jump to class

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

Output

array

Details

visibility: protected
final: false
static: false

getDescription
jump to class

getDescription(
          
          )
        
        :
        void

Retrieve the description

Details

visibility: public
final: false
static: false

getInvokeArguments
jump to class

getInvokeArguments(
          
          )
        
        :
        array

Retrieve additional invocation arguments

Output

array

Details

visibility: public
final: false
static: false

getNamespace
jump to class

getNamespace(
          
          )
        
        :
        string

Return method's namespace

Output

string

Details

visibility: public
final: false
static: false

getPrototypes
jump to class

getPrototypes(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          string $string
          )
        
        :
        void

Set the description

Arguments

$string: string

Details

visibility: public
final: false
static: false

setNamespace
jump to class

setNamespace(
          string $namespace
          )
        
        :
        void

Set method's namespace

Arguments

$namespace: string

Details

visibility: public
final: false
static: false

API Documentation

Server/Reflection/Function/Abstract.php

Description

Zend_Server_Reflection_Function_Abstractjump to top

Description

Properties

$_argvjump to class

Details

$_classjump to class

Details

$_configjump to class

Details

$_descriptionjump to class

Details

$_namespacejump to class

Details

$_paramDescjump to class

Details

$_prototypesjump to class

Details

$_reflectionjump to class

Details

$_returnjump to class

Details

$_returnDescjump to class

Details

$_sigParamsjump to class

Details

$_sigParamsDepthjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__wakeupjump to class

Details

_addTreejump to class

Arguments

Details

_buildSignaturesjump to class

Arguments

Output

Details

_buildTreejump to class

Output

Details

_reflectjump to class

Output

Details

getDescriptionjump to class

Details

getInvokeArgumentsjump to class

Output

Details

getNamespacejump to class

Output

Details

getPrototypesjump to class

Output

Details

setDescriptionjump to class

Arguments

Details

setNamespacejump to class

Arguments

Details

Zend_Server_Reflection_Function_Abstract
jump to top

$_argv
jump to class

$_class
jump to class

$_config
jump to class

$_description
jump to class

$_namespace
jump to class

$_paramDesc
jump to class

$_prototypes
jump to class

$_reflection
jump to class

$_return
jump to class

$_returnDesc
jump to class

$_sigParams
jump to class

$_sigParamsDepth
jump to class

__call
jump to class

__construct
jump to class

__get
jump to class

__set
jump to class

__wakeup
jump to class

_addTree
jump to class

_buildSignatures
jump to class

_buildTree
jump to class

_reflect
jump to class

getDescription
jump to class

getInvokeArguments
jump to class

getNamespace
jump to class

getPrototypes
jump to class

setDescription
jump to class

setNamespace
jump to class