QA_Peardoc_Coverage
[ class tree: QA_Peardoc_Coverage ] [ index: QA_Peardoc_Coverage ] [ all elements ]

Class: QA_Peardoc_Coverage_Renderer_DeveloperList

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

Class Overview


Renders a list with developers, the number of packages they maintain and the documented/undocumented ratio


Author(s):

Version:

  • CVS: $Id: DeveloperList.php,v 1.10 2007/07/18 18:52:44 cweiske Exp $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 15]
Renders a list with developers, the number of packages they maintain and the documented/undocumented ratio


[ Top ]


Class Variables

$arLevels = array(
        100 => 'Well done',
         90 => 'Not bad',
         60 => 'Should be better',
         30 => 'Shame on you'
    )

[line 20]

  • Access: public

Type:   mixed


[ Top ]

$colDocumented =  '#0F0'

[line 19]

  • Access: public

Type:   mixed


[ Top ]

$colNotDocumented =  '#F00'

[line 18]

  • Access: public

Type:   mixed


[ Top ]



Method Detail

compareMaintainers   [line 324]

int compareMaintainers( array $m1, array $m2)

Compares two maintainer arrays for sorting
  • Return: -1,0,1 depending on sort results
  • Access: public

Parameters:

array   $m1     Maintainer 1
array   $m2     Maintainer 2

[ Top ]

getColor   [line 36]

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 ]

getMaintainers   [line 180]

array getMaintainers( array $arDoc)

Returns an array of package maintainer usernames, their email address, real name and the packages maintained by them. Also lists which packages are not docced, and which are.
  • Return: Array with the following data: [username] => array( [name] => Real name [email] => Email address [docced] => # of documented packages [packages] => # of packages at all [packagelist] => array with package names (key) value is reference to doc array )
  • Access: public

Parameters:

array   $arDoc     Array as passed to render() method.

[ Top ]

getPackageMaintainers   [line 237]

array getPackageMaintainers( string $strPackageXmlPath)

Reads the package maintainers from a package.xml (v1 and v2) file.
  • Return: Array with maintainers of following structure: [username] => array( [name] => Real name [email] => Email address )
  • Access: public

Parameters:

string   $strPackageXmlPath     Path to a package.xml file

[ Top ]

render   [line 62]

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 ]


Documentation generated on Sat, 27 Oct 2007 11:00:11 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.