Docs For Class PHP_CodeSniffer_DocGenerators

Class: PHP_CodeSniffer_DocGenerators_Generator

Class Overview

The base class for all PHP_CodeSniffer documentation generators.

Author(s):

Marc McIntyre <mmcintyre at squiz.net>
Greg Sherwood <gsherwood at squiz.net>

Version:

Release: 2.7.1

Copyright:

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

Child classes:

PHP_CodeSniffer_DocGenerators_Markdown: A doc generator that outputs documentation in Markdown format.

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

PHP_CodeSniffer_DocGenerators_Text: A doc generator that outputs text-based documentation.

Inherited Variables

Inherited Methods

Class Details

[line 31]
The base class for all PHP_CodeSniffer documentation generators.

Documentation generators are used to print documentation about code sniffs in a standard.

Author: Marc McIntyre <mmcintyre@squiz.net>
Author: Greg Sherwood <gsherwood@squiz.net>
Version: Release: 2.7.1
Copyright: 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Link: http://pear.php.net/package/PHP_CodeSniffer
Abstract:
License: BSD Licence

Method Detail

__construct (Constructor) [line 62]

PHP_CodeSniffer_DocGenerators_Generator __construct(
string
$standard, [array
$sniffs = array()])

Constructs a PHP_CodeSniffer_DocGenerators_Generator object.

See: PHP_CodeSniffer_DocGenerators_Generator::generate()
Access: public

Parameters:

string	`$standard`	—	The name of the coding standard to generate docs for.
array	`$sniffs`	—	An array of sniffs that we are limiting the generated docs to.

[ Top ]

generate [line 108]

void generate(
)

Generates the documentation for a standard.

It's probably wise for doc generators to override this method so they have control over how the docs are produced. Otherwise, the processSniff method should be overridden to output content for each sniff.

See: PHP_CodeSniffer_DocGenerators_Generator::processSniff()
Access: public

Overridden in child classes as:

PHP_CodeSniffer_DocGenerators_Markdown::generate(): Generates the documentation for a standard.

PHP_CodeSniffer_DocGenerators_HTML::generate(): Generates the documentation for a standard.

[ Top ]

getStandard [line 91]

string getStandard(
)

Retrieves the name of the standard we are generating docs for.

Access: protected

[ Top ]

getStandardFiles [line 132]

string[] getStandardFiles(
)

Returns a list of paths to XML standard files for all sniffs in a standard.

Any sniffs that do not have an XML standard file are obviously not included in the returned array. If documentation is only being generated for some sniffs (ie. $this->_sniffs is not empty) then all others sniffs will be filtered from the results as well.

Access: protected

[ Top ]

getTitle [line 79]

string getTitle(
DOMNode
$doc)

Retrieves the title of the sniff from the DOMNode supplied.

Access: protected

Parameters:

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

[ Top ]

processSniff [line 181]

void processSniff(
DOMNode
$doc)

Process the documentation for a single sniff.

Doc generators must implement this function to produce output.

See: PHP_CodeSniffer_DocGenerators_Generator::generate()
Abstract:
Access: protected

Overridden in child classes as:

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

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

PHP_CodeSniffer_DocGenerators_Text::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.

[ Top ]