Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: c:/www/apache/doc2//parser/PhpdocClassParser.php
PHPDOC 2000/12/03 - 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.

AuthorsUlf Wendel <ulf.wendel@redsys.de>
Version$Id: $

 
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

analyseconstant, checkconstantdoc

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

array

analyseClass(array $para)

Analyse a class
array

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, $application, $warn, $flag_output

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 array analyseClass( array $para )

  Analyse a class
Calls all neccessary analyse functions.

Parameter
array $para
Returns array


analyseClassDoc

private array analyseClassDoc( array $para )

  Analyses a class doc comment.

Parameter
array $para
returned by getPhpdocParagraph()
Returns array


Private Field Details

$classes

private array $classes

>>array()<<

Array of all classes in the given code
The array is indexed by the classname.See $emptyClass to see the internal structure.

See Also $emptyClass

$emptyClass

private array $emptyClass

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

Default values of a class


$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 )<<

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



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta