RstBuilder

class JuliusHaertl\PHPDocToRst\Builder\RstBuilder

Helper class to build reStructuredText files

Source:src/Builder/RstBuilder.php#34

Summary

Methods

• public getContent()
• public static escape($text)
• public indent()
• public unindent()
• public addFieldList($key, $value)
• public addH1($text)
• public addH2($text)
• public addH3($text)
• public addLine($text)
• public addMultiline($text, $blockIndent)
• public addMultilineWithoutRendering($text)
• public add($text)

Properties

protected static property JuliusHaertl\PHPDocToRst\Builder\RstBuilder::$content

Source:src/Builder/RstBuilder.php#38 Type:string

Methods

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::getContent()

Source:src/Builder/RstBuilder.php#40

public static JuliusHaertl\PHPDocToRst\Builder\RstBuilder::escape($text)

Source:src/Builder/RstBuilder.php#44

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::indent()

Source:src/Builder/RstBuilder.php#50

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::unindent()

Source:src/Builder/RstBuilder.php#55

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addFieldList($key, $value)

Source:src/Builder/RstBuilder.php#61

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addH1(string $text)

Source:

src/Builder/RstBuilder.php#71

Parameters:

• $text (string)

Returns:

$this

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addH2($text)

Source:src/Builder/RstBuilder.php#77

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addH3($text)

Source:src/Builder/RstBuilder.php#83

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addLine($text="")

Source:src/Builder/RstBuilder.php#89

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addMultiline($text="", $blockIndent=false)

Source:src/Builder/RstBuilder.php#94

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::addMultilineWithoutRendering($text)

Source:src/Builder/RstBuilder.php#109

public JuliusHaertl\PHPDocToRst\Builder\RstBuilder::add($text)

Source:src/Builder/RstBuilder.php#118