ApiDocBuilder¶

class JuliusHaertl\PHPDocToRst\ApiDocBuilder¶

This class is used to parse a project tree and generate rst files

for all of the containing PHP structures.

Example usage is documented in examples/example.php

Source:	/ApiDocBuilder.php#49

Summary¶

Methods¶

public __construct($srcDir, $dstDir)
public build()
private setupReflection()
public log($message)
private createDirectoryStructure()
private parseFiles()
public debug($message)
private buildIndexes()
public setVerboseOutput($v)
public setDebugOutput($v)
public addExtension($class, $arguments)
private parseInterfaces($file)
private parseClasses($file)
private parseTraits($file)
private parseFunctions($file)
private parseConstants($file)

Properties¶

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$project¶

Source:	/ApiDocBuilder.php#52
Type:	`\phpDocumentor\Reflection\Php\Project`

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$docFiles¶

Source:	/ApiDocBuilder.php#55
Type:	array

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$constants¶

Source:	/ApiDocBuilder.php#58
Type:	array

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$functions¶

Source:	/ApiDocBuilder.php#61
Type:	array

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$extensions¶

Source:	/ApiDocBuilder.php#64
Type:	`\JuliusHaertl\PHPDocToRst\Extension\Extension[]`

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$extensionNames¶

Source:	/ApiDocBuilder.php#67
Type:	string[]

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$extensionArguments¶

Source:	/ApiDocBuilder.php#70
Type:	array[]

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$srcDir¶

Source:	/ApiDocBuilder.php#73
Type:	string[]

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$dstDir¶

Source:	/ApiDocBuilder.php#76
Type:	string

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$verboseOutput¶

Source:	/ApiDocBuilder.php#79
Type:	bool

private static property JuliusHaertl\PHPDocToRst\ApiDocBuilder::$debugOutput¶

Source:	/ApiDocBuilder.php#82
Type:	bool

Methods¶

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::__construct($srcDir, $dstDir)¶

ApiDocBuilder constructor.

Source:	/ApiDocBuilder.php#90
Parameters:	$srcDir (string[]) array of paths that should be analysed $dstDir (string) path where the output documentation should be stored

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::build()¶

Run this to build the documentation.

Source:	/ApiDocBuilder.php#99

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::setupReflection()¶

Source:	/ApiDocBuilder.php#112
Throws:	`\Exception`

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::log($message)¶

Log a message.

Source:	/ApiDocBuilder.php#166
Parameters:	$message (string) Message to be logged

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::createDirectoryStructure()¶

Create directory structure for the rst output.

Source:	/ApiDocBuilder.php#178
Throws:	`\JuliusHaertl\PHPDocToRst\WriteException`

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseFiles()¶

Source:	/ApiDocBuilder.php#191

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::debug($message)¶

Log a debug message.

Source:	/ApiDocBuilder.php#218
Parameters:	$message (string) Message to be logged

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::buildIndexes()¶

Source:	/ApiDocBuilder.php#225

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::setVerboseOutput($v)¶

Enable verbose logging output.

Source:	/ApiDocBuilder.php#263
Parameters:	$v (bool) Set to true to enable

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::setDebugOutput($v)¶

Enable debug logging output.

Source:	/ApiDocBuilder.php#273
Parameters:	$v (bool) Set to true to enable

public JuliusHaertl\PHPDocToRst\ApiDocBuilder::addExtension($class, $arguments=[])¶

Source:	/ApiDocBuilder.php#283
Parameters:	$class (string) name of the extension class
Throws:	`\Exception`

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseInterfaces($file)¶

Source:	/ApiDocBuilder.php#292
Parameters:	$file (`phpDocumentor\Reflection\Php\File`)

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseClasses($file)¶

Source:	/ApiDocBuilder.php#312
Parameters:	$file (`phpDocumentor\Reflection\Php\File`)

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseTraits($file)¶

Source:	/ApiDocBuilder.php#332
Parameters:	$file (`phpDocumentor\Reflection\Php\File`)

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseFunctions($file)¶

Source:	/ApiDocBuilder.php#352
Parameters:	$file (`phpDocumentor\Reflection\Php\File`)

private JuliusHaertl\PHPDocToRst\ApiDocBuilder::parseConstants($file)¶

Source:	/ApiDocBuilder.php#368
Parameters:	$file (`phpDocumentor\Reflection\Php\File`)