Class: HTML

Source Location: /PHP_CodeSniffer-3.1.1/src/Generators/HTML.php

Class Overview

Generator
   |
   --HTML

A doc generator that outputs documentation in one big HTML file.

Author(s):

Greg Sherwood <gsherwood at squiz.net>

Copyright:

2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Class: Generator

Generator::$docFiles
Generator::$ruleset

Inherited Methods

Class: Generator

Generator::__construct(): Constructs a doc generator.
current ( )
Generator::generate(): Generates the documentation for a standard.
Generator::getTitle(): Retrieves the title of the sniff from the DOMNode supplied.
key ( )
next ( )
Generator::processSniff(): Process the documentation for a single sniff.
rewind ( )
send ( $value )
throw ( $exception )
valid ( )
__wakeup ( )

Class Details

[line 18]
A doc generator that outputs documentation in one big HTML file.

Output is in one large HTML file and is designed for you to style with your own stylesheet. It contains a table of contents at the top with anchors to each sniff.

Author: Greg Sherwood <gsherwood@squiz.net>
Copyright: 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
License: BSD Licence

[ Top ]

Method Detail

generate [line 28]

void generate(
)

Generates the documentation for a standard.

See: processSniff()
Access: public

Overrides Generator::generate() (Generates the documentation for a standard.)

[ Top ]

printCodeComparisonBlock [line 236]

void printCodeComparisonBlock(
DOMNode
\$node, \DOMNode
$node)

Print a code comparison block found in a standard.

Access: protected

Parameters:

\DOMNode	`$node`	—	The DOMNode object for the code comparison block.
DOMNode	`\$node`	—

[ Top ]

printFooter [line 165]

void printFooter(
)

Print the footer of the HTML page.

Access: protected

[ Top ]

printHeader [line 56]

void printHeader(
)

Print the header of the HTML page.

Access: protected

[ Top ]

printTextBlock [line 215]

void printTextBlock(
DOMNode
\$node, \DOMNode
$node)

Print a text block found in a standard.

Access: protected

Parameters:

\DOMNode	`$node`	—	The DOMNode object for the text block.
DOMNode	`\$node`	—

[ Top ]

printToc [line 142]

void printToc(
)

Print the table of contents for the standard.

The TOC is just an unordered list of bookmarks to sniffs on the page.

Access: protected

[ Top ]

processSniff [line 191]

void processSniff(
DOMNode
\$doc, \DOMNode
$doc)

Process the documentation for a single sniff.

Access: public

Overrides Generator::processSniff() (Process the documentation for a single sniff.)

Parameters:

\DOMNode	`$doc`	—	The DOMNode object for the sniff. It represents the "documentation" tag in the XML standard file.
DOMNode	`\$doc`	—

[ Top ]