PhpDomainBuilder

class JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder

Class to build reStructuredText file with sphinxcontrib-phpdomain syntax.

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

Summary

Methods

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

Constants

SECTION_BEFORE_DESCRIPTION = self::class . ::SECTION_BEFORE_DESCRIPTION

Source:/Builder/PhpDomainBuilder.php#46

SECTION_AFTER_DESCRIPTION = self::class . ::SECTION_AFTER_DESCRIPTION

Source:/Builder/PhpDomainBuilder.php#47

SECTION_AFTER_TITLE = self::class . ::SECTION_AFTER_TITLE

Source:/Builder/PhpDomainBuilder.php#48

SECTION_AFTER_INTRODUCTION = self::class . ::SECTION_AFTER_INTRODUCTION

Source:/Builder/PhpDomainBuilder.php#49

Methods

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

Source:/Builder/PhpDomainBuilder.php#55

protected JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addPageHeader($element)

Add namespace.

Source:

/Builder/PhpDomainBuilder.php#67

Parameters:

• $element (phpDocumentor\Reflection\Element)

public static JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::getNamespace($element)

Strip element name from Fqsen to return the namespace only.

Source:

/Builder/PhpDomainBuilder.php#94

Parameters:

• $element (phpDocumentor\Reflection\Element)

Returns:

mixed

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

Source:

/Builder/PhpDomainBuilder.php#105

Parameters:

• $type string
• $name string
• $indent bool Should indent after the section started

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::getTypeForClass($element)

Source:/Builder/PhpDomainBuilder.php#114

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

Source:/Builder/PhpDomainBuilder.php#132

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

Source:/Builder/PhpDomainBuilder.php#137

public JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::shouldRenderElement($element)

Source:

/Builder/PhpDomainBuilder.php#154

Parameters:

• $element (phpDocumentor\Reflection\Element)

Returns:

bool

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addConstant($constant)

Source:

/Builder/PhpDomainBuilder.php#169

Parameters:

• $constant (phpDocumentor\Reflection\Php\Constant)

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

Source:

/Builder/PhpDomainBuilder.php#187

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, $docBlock)

Source:

/Builder/PhpDomainBuilder.php#212

Parameters:

• $tagName (string) Name of the tag to parse
• $docBlock (phpDocumentor\Reflection\DocBlock)

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

Source:

/Builder/PhpDomainBuilder.php#281

Parameters:

• $typesString (string)

Returns:

bool | string

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

Source:

/Builder/PhpDomainBuilder.php#327

Parameters:

• $type (string)

Returns:

$this

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

Source:

/Builder/PhpDomainBuilder.php#336

Parameters:

• $properties (phpDocumentor\Reflection\Php\Property[])

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addProperty($property)

Source:

/Builder/PhpDomainBuilder.php#351

Parameters:

• $property (phpDocumentor\Reflection\Php\Property)

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

Source:

/Builder/PhpDomainBuilder.php#368

Parameters:

• $element (phpDocumentor\Reflection\Php\Interface_ | \phpDocumentor\Reflection\Php\Class_)

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

Source:

/Builder/PhpDomainBuilder.php#390

Parameters:

• $type string
• $fqsen string

Returns:

string

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

Source:

/Builder/PhpDomainBuilder.php#403

Parameters:

• $element (phpDocumentor\Reflection\Php\Class_ | \phpDocumentor\Reflection\Php\Trait_)

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

Source:

/Builder/PhpDomainBuilder.php#417

Parameters:

• $methods

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::addMethod($method)

Source:/Builder/PhpDomainBuilder.php#427

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::processMethodArgumentDocs($method, $params)

Source:

/Builder/PhpDomainBuilder.php#474

Parameters:

• $method (phpDocumentor\Reflection\Php\Method)
• $params (array)

Returns:

string

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::processMethodArgumentTypes($method)

Source:

/Builder/PhpDomainBuilder.php#511

Parameters:

• $method (phpDocumentor\Reflection\Php\Method)

Returns:

string

private JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder::processMethodArgumentType($argument, $args)

Source:

/Builder/PhpDomainBuilder.php#528

Parameters:

• $argument (phpDocumentor\Reflection\Php\Argument)
• $args (string)

Returns:

string