Class: QA_Peardoc_Coverage_Renderer_ExtendetPackageList

Source Location: /QA_Peardoc_Coverage-1.1.1/QA/Peardoc/Coverage/Renderer/ExtendetPackageList.php

Class Overview

Renders the coverage result in an extendet list of packages with its documented state, and the classes with their methods.

Author(s):

Christian Weiske <cweiske at php.net>

Version:

CVS: $Id: ExtendetPackageList.php,v 1.7 2007/07/18 18:52:44 cweiske Exp $

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 16]
Renders the coverage result in an extendet list of packages with its documented state, and the classes with their methods.

Author: Christian Weiske <cweiske@php.net>
Version: CVS: $Id: ExtendetPackageList.php,v 1.7 2007/07/18 18:52:44 cweiske Exp $
Link: http://pear.php.net/package/QA_Peardoc_Coverage
License: LGPL License 2.1

[ Top ]

Class Variables

$colDocumented = '#0F0'

[line 20]

Access: public

Type:

mixed

[ Top ]

$colMethodDocumented = '#9F9'

[line 22]

Access: public

Type:

mixed

[ Top ]

$colMethodNotDocumented = '#F99'

[line 23]

Access: public

Type:

mixed

[ Top ]

$colMethodPartlyDocumented = '#FF9'

[line 24]

Access: public

Type:

mixed

[ Top ]

$colNotDocumented = '#F00'

[line 19]

Access: public

Type:

mixed

[ Top ]

Method Detail

getColor [line 35]

string getColor(
float
$flNumber)

Returns the color code matching the number.

Return: HTML color #0AF
Access: public

Parameters:

float $flNumber — Number (x/y), !no! percentage

[ Top ]

getDocUrl [line 60]

string getDocUrl(
string
$strDocId)

Returns the manual url (deep link) for the given documentation id.

Return: URL to the manual
Access: public

Parameters:

string $strDocId — Documentation id=""

[ Top ]

getMethodDocState [line 168]

string getMethodDocState(

$arPackageCoverage)

Generates the class/method coverage html

Return: Class and method coverage HTML
Access: public

Parameters:

$arPackageCoverage —

[ Top ]

render [line 77]

string render(
array
$arDoc, [array
$arOptions = null])

Renders the given coverage array and returns the HTML.

Return: HTML
Access: public

Parameters:

array	`$arDoc`	—	Documentation coverage analysis results
array	`$arOptions`	—	Options

[ Top ]