PHP Class Horde_Reflection, horde

Based on the PEAR XML_RPC2_Server_Method class by Sergio Carvalho Copyright 2004-2006 Sergio Gonalves Carvalho () Copyright 2008-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Author: Sergio Carvalho ([email protected])

Author: Duck ([email protected])

Author: Jan Schneider ([email protected])

Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_help	string	Method help, for introspection.
$_name	string	External method name.
$_numberOfRequiredParameters	integer	Number of required parameters.
$_parameters	array	Method signature parameters.
$_returns	string	Method signature return type.

Public Methods

Method	Description
__construct ( ReflectionFunction $method )	Constructor.
autoDocument ( ) : string	Returns a complete description of the method.
factory ( string $function, string $driver = 'Html' ) : Horde_Document	Attempts to return a concrete Horde_Document instance based on $driver.

Protected Methods

Method	Description
_limitPHPType ( $type ) : string \| array	Converts types from phpdoc comments (and limit to xmlrpc available types) to php type names.

Method Details

__construct() public method

Constructor.

public __construct ( ReflectionFunction $method )
$method	ReflectionFunction	The PHP method to introspect.

_limitPHPType() protected static method

Converts types from phpdoc comments (and limit to xmlrpc available types) to php type names.

protected static _limitPHPType ( $type ) : string \| array
return	string \| array	The standardized php type(s).

autoDocument() abstract public method

Returns a complete description of the method.

abstract public autoDocument ( ) : string
return	string	The method documentation.

factory() public static method

Attempts to return a concrete Horde_Document instance based on $driver.

public static factory ( string $function, string $driver = 'Html' ) : Horde_Document
$function	string	The method to document.
$driver	string	The type of the concrete Horde_Document subclass to return. The class name is based on the driver. The code is dynamically included.
return	Horde_Document	The newly created concrete Horde_Document instance, or false on an error.

Property Details

$_help protected_oe property

Method help, for introspection.

protected string $_help
return	string

$_name protected_oe property

External method name.

protected string $_name
return	string

$_numberOfRequiredParameters protected_oe property

Number of required parameters.

protected int $_numberOfRequiredParameters
return	integer

$_parameters protected_oe property

Method signature parameters.

protected array $_parameters
return	array

$_returns protected_oe property

Method signature return type.

protected string $_returns
return	string