QA_Peardoc_Coverage

[ ] [ ] [ ]

Packages:
QA_Peardoc_Coverage

Classes:

QA_Peardoc_Coverage
QA_Peardoc_Coverage_Classlist
QA_Peardoc_Coverage_MethodList
QA_Peardoc_Coverage_Renderer_DeveloperList
QA_Peardoc_Coverage_Renderer_ExtendetPackageList
QA_Peardoc_Coverage_Renderer_MissingDocsPerDeveloper
QA_Peardoc_Coverage_Renderer_SimplePackageList

Files:

ClassList.php
Coverage.php
DeveloperList.php
displayMissing.php
ExtendetPackageList.php
genData.php
genDeveloperStats.php
genExtendetStats.php
genMissingDocsPerDeveloper.php
genSimpleStats.php
gtk2VardumpData.php
MethodList.php
MissingDocsPerDeveloper.php
Renderer.php
sendMails.php
SimplePackageList.php

Class: QA_Peardoc_Coverage_Classlist

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

Class Overview

Class and method list for a given package directory.

Author(s):

Christian Weiske <cweiske at php.net>

Version:

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

Variables

$arBadFiles

Methods

Inherited Variables

Inherited Methods

Class Details

[line 18]
Class and method list for a given package directory.

Don't list:

doc|docs directory
examples
test|tests

Author: Christian Weiske <cweiske@php.net>
Version: CVS: $Id: ClassList.php,v 1.3 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

$arBadFiles = array(
        '/tests/',
        '/test/',
        '/test.php',
        '/test_.+.php',
        '/data/',
        '/cases/',
        '/demo/',
        '/doc/',
        '/docs/',
        '/example/',
        '/examples/',
        '/Examples/',
        '/example.php',
        '/.+_example.php',
        '/.+Example.php',
        '/scripts/',

        '/buildPackage.php',
        '/compileAll.php',
        '/createPackageXml.php',
        '/generate_package_xml.php',
        '/generate_package2_xml.php',
        '/generatePackage.xml.php',
        'constants.php',
        '/makepackage.php',
        '/package.php',
        '/package_.+.php',
        '/test.+.php',
        '/updatePear.php',
        /*
        '/DBA_Relational/Toolbox.php',
        '/DB_DOM/DB_DOM.php',
        '/fix.+Files.php',
        '/Gtk_Styled/Buttons.php',
        '/HTTP_WebDAV_Client/Client.php',
        '/HTTP_WebDAV_Server/file.php',
        '/MDB_Frontend/Common.php',
        '/MDB_Frontend/Dump.php',
        '/MDB_Frontend/Frontend.php',
        '/MDB_Frontend/Login.tpl.php',
        '/MDB_Frontend/Update.php',
        '/PDBPLUS/pdbplus.php',
        '/PDBPLUS/readline.php',
        '/PEAR/PEAR.php',
        '/PEAR_Frontend_Web/WebInstaller.php',
        '/PHPDoc/front-end.php',
        '/PHPDoc/index.php',
        '/PHPDoc/prepend.php',
        '/PHP_Parser/skeleton.php',
        '/PHP_ParserGenerator/Lemon.php',
        '/PHP_ParserGenerator/parsephp.php',
        '/PhpDocumentor/phpdoc.php',
        '/SOAP_Interop/',
        '/SQL_Parser/Dialect_.+.php',
        '/SQL_Parser/ctype.php',
        '/Science_Chemistry/Chemistry.php',
        '/Services_Weather/buildMetarDB.php',
        '/Translation/translation.str_mgmt.php',
        '/XML_HTMLSax/XML_HTMLSax.php',
        '/Auth/Auth/Auth.php',
        '/DBA/DBA/Compatibility.php',
        '/DB_DataObject/DataObject/createTables.php',
        '/Forum/',
        '/HTML_AJAX/js/build.php',
        '/HTML_Page/Page/Doctypes.php',
        '/HTML_Page/Page/Namespaces.php',
        '/HTML_Page2/Page2/Doctypes.php',
        '/HTML_Page2/Page2/Namespaces.php',
        '/HTTP_SessionServer/SessionServer/SaveHandler.php',
        '/I18N/Messages/determineLanguage.inc.php',
        '/I18Nv2/.+/.+.php',
        '/Image_Graph/Graph/Config.php',
        '/Image_Graph/Graph/Constants.php',
        '/Image_Transform/Driver/.+.php',
        '/Image_Transform/imgtests/.+.php',
        '/MDB/MDB/reverse_engineer_xml_schema.php',
        '/Math_Fibonacci/Fibonacci/_fibonacciTable.php',
        '/Message/misc/.+.php',
        '/Net_GameServerQuery/GameServerQuery/Games.php',
        '/Net_SmartIRC/SmartIRC/defines.php',
        '/PEAR_Frontend_Gtk2/Gtk2/Checks.php',
        '/PHP_Compat/Compat/',
        '/PHP_CompatInfo/CompatInfo/',
        */
    )

[line 20]

Access: protected

Type:

mixed

[ Top ]

Method Detail

getClassnamesFromFilename [line 160]

array getClassnamesFromFilename(
string
$strClassFile)

Tries to find classnames in a given file

Return: Array of classnames defined in the file
Access: public

Parameters:

string $strClassFile — .php filename

[ Top ]

getFileList [line 118]

array getFileList(
string
$strPackageDir, [boolean
$bAbsolute = true])

Returns a list of .php files in the given directory and its subdirectories.

The files do not match self::$arBadFiles.

Return: Array with absolute file paths
Access: public

Parameters:

string	`$strPackageDir`	—	Directory to scan
boolean	`$bAbsolute`	—	Return absolute file paths (or relative to package dir)

[ Top ]

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