HTML
extends Generator
in package
Table of Contents
- $docFiles : array<string|int, string>
- XML documentation files used to produce the final output.
- $ruleset : Ruleset
- The ruleset used for the run.
- __construct() : mixed
- Constructs a doc generator.
- generate() : void
- Generates the documentation for a standard.
- processSniff() : void
- Process the documentation for a single sniff.
- getTitle() : string
- Retrieves the title of the sniff from the DOMNode supplied.
- printCodeComparisonBlock() : void
- Print a code comparison block found in a standard.
- printFooter() : void
- Print the footer of the HTML page.
- printHeader() : void
- Print the header of the HTML page.
- printTextBlock() : void
- Print a text block found in a standard.
- printToc() : void
- Print the table of contents for the standard.
Properties
$docFiles
XML documentation files used to produce the final output.
public
array<string|int, string>
$docFiles
= []
$ruleset
The ruleset used for the run.
public
Ruleset
$ruleset
= null
Methods
__construct()
Constructs a doc generator.
public
__construct(Ruleset $ruleset) : mixed
Parameters
- $ruleset : Ruleset
-
The ruleset used for the run.
Tags
Return values
mixed —generate()
Generates the documentation for a standard.
public
generate() : void
Tags
Return values
void —processSniff()
Process the documentation for a single sniff.
public
processSniff(DOMNode $doc) : void
Parameters
- $doc : DOMNode
-
The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
Return values
void —getTitle()
Retrieves the title of the sniff from the DOMNode supplied.
protected
getTitle(DOMNode $doc) : string
Parameters
- $doc : DOMNode
-
The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
Return values
string —printCodeComparisonBlock()
Print a code comparison block found in a standard.
protected
printCodeComparisonBlock(DOMNode $node) : void
Parameters
- $node : DOMNode
-
The DOMNode object for the code comparison block.
Return values
void —printFooter()
Print the footer of the HTML page.
protected
printFooter() : void
Return values
void —printHeader()
Print the header of the HTML page.
protected
printHeader() : void
Return values
void —printTextBlock()
Print a text block found in a standard.
protected
printTextBlock(DOMNode $node) : void
Parameters
- $node : DOMNode
-
The DOMNode object for the text block.
Return values
void —printToc()
Print the table of contents for the standard.
protected
printToc() : void
The TOC is just an unordered list of bookmarks to sniffs on the page.