$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

$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

• see: - pageLink, defineLink, classLink, functionLink, methodLink, varLink

$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

Method addElement (line 449)

void addElement( parserElement &$element)

add a new element to the tracking array

Parameters

• parserElement &$element: add a parsed element to the $elements array, also sets $clean to false

Info

Method addLink (line 553)

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

adds a link

Parameters

• 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

Info

Method addTutorial (line 499)

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

adds a tutorial parser

Parameters

• parserTutorial $t: a tutorial parser
• Converter &$c: the output converter

Info

Method explicitDocBlock (line 532)

bool explicitDocBlock( )

Tells this page that its DocBlock was not implicit

Info

Method getClasses (line 633)

array getClasses( Converter &$c)

returns a list of all classes declared in a file

Parameters

• Converter &$c: output converter

Info

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

Method getLink (line 615)

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

returns a link

Parameters

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

Info

Method getName (line 650)

string getName( )

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

Info

Method getTutorial (line 512)

tutorialLink getTutorial( )

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

Info

Method hasClasses (line 486)

boolean hasClasses( )

Does this package have classes?

Info

Method hasExplicitDocBlock (line 522)

bool hasExplicitDocBlock( )

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

Info

Method hasInterfaces (line 476)

bool hasInterfaces( )

Does this package have interfaces?

Info

Method isClean (line 674)

bool isClean( )

checks if the element is "cleaned" already

Info

• return - returns the value of $clean

Method setDocBlock (line 687)

void setDocBlock( parserDocBlock &$docblock)

sets the docblock

Parameters

• parserDocBlock &$docblock: docblock element

Info

• see - parserDocBlock

Method setParent (line 664)

void setParent( parserPage &$parent)

sets the parent

Parameters

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

Info