DocTracer Documentation

namespace Mdz

class DocTracer

Analyze PHP class and docBlock to generate API Documentation.

DocTracer helps you to create meaningful API documentation reports. Reflecting PHP class information and show markdown formatted documentation on one page.

How to use:

$tracer = new \Mdz\DocTracer($baseDir);
$tracer->inspect($targetDir);
echo $tracer->render();

@link

@link DocTracer

@author

@author Mudzakkir me@mdzstack.com

@copyright

@license

@license https://opensource.org/licenses/MIT

public const VERSION = '1.0.2';

@var

string

protected $baseDir = '';

Base directory path.

@var

string

protected $data = [];

Holds all reports data.

@var

array

public __construct ( string $baseDir = './', )

@param

string

$baseDir

public inspect ( string $targetDir, array $exclude = [], ): Mdz\DocTracer

Find, check and parse all PHP files.

PHP ReflectionClass require autoloader or class must exist.

@param	string	$targetDir	Directory to check
@param	array	$exclude	Exclude directory

@return

\Mdz\DocTracer

public getResults ( ): array

Return reports information.

@return

array

protected phpFinder ( string $path, array $exclude = [], ): Iterator

Find PHP files inside directory recursively.

@param	string	$path
@param	array	$exclude

@return

\Iterator

of \SplFileInfo

protected parseNamespace ( string $content, ): string

Get fully qualified namespace from content.

@param

string

$content

@return

string

Fully qualified namespace

protected getConstants ( ReflectionClass $refClass, string $fqnClass, ): array

Get class constants information.

@param	\ReflectionClass	$refClass
@param	string	$fqnClass

@return

array

protected getProperties ( ReflectionClass $refClass, string $fqnClass, ): array

Get class properties information.

@param	\ReflectionClass	$refClass
@param	string	$fqnClass

@return

array

protected getMethods ( ReflectionClass $refClass, string $fqnClass, ): array

Get class methods information.

@param	\ReflectionClass	$refClass
@param	string	$fqnClass

@return

array

protected getMethodParams ( ReflectionMethod $refMethod, ): array

Get method parameters information.

@param

\ReflectionMethod

$refMethod

@return

array

protected getTypeHint ( ReflectionType $refType, ): string

Get the type hint

@param

\ReflectionType

$refType

@return

string

protected getValueType ( $value, )

Check the type of reflection $value to printable value.

Word "n/a" to differentiate between the assigned default value "null" and the null returned by reflection when a default value is not assigned.

@param

mixed|null

$value

@return

string|int

protected parseDocBlock ( Reflector $ref, ): array

Get DocBLock informations.

@param

\Reflector

$ref

Has the getDocComment() method

@return

array

public render ( array $params = [], ): string

Render in HTML page.

Available setting:

title Page heading (h1) and meta title
tagline Page heading tagline
footer Footer information. Default: {title} - {tagline}
theme Report theme. Options: default, darkmoon
css Customize the report style
template Custom template path

@param

array

$setting

@return

string

protected formatDocBlock ( array $docBlock, ): string

Standarize the documentation HTML format.

The class, constant, property and method share the same HTML output.

@param

array

$docBlock

@return

string

protected markdown ( string $content, ): string

Pretify documentation with Markdown.

@link	@link Markdown basic
@link	@link Markdown extra

@param

string

$content

@return

string

protected wordBreak ( string $content, ): string

Break part namespace and types with  zero-width space.

@param

string

$content

@return

string

DocTracer PHP ReflectionClass and API Documentation Generator