Class: parserData

Source Location: /phpDocumentor/ParserData.inc

Class parserData

Class Overview

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)

Located in /phpDocumentor/ParserData.inc [line 287]

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserData.inc,v 1.6 2006/10/23 04:02:46 cellog Exp $
Since:	1.0rc1

Properties

Methods

[ Top ]

Property Summary

array	$classelements	array of parsed class elements
boolean	$clean	used by phpDocumentor_IntermediateParser::handleDocBlock() to
mixed	$docblock	DocBlock (parserDocBlock) for this page, or false if not set
array	$elements	array of parsed elements
array	$links	array of links descended from abstractLink
false\|parserPage	$parent	parserPage element that is this parserData's parent, or false if not set.
array	$privateclasselements	array of parsed class elements with @access private
array	$privateelements	array of parsed elements with @access private
parserTutorial\|false	$tutorial
string	$type	Type is used by many functions to skip the hassle of if

[ Top ]

Method Summary

void	addElement()
void	addLink()
void	addTutorial()
void	explicitDocBlock()	Tells this page that its DocBlock was not implicit
array	getClasses()	returns a list of all classes declared in a file
void	&getLink()
string	getName()	Get the output-safe filename (. changed to _)
tutorialLink	getTutorial()	If this file has a tutorial associated with it, returns a link to the tutorial.
boolean	hasClasses()	Does this package have classes?
boolean	hasExplicitDocBlock()	If the page-level DocBlock was present in the source, returns true
boolean	hasInterfaces()	Does this package have interfaces?
bool	isClean()
void	setDocBlock()
void	setParent()

[ Top ]

Properties

array $classelements = array() [line 319]

array of parsed class elements

[ Top ]

boolean $clean = true [line 343]

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

[ Top ]

mixed $docblock = false [line 348]

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

[ Top ]

array $elements = array() [line 299]

array of parsed elements

[ Top ]

array $links = array() [line 335]

array of links descended from abstractLink

API Tags:

See:

pageLink, defineLink, classLink, functionLink, methodLink, varLink

[ Top ]

false|parserPage $parent = false [line 294]

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

[ Top ]

array $privateclasselements = array() [line 329]

array of parsed class elements with @access private

[ Top ]

array $privateelements = array() [line 314]

array of parsed elements with @access private

[ Top ]

parserTutorial|false $tutorial = false [line 324]

[ Top ]

string $type = 'page' [line 362]

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

[ Top ]

Methods

addElement [line 368]

void addElement(
parserElement
&$element 
)

Parameters:

parserElement

&$element:

add a parsed element to the $elements array, also sets $clean to false

[ Top ]

addLink [line 455]

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

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 413]

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

Parameters:

parserTutorial	$t:
Converter	&$c:

[ Top ]

explicitDocBlock [line 441]

void explicitDocBlock(
)

Tells this page that its DocBlock was not implicit

[ Top ]

getClasses [line 509]

array getClasses(
Converter
&$c 
)

returns a list of all classes declared in a file

Parameters:

Converter

&$c:

API Tags:

Return:

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

[ Top ]

getLink [line 498]

void &getLink(

&$c, [
$text = false] 
)

Parameters:

	&$c:
	$text:

[ Top ]

getName [line 525]

string getName(
)

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

[ Top ]

getTutorial [line 424]

tutorialLink getTutorial(
)

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

[ Top ]

hasClasses [line 404]

boolean hasClasses(
)

Does this package have classes?

[ Top ]

hasExplicitDocBlock [line 433]

boolean hasExplicitDocBlock(
)

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

[ Top ]

hasInterfaces [line 394]

boolean hasInterfaces(
)

Does this package have interfaces?

[ Top ]

isClean [line 542]

bool isClean(
)

API Tags:

Return:

returns the value of $clean

[ Top ]

setDocBlock [line 551]

void setDocBlock(
parserDocBlock
&$docblock 
)

Parameters:

parserDocBlock

&$docblock:

API Tags:

See:

parserDocBlock

[ Top ]

setParent [line 534]

void setParent(
parserPage
&$parent 
)

Parameters:

parserPage

&$parent:

parent element of this parsed data

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:24:44 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserData

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]