Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/parser/PhpdocClassParser.php
PEAR Repository - PHPDoc

PhpdocClassParser

PhpdocObject
   |
  +-- PhpdocParserRegExp
     |
    +-- PhpdocParserTags
       |
      +-- PhpdocParserCore
         |
        +-- PhpdocUseParser
           |
          +-- PhpdocConstantParser
             |
            +-- PhpdocModuleParser
               |
              +-- PhpdocVariableParser
                 |
                +-- PhpdocFunctionParser
                   |
                  +-- PhpdocClassParser

Parses phpcode to extract classes and their documentation.

 

private class PhpdocClassParser extends PhpdocFunctionParser

Parses phpcode to extract classes and their documentation.

Authors,
Version0.2

 
Direct known subclasses: PhpdocParser

Methods inherited from PhpdocFunctionParser

analysefunction, getfunctionargs

Methods inherited from PhpdocVariableParser

analysevariable, checkvardocs

Methods inherited from PhpdocModuleParser

analysemodule, analysemoduledoc

Methods inherited from PhpdocConstantParser

checkconstantdoc, analyseconstant

Methods inherited from PhpdocUseParser

analyseuse

Methods inherited from PhpdocParserCore

getphpdocparagraphs, getmodulesandclasses, getmoduledoc, getclasses, extractphpdoc, getdescription, getvalue, getvariabletypeandvalue

Methods inherited from PhpdocParserTags

analysetags, analyseseetagregs, gettags, gettagpos, checkparsererrors

Methods inherited from PhpdocParserRegExp

buildcomplexregexps

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary

void

analyseClass( $para)

Analyse a class
void

analyseClassDoc(array $para)

Analyses a class doc comment.

Fields inherited from PhpdocFunctionParser

$emptyfunction, $functiontags

Fields inherited from PhpdocVariableParser

$emptyvariable, $variabletags

Fields inherited from PhpdocModuleParser

$emptymodule, $moduletags, $modulegroups

Fields inherited from PhpdocConstantParser

$emptyconstant, $constanttags

Fields inherited from PhpdocUseParser

$emptyuse, $usetags

Fields inherited from PhpdocParserRegExp

$phpdoc_tags, $c_base, $c_complex, $php_base, $php_complex, $tags

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$classes

Array of all classes in the given code
array

$emptyClass

Default values of a class
array

$classTags

Array of tags that are allowed in front of the class keyword

Private Method Details

analyseClass

private void analyseClass( $para )

  Analyse a class

Calls all neccessary analyse functions.

Parameter
$para
Returns void


analyseClassDoc

private void analyseClassDoc( array $para )

  Analyses a class doc comment.

Parameter
array $para
Hash returned by getPhpdocParagraph()
Returns void


Private Field Details

$classes

private array $classes

>>array()<<

See Also e::e

$emptyClass

private array $emptyClass

>>array ( "name" => "", "extends" => "", "undoc" => true )<<

See Also c::c, a::a

$classTags

private array $classTags

>>array( "access" => true, "abstract" => true, "static" => true, "final" => true, "see" => true, "link" => true, "author" => true, "copyright" => true, "version" => true, "since" => true, "deprecated" => true, "deprec" => true, "brother" => true, "sister" => true, "exclude" => true, "package" => true, "magic" => true, "todo" => true )<<

See Also analyseClassParagraph()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta