Documentation

CodeFormatter
in package
implements Formatter

A pretty-printer for code.

Interfaces, Classes and Traits

Formatter
Formatter interface.

Table of Contents

format()  : string
Format the code represented by $reflector.
isReflectable()  : bool
Check whether a Reflector instance is reflectable by this formatter.

Methods

format()

Format the code represented by $reflector.

public static format(Reflector $reflector[, null|string $colorMode = null ]) : string
Parameters
$reflector : Reflector
$colorMode : null|string = null

(default: null)

Return values
string

formatted code

isReflectable()

Check whether a Reflector instance is reflectable by this formatter.

private static isReflectable(Reflector $reflector) : bool
Parameters
$reflector : Reflector
Return values
bool

Search results