API Documentation
\

\Horde_Reflection_Wiki

The Horde_Reflection_Wiki class renders method documention in the Text_Wiki format.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
autoDocument()
factory()
No public properties found
No constants found
_limitPHPType()
$_parameters
$_returns
$_help
$_numberOfRequiredParameters
$_name
N/A
_getSignature()
No private properties found
N/A

Properties

$_parameters

$_parameters : array

Method signature parameters.

Type

array

$_returns

$_returns : string

Method signature return type.

Type

string

$_help

$_help : string

Method help, for introspection.

Type

string

$_numberOfRequiredParameters

$_numberOfRequiredParameters : integer

Number of required parameters.

Type

integer

$_name

$_name : string

External method name.

Type

string

Methods

__construct()

__construct(\ReflectionMethod  $method)

Constructor.

Parameters

\ReflectionMethod $method

The PHP method to introspect.

autoDocument()

autoDocument() : string

Returns a complete wiki description of the method.

Returns

string —

A wiki snippet with the method documentation.

factory()

factory(string  $function, string  $driver = 'Html') : \Horde_Document

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

Parameters

string $function

The method to document.
string $driver

The type of the concrete Horde_Document subclass to return. The class name is based on the driver. The code is dynamically included.

Returns

\Horde_Document —

The newly created concrete Horde_Document instance, or false on an error.

_limitPHPType()

_limitPHPType(  $type) : string|array

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

Parameters

$type

Returns

string|array —

The standardized php type(s).

_getSignature()

_getSignature() : string

Returns a signature of the method.

Returns

string —

Method signature.