Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/accessor/PhpdocWarningAccessor.php
PEAR Repository - PHPDoc

PhpdocWarningAccessor

PhpdocObject
   |
  +-- PhpdocAccessor
     |
    +-- PhpdocWarningAccessor

Extracts the warnings from PHPDoc warnings_* files.

 

private class PhpdocWarningAccessor extends PhpdocAccessor

Extracts the warnings from PHPDoc warnings_* files.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 

Methods inherited from PhpdocAccessor

loadxmlfile

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

getWarnings(string $xmlfile)

Returns a hash of warnings in of the given XML file.

Private Method Summary

void

buildWarnings(string $xmlfile)

Build the internal list of warnings.
void

init()

Reformats the xml result array from the PhpdocXMLReader.

Fields inherited from PhpdocAccessor

$xmlreader, $xml, $data

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Public Field Summary

boolean

$freeOnGet

If set to true all get_xy() functions will free their resources.

Private Field Summary

array

$warnings

Array of warnings.
boolean

$flag_build

Flag used to detect if get_xy() was called.s

Public Method Details

getWarnings

public void getWarnings( string $xmlfile )

  Returns a hash of warnings in of the given XML file.

Parameter
string $xmlfile
XML file
Returns void

See Also $freeOnGet

Private Method Details

buildWarnings

private void buildWarnings( string $xmlfile )

  Build the internal list of warnings.

Parameter
string $xmlfile
XML file to load
Returns void


init

private void init( )

  Reformats the xml result array from the PhpdocXMLReader.

Every derived class must override this function to call the functions
it needs to reorganize the data from the PhpdocXMLReader in a
way that it needs.

Returns void

See Also $xml, $data

Public Field Details

$freeOnGet

public boolean $freeOnGet

>>true<<


Private Field Details

$warnings

private array $warnings

>>array()<<


$flag_build

private boolean $flag_build

>>false<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta