Documentation

Markdown extends Generator
in package

Table of Contents

Properties

$docFiles  : array<string|int, string>
XML documentation files used to produce the final output.
$ruleset  : Ruleset
The ruleset used for the run.

Methods

__construct()  : mixed
Constructs a doc generator.
generate()  : void
Generates the documentation for a standard.
getFormattedCodeComparisonBlock()  : string
Format a code comparison block found in a standard.
getFormattedFooter()  : string
Format the markdown footer.
getFormattedHeader()  : string
Format the markdown header.
getFormattedTextBlock()  : string
Format a text block found in a standard.
getTitle()  : string
Retrieves the title of the sniff from the DOMElement supplied.
processSniff()  : void
Process the documentation for a single sniff.
formatCodeSample()  : string
Retrieve a code block contents and prepare it for output as HTML.
formatCodeTitle()  : string
Retrieve a code block title and prepare it for output as HTML.

Properties

$docFiles

XML documentation files used to produce the final output.

public array<string|int, string> $docFiles = []

Methods

__construct()

Constructs a doc generator.

public __construct(Ruleset $ruleset) : mixed
Parameters
$ruleset : Ruleset

The ruleset used for the run.

Tags
see
generate()

generate()

Generates the documentation for a standard.

public generate() : void
Tags
see
processSniff()
throws
GeneratorException

If there is no element in the XML document.

getFormattedCodeComparisonBlock()

Format a code comparison block found in a standard.

protected getFormattedCodeComparisonBlock(DOMElement $node) : string
Parameters
$node : DOMElement

The DOMElement object for the code comparison block.

Tags
since
3.12.0

Replaces the Markdown::printCodeComparisonBlock() method, which was deprecated in 3.12.0 and removed in 4.0.0.

Return values
string

getFormattedFooter()

Format the markdown footer.

protected getFormattedFooter() : string
Tags
since
3.12.0

Replaces the Markdown::printFooter() method, which was deprecated in 3.12.0 and removed in 4.0.0.

Return values
string

getFormattedHeader()

Format the markdown header.

protected getFormattedHeader() : string
Tags
since
3.12.0

Replaces the Markdown::printHeader() method, which was deprecated in 3.12.0 and removed in 4.0.0.

Return values
string

getFormattedTextBlock()

Format a text block found in a standard.

protected getFormattedTextBlock(DOMElement $node) : string
Parameters
$node : DOMElement

The DOMElement object for the text block.

Tags
since
3.12.0

Replaces the Markdown::printTextBlock() method, which was deprecated in 3.12.0 and removed in 4.0.0.

Return values
string

getTitle()

Retrieves the title of the sniff from the DOMElement supplied.

protected getTitle(DOMElement $doc) : string
Parameters
$doc : DOMElement

The DOMElement object for the sniff. It represents the "documentation" tag in the XML standard file.

Return values
string

processSniff()

Process the documentation for a single sniff.

protected processSniff(DOMElement $doc) : void
Parameters
$doc : DOMElement

The DOMElement object for the sniff. It represents the "documentation" tag in the XML standard file.

formatCodeSample()

Retrieve a code block contents and prepare it for output as HTML.

private formatCodeSample(DOMElement $codeElm) : string
Parameters
$codeElm : DOMElement

The DOMElement object for a code block.

Tags
since
3.12.0
Return values
string

formatCodeTitle()

Retrieve a code block title and prepare it for output as HTML.

private formatCodeTitle(DOMElement $codeElm) : string
Parameters
$codeElm : DOMElement

The DOMElement object for a code block.

Tags
since
3.12.0
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results