Class: parserData

Source Location: /phpDocumentor/ParserData.inc

Class Overview [line 363]


Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

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)

Tags:

[ Top ]


Class Variables

$classelements = array()

[line 395]

array of parsed class elements

Type: array

Overrides:

[ Top ]

$clean =  true

[line 419]

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

Type: boolean

Overrides:

[ Top ]

$docblock =  false

[line 424]

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

Type: mixed

Overrides:

[ Top ]

$elements = array()

[line 375]

array of parsed elements

Type: array

Overrides:

[ Top ]

$links = array()

[line 411]

array of links descended from abstractLink

Tags:

Type: array

Overrides:

[ Top ]

$parent =  false

[line 370]

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

Type: false|parserPage

Overrides:

[ Top ]

$privateclasselements = array()

[line 405]

array of parsed class elements with @access private

Type: array

Overrides:

[ Top ]

$privateelements = array()

[line 390]

array of parsed elements with @access private

Type: array

Overrides:

[ Top ]

$tutorial =  false

[line 400]

Type: parserTutorial|false

Overrides:

[ Top ]

$type =  'page'

[line 438]

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

Type: string

Overrides:

[ Top ]


Class Methods

addElement

void addElement( parserElement &$element)

[line 449]

add a new element to the tracking array

Parameters:

[ Top ]

addLink

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

[line 553]

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

[ Top ]

addTutorial

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

[line 499]

adds a tutorial parser

Parameters:

[ Top ]

explicitDocBlock

bool explicitDocBlock( )

[line 532]

Tells this page that its DocBlock was not implicit

Parameters:

[ Top ]

getClasses

array getClasses( Converter &$c)

[line 633]

returns a list of all classes declared in a file

Tags:

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

Parameters:

[ Top ]

getLink

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

[line 615]

returns a link

Parameters:

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

[ Top ]

getName

string getName( )

[line 650]

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

Parameters:

[ Top ]

getTutorial

tutorialLink getTutorial( )

[line 512]

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

Parameters:

[ Top ]

hasClasses

boolean hasClasses( )

[line 486]

Does this package have classes?

Parameters:

[ Top ]

hasExplicitDocBlock

bool hasExplicitDocBlock( )

[line 522]

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

Parameters:

[ Top ]

hasInterfaces

bool hasInterfaces( )

[line 476]

Does this package have interfaces?

Parameters:

[ Top ]

isClean

bool isClean( )

[line 674]

checks if the element is "cleaned" already

Tags:

  • return - returns the value of $clean

Parameters:

[ Top ]

setDocBlock

void setDocBlock( parserDocBlock &$docblock)

[line 687]

sets the docblock

Tags:

Parameters:

[ Top ]

setParent

void setParent( parserPage &$parent)

[line 664]

sets the parent

Parameters:

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

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:13 -0600 by phpDocumentor 1.4.4