Class: parserData

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserData.inc

Class Overview

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

Author(s):

Gregory Beaver <cellog at php.net>

Version:

Release: 1.5.0a1

Copyright:

2002-2008 Gregory Beaver

Inherited Variables

Inherited Methods

Class Details

[line 363]
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)

Author: Gregory Beaver <cellog@php.net>
Version: Release: 1.5.0a1
Copyright: 2002-2008 Gregory Beaver
Link: http://pear.php.net/PhpDocumentor
Link: http://www.phpdoc.org
Todo: CS cleanup - change package to PhpDocumentor
Since: 1.0rc1
License: LGPL

[ Top ]

Class Variables

$classelements = array()

[line 395]

array of parsed class elements

Type:

array

[ 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

[ Top ]

$docblock = false

[line 424]

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

Type:

mixed

[ Top ]

$elements = array()

[line 375]

array of parsed elements

Type:

array

[ Top ]

$links = array()

[line 411]

array of links descended from abstractLink

See: pageLink, defineLink, classLink, functionLink, methodLink, varLink

Type:

array

[ Top ]

$parent = false

[line 370]

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

Type:

false|parserPage

[ Top ]

$privateclasselements = array()

[line 405]

array of parsed class elements with @access private

Type:

array

[ Top ]

$privateelements = array()

[line 390]

array of parsed elements with @access private

Type:

array

[ Top ]

$tutorial = false

[line 400]

Type:

parserTutorial|false

[ Top ]

$type = 'page'

[line 438]

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

phpDocumentor_get_class($blah) == 'parserBlah'

always 'page', used in element indexing and conversion functions found in Converter

Type:

string

[ Top ]

Method Detail

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

[ Top ]

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

[ Top ]

addTutorial [line 499]

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

adds a tutorial parser

Parameters:

parserTutorial	`$t`	—	a tutorial parser
Converter	`&$c`	—	the output converter

[ Top ]

explicitDocBlock [line 532]

bool explicitDocBlock(
)

Tells this page that its DocBlock was not implicit

[ Top ]

getClasses [line 633]

array getClasses(
Converter
&$c)

returns a list of all classes declared in a file

Return: Format: array( packagename => parserClass, packagename => parserClass, ... )

Parameters:

Converter &$c — output converter

[ Top ]

getLink [line 615]

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

returns a link

Parameters:

Converter	`&$c`	—	the output converter
bool	`$text`	—	a text flag

[ Top ]

getName [line 650]

string getName(
)

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

[ Top ]

getTutorial [line 512]

tutorialLink getTutorial(
)

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

[ Top ]

hasClasses [line 486]

boolean hasClasses(
)

Does this package have classes?

[ Top ]

hasExplicitDocBlock [line 522]

bool hasExplicitDocBlock(
)

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

[ Top ]

hasInterfaces [line 476]

bool hasInterfaces(
)

Does this package have interfaces?

[ Top ]

isClean [line 674]

bool isClean(
)

checks if the element is "cleaned" already

Return: returns the value of $clean

[ Top ]

setDocBlock [line 687]

void setDocBlock(
parserDocBlock
&$docblock)

sets the docblock

See: parserDocBlock

Parameters:

parserDocBlock &$docblock — docblock element

[ Top ]

setParent [line 664]

void setParent(
parserPage
&$parent)

sets the parent

Parameters:

parserPage &$parent — parent element of this parsed data

[ Top ]