Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Server_Reflection_Function_Abstract Class Reference

Public Member Functions

 __construct (Reflector $r, $namespace=null, $argv=array())
 Constructor.
 
 __call ($method, $args)
 Proxy reflection calls.
 
 __get ($key)
 Retrieve configuration parameters.
 
 __set ($key, $value)
 Set configuration parameters.
 
 setNamespace ($namespace)
 Set method's namespace.
 
 getNamespace ()
 Return method's namespace.
 
 setDescription ($string)
 Set the description.
 
 getDescription ()
 Retrieve the description.
 
 getPrototypes ()
 Retrieve all prototypes as array of Zend_Server_Reflection_Prototypes.
 
 getInvokeArguments ()
 Retrieve additional invocation arguments.
 
 __wakeup ()
 Wakeup from serialization.
 

Protected Member Functions

 _addTree (Zend_Server_Reflection_Node $parent, $level=0)
 Create signature node tree.
 
 _buildTree ()
 Build the signature tree.
 
 _buildSignatures ($return, $returnDesc, $paramTypes, $paramDesc)
 Build method signatures.
 
 _reflect ()
 Use code reflection to create method signatures.
 

Protected Attributes

 $_reflection
 
 $_argv = array()
 
 $_config = array()
 
 $_class
 
 $_description = ''
 
 $_namespace
 
 $_prototypes = array()
 

Constructor & Destructor Documentation

__construct ( Reflector  $r,
  $namespace = null,
  $argv = array() 
)

Constructor.

Parameters
ReflectionFunction$r

Member Function Documentation

__call (   $method,
  $args 
)

Proxy reflection calls.

Parameters
string$method
array$args
Returns
mixed
__get (   $key)

Retrieve configuration parameters.

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

Parameters
string$key
Returns
mixed
__set (   $key,
  $value 
)

Set configuration parameters.

Values are stored by $key in $_config.

Parameters
string$key
mixed$value
Returns
void
__wakeup ( )

Wakeup from serialization.

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

Returns
void
_addTree ( Zend_Server_Reflection_Node  $parent,
  $level = 0 
)
protected

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

Parameters
Zend_Server_Reflection_Node$parent
int$level
Returns
void
_buildSignatures (   $return,
  $returnDesc,
  $paramTypes,
  $paramDesc 
)
protected

Build method signatures.

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

Parameters
array$returnArray of return types
string$returnDescReturn value description
array$paramsArray of arguments (each an array of types)
array$paramDescArray of parameter descriptions
Returns
array
_buildTree ( )
protected

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

Returns
array
_reflect ( )
protected

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

Parameters
and@returnvalues.
ReflectionFunction$function
Returns
array
getDescription ( )

Retrieve the description.

Returns
void
getInvokeArguments ( )

Retrieve additional invocation arguments.

Returns
array
getNamespace ( )

Return method's namespace.

Returns
string
getPrototypes ( )

Retrieve all prototypes as array of Zend_Server_Reflection_Prototypes.

Returns
array
setDescription (   $string)

Set the description.

Parameters
string$string
Returns
void
setNamespace (   $namespace)

Set method's namespace.

Parameters
string$namespace
Returns
void

Member Data Documentation

$_argv = array()
protected
$_class
protected
$_config = array()
protected
$_description = ''
protected
$_namespace
protected
$_prototypes = array()
protected
$_reflection
protected