Extension¶
-
class
JuliusHaertl\PHPDocToRst\Extension\
Extension
¶ Source: src/Extension/Extension.php#32
Summary¶
Properties¶
-
protected static property
JuliusHaertl\PHPDocToRst\Extension\Extension::$
project
¶ Source: src/Extension/Extension.php#35 Type: \phpDocumentor\Reflection\Php\Project
-
protected static property
JuliusHaertl\PHPDocToRst\Extension\Extension::$
arguments
¶ Source: src/Extension/Extension.php#38 Type: array
Methods¶
-
public
JuliusHaertl\PHPDocToRst\Extension\Extension::
__construct
(phpDocumentor\Reflection\Php\Project $project, $arguments=[])¶ Source: src/Extension/Extension.php#40
-
public
JuliusHaertl\PHPDocToRst\Extension\Extension::
prepare
()¶ - Method that will be ran before generating any documentation filesThis is useful for preparing own data structuresto be used in the output documentation
Source: src/Extension/Extension.php#50
-
public
JuliusHaertl\PHPDocToRst\Extension\Extension::
render
($type, &$builder, $element)¶ - Implement custom rendering functionality here.It will be executed by Builder classes depending on the given type.Currently supported types:- PhpDomainBuilder::SECTION_BEFORE_DESCRIPTION- PhpDomainBuilder::SECTION_AFTER_DESCRIPTION
Source: Parameters: - $type (string)
- $builder (
JuliusHaertl\PHPDocToRst\Builder\ExtensionBuilder
) - $element (
phpDocumentor\Reflection\Element
) context for the render type
-
public
JuliusHaertl\PHPDocToRst\Extension\Extension::
shouldRenderElement
(phpDocumentor\Reflection\Element $element)¶ - This method will be called to check if a certain element shouldbe rendered in the documentation.An example extension that makes use of it is PublicOnlyExtension
Source: Parameters: - $element (
phpDocumentor\Reflection\Element
)
Returns: bool
- $element (
-
public
JuliusHaertl\PHPDocToRst\Extension\Extension::
shouldRenderIndex
($type, $element)¶ Source: src/Extension/Extension.php#84