Class parserData

(line 363)


Located in File: /phpDocumentor/

Contains an in-memory representation of all documentable elements (parserPage, parserFunction, parserDefine, parserInclude, parserClass, parserMethod, parserVar) and their DocBlocks (parserDocBlock).

This class works in coordination with phpDocumentor_IntermediateParser to take output from Parser::handleEvent() and create indexes, links, and other assorted things (all documented in phpDocumentor_IntermediateParser and Converter)

Class Variables

boolean $clean
mixed $docblock
array $elements
array $links
string $type

$classelements = array() (line 395)

Data type : array

array of parsed class elements

$clean = true (line 419)

Data type : boolean

used by phpDocumentor_IntermediateParser::handleDocBlock() to

determine whether a docblock is a page-level docblock or not. $clean is true as long as only 0 or 1 docblock has been parsed, and no element other than parserPage has been parsed

$docblock = false (line 424)

Data type : mixed

DocBlock (parserDocBlock) for this page, or false if not set

$elements = array() (line 375)

Data type : array

array of parsed elements

$links = array() (line 411)

Data type : array

array of links descended from abstractLink

$parent = false (line 370)

Data type : false|parserPage

parserPage element that is this parserData's parent, or false if not set.

$privateclasselements = array() (line 405)

Data type : array

array of parsed class elements with @access private

$privateelements = array() (line 390)

Data type : array

array of parsed elements with @access private

$tutorial = false (line 400)

Data type : parserTutorial|false

$type = 'page' (line 438)

Data type : string

Type is used by many functions to skip the hassle of if

  1. phpDocumentor_get_class($blah== 'parserBlah'
always 'page', used in element indexing and conversion functions found in Converter

Class Constants


Method Detail

void addElement (parserElement &$element)
string addLink (parserElement &$element, [string $classorpackage = ''], [string $subpackage = ''])
array getClasses (Converter &$c)
string &getLink (Converter &$c, [bool $text = false])
string getName ()
boolean hasClasses ()
bool hasInterfaces ()
bool isClean ()
void setDocBlock (parserDocBlock &$docblock)
void setParent (parserPage &$parent)

Method addElement (line 449)

void addElement( parserElement &$element)

add a new element to the tracking array



Method addLink (line 553)

string addLink( parserElement &$element, [string $classorpackage = ''], [string $subpackage = ''])

adds a link


  • parserElement &$element: element to add a new link (descended from abstractLink) to the $links array
  • string $classorpackage: classname for elements that are class-based (this may be deprecated in the future, as the classname should be contained within the element. if $element is a page, this parameter is a package name
  • string $subpackage: subpackage name for page elements


Method addTutorial (line 499)

void addTutorial( parserTutorial $t, Converter &$c)

adds a tutorial parser



Method explicitDocBlock (line 532)

bool explicitDocBlock( )

Tells this page that its DocBlock was not implicit


Method getClasses (line 633)

array getClasses( Converter &$c)

returns a list of all classes declared in a file



  • return - Format: array( packagename => parserClass, packagename => parserClass, ... )

Method getLink (line 615)

string &getLink( Converter &$c, [bool $text = false])

returns a link


  • Converter &$c: the output converter
  • bool $text: a text flag


Method getName (line 650)

string getName( )

Get the output-safe filename (. changed to _)


Method getTutorial (line 512)

tutorialLink getTutorial( )

If this file has a tutorial associated with it, returns a link to the tutorial.


Method hasClasses (line 486)

boolean hasClasses( )

Does this package have classes?


Method hasExplicitDocBlock (line 522)

bool hasExplicitDocBlock( )

If the page-level DocBlock was present in the source, returns true


Method hasInterfaces (line 476)

bool hasInterfaces( )

Does this package have interfaces?


Method isClean (line 674)

bool isClean( )

checks if the element is "cleaned" already


  • return - returns the value of $clean

Method setDocBlock (line 687)

void setDocBlock( parserDocBlock &$docblock)

sets the docblock



Method setParent (line 664)

void setParent( parserPage &$parent)

sets the parent


  • parserPage &$parent: parent element of this parsed data


Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary

Documentation generated on Mon, 05 Dec 2011 21:28:37 -0600 by phpDocumentor 1.4.4