PhpDomainBuilder¶

class JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder¶

Class to build reStructuredText file with sphinxcontrib-phpdomain syntax

Source:	src/Builder/PhpDomainBuilder.php#49
Parent:	`JuliusHaertl\PHPDocToRst\Builder\RstBuilder`
Used traits:	`JuliusHaertl\PHPDocToRst\Builder\ExtensionBuilder`

Summary¶

Methods¶

public __construct($extensions)
public static getNamespace($element)
protected addPageHeader($element)
private getTypeForClass($element)
protected addAfterIntroduction($element)
protected addConstants($constants)
private addConstant($constant)
protected addProperties($properties)
private addProperty($property)
protected addParent($element)
protected addUsedTraits($element)
protected addMethods($methods)
private addMethod($method)
public static getLink($type, $fqsen, $description)
public beginPhpDomain($type, $name, $indent)
public endPhpDomain($type)
public addDocBlockDescription($element)
protected addDocblockTag($tagName, $docBlock)
public static typesToRst($typesString)
public shouldRenderElement($element)

Constants¶

SECTION_BEFORE_DESCRIPTION = self::class . ::SECTION_BEFORE_DESCRIPTION

Source:	src/Builder/PhpDomainBuilder.php#51

SECTION_AFTER_DESCRIPTION = self::class . ::SECTION_AFTER_DESCRIPTION

Source:	src/Builder/PhpDomainBuilder.php#52

SECTION_AFTER_TITLE = self::class . ::SECTION_AFTER_TITLE

Source:	src/Builder/PhpDomainBuilder.php#53

SECTION_AFTER_INTRODUCTION = self::class . ::SECTION_AFTER_INTRODUCTION

Source:	src/Builder/PhpDomainBuilder.php#54

Methods¶

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::__construct($extensions)¶

Source:	src/Builder/PhpDomainBuilder.php#60

public static JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::getNamespace(phpDocumentor\Reflection\Element $element)¶

Strip element name from Fqsen to return the namespace only

Source:	src/Builder/PhpDomainBuilder.php#72
Parameters:	$element (`phpDocumentor\Reflection\Element`)
Returns:	mixed

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addPageHeader(phpDocumentor\Reflection\Element $element)¶

Add namespace

Source:	src/Builder/PhpDomainBuilder.php#81
Parameters:	$element (`phpDocumentor\Reflection\Element`)

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addAfterIntroduction($element)¶

Source:	src/Builder/PhpDomainBuilder.php#118

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addConstants($constants)¶

Source:	src/Builder/PhpDomainBuilder.php#123

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addProperties($properties)¶

Source:	src/Builder/PhpDomainBuilder.php#152
Parameters:	$properties (`phpDocumentor\Reflection\Php\Property[]`)

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addParent($element)¶

Source:	src/Builder/PhpDomainBuilder.php#182
Parameters:	$element (`phpDocumentor\Reflection\Php\Interface_` \| `\phpDocumentor\Reflection\Php\Class_`)

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addUsedTraits($element)¶

Source:	src/Builder/PhpDomainBuilder.php#200
Parameters:	$element (`phpDocumentor\Reflection\Php\Class_` \| `\phpDocumentor\Reflection\Php\Trait_`)

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addMethods($methods)¶

Source:	src/Builder/PhpDomainBuilder.php#213
Parameters:	$methods

public static JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::getLink($type, $fqsen, $description="")¶

Source:	src/Builder/PhpDomainBuilder.php#309
Parameters:	$type string $fqsen string
Returns:	string

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::beginPhpDomain($type, $name, $indent=true)¶

Source:	src/Builder/PhpDomainBuilder.php#321
Parameters:	$type string $name string $indent bool Should indent after the section started

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::endPhpDomain($type="")¶

Source:	src/Builder/PhpDomainBuilder.php#333
Parameters:	$type (string)
Returns:	$this

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addDocBlockDescription($element)¶

Source:	src/Builder/PhpDomainBuilder.php#342
Parameters:	$element (`phpDocumentor\Reflection\Php\Class_` \| `\phpDocumentor\Reflection\Php\Interface_` \| `\phpDocumentor\Reflection\Php\Trait_` \| `\phpDocumentor\Reflection\Php\Property` \| `\phpDocumentor\Reflection\Php\Method` \| `\phpDocumentor\Reflection\Php\Constant`)
Returns:	$this

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addDocblockTag($tagName, phpDocumentor\Reflection\DocBlock $docBlock)¶

Source:	src/Builder/PhpDomainBuilder.php#365
Parameters:	$tagName (string) Name of the tag to parse $docBlock (`phpDocumentor\Reflection\DocBlock`)

public static JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::typesToRst($typesString)¶

Source:	src/Builder/PhpDomainBuilder.php#425
Parameters:	$typesString (string)
Returns:	bool \| string

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::shouldRenderElement(phpDocumentor\Reflection\Element $element)¶

Source:	src/Builder/PhpDomainBuilder.php#451
Parameters:	$element (`phpDocumentor\Reflection\Element`)
Returns:	bool