Class: phpDocumentor_IntermediateParser

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

Class Overview

The phpDocumentor_IntermediateParser Class

Author(s):

Gregory Beaver

Version:

$Id$

Copyright:

2002 Gregory Beaver

Inherited Variables

Inherited Methods

Class Details

[line 60]
The phpDocumentor_IntermediateParser Class

This class performs the work of organizing raw data from the parser in the format of descendants of the parserElement class. This is also where processing of package pages occurs, in phpDocumentor_IntermediateParser::handleClass() for class-level packages and phpDocumentor_IntermediateParser::handleDocBlock() for page-level packages.

Most of the work of this parser goes to matching up DocBlocks with the elements that they are documenting. Since DocBlocks are passed before the element they document, the last DocBlock is stored in phpDocumentor_IntermediateParser::$last and then placed into the $docblock parameter of the parserElement descendant object.

Author: Gregory Beaver
Version: $Id$
Copyright: 2002 Gregory Beaver

[ Top ]

Class Variables

$all_packages = array()

[line 186]

list of all packages encountered while documenting. Used in automatic linking.

Converter::getLink() first checks if an ambiguous link is found in the current package. If not, it then checks in parent packages, and if still not found, uses this array to check in the rest of the packages before giving up

Var: Format: array(packagename => 1, packagename => 1,...)
See: Converter::getLink()

Type:

array

[ Top ]

$charset = ''

[line 296]

Var: Character encoding of generated documentation, passed to Converters

Type:

string

[ Top ]

$classes = false

[line 268]

used to keep track of inheritance at the smartest level possible for a

dumb computer

Type:

Classes

[ Top ]

$converters = false

[line 287]

an array of template names indexed by converter name

For example, if the default HTMLframesConverter is using the DOM/l0l33t template, the array will be

$converters['frames'] = 'DOM/l0l33t'

Var: Format: array(Convertername1 => templatename)
See: Converter

Type:

array

[ Top ]

$cur_class = ''

[line 88]

Name of the class currently being parsed.

It is only used (and only valid) when phpDocumentor_IntermediateParser is parsing a class

Type:

string

[ Top ]

$data =

[line 237]

$data contains parsed structures for the current page being parsed

In version 1.1+, $data is only used to store the current page information. All handling of documented elements is handled by the ProceduralPages and Classes classes.

Type:

parserData

[ Top ]

$db_template =

[line 300]

Type:

mixed

[ Top ]

$event_handlers = array(
            'docblock' => 'handleDocBlock',
            'page' => 'handlePage',
            'class' => 'handleClass',
            'define' => 'handleDefine',
            'function' => 'handleFunction',
            'method' => 'handleMethod',
            'var' => 'handleVar',
            'const' => 'handleConst',
            'packagepage' => 'handlePackagePage',
            'include' => 'handleInclude',
            'global' => 'handleGlobal',
            'tutorial' => 'handleTutorial',
            )

[line 214]

the functions which handle output from the Parser

Type:

mixed

[ Top ]

$last =

[line 65]

Type:

parserDocBlock

[ Top ]

$lasttype = ''

[line 80]

type of the last parser Element handled

This is used in handleDocBlock to determine whether a DocBlock is a page-level DocBlock in conjunction with the parserData::$clean var. A page-level DocBlock is alwaysthe first DocBlock in a file, and must be followed by another DocBlock. The first test is handled by parserData::$clean, which is set to false on the first encounter of an element, and the second test is handled by this variable, which must be equal to "docblock"

See: phpDocumentor_IntermediateParser::handleDocBlock()

Type:

string

[ Top ]

$packagecategories = array()

[line 173]

Used to determine the category for tutorials.

WARNING: If more than one category exists, the last category encountered will overwrite the previous and will raise a big warning

Var: Format: packagename => categoryname

Type:

array

[ Top ]

$packageoutput = false

[line 206]

array of packages to parser and output documentation for, if not all packages should be documented

Format:
array(package1,package2,...)
or false if not set

Use this option to limit output similar to ignoring files. If you have some temporary files that you don't want to specify by name but don't want included in output, set a package name for all the elements in your project, and set packageoutput to that name. the default package will be ignored. Parsing speed does not improve. If you want to ignore files for speed reasons, use the ignore command-line option

Tutorial: -po, --packageoutput
See: Io

Type:

false|array

[ Top ]

$package_pages = array()

[line 133]

array of parsed package pages

used by Convert() to convert all package pages into output

Type:

array

[ Top ]

$package_parents = array()

[line 164]

Keeps track of packages of classes that have parent classes in another package. Used in automatic linking.

This array is updated by addPackageParent(), which is called in Classes::processChild() to keep track of classes that descend from classes in different packages. In other words, if class foo is in package one, and class bar is in package two, an entry $package_parents['two'] = 'one' will be made.

Var: Format: packagename => parentpackagename
See: Converter::getLink()

Type:

array

[ Top ]

$pages = array()

[line 138]

Var: array of all parserData containing page information

Type:

array

[ Top ]

$parsePrivate = false

[line 106]

set in Setup.inc.php to the value of the parseprivate commandline

option. If this option is true, elements with an @access private tag will be parsed and displayed

Tutorial: -pp, --parseprivate

Type:

boolean

[ Top ]

$privatepages = array()

[line 151]

Put away a page that has been @ignored or @access private if !$parsePrivate

When a page has @access private in its DocBlock, it is placed here instead of in $pages, to allow for proper Class parsing. Since classes and pages are parsed as if they were separate, this array allows public classes on private pages to retrieve information needed about the page that holds the class and to addPageIfNecessary() to the $pages array

Type:

array

[ Top ]

$private_class = false

[line 113]

this variable is used to prevent parsing of elements with an @ignore tag

See: phpDocumentor_IntermediateParser::$parsePrivate
See: phpDocumentor_IntermediateParser::$packageoutput

Type:

mixed

[ Top ]

$proceduralpages = false

[line 276]

used to keep track of all elements in a procedural page. Handles name

conflicts with elegance

Since: 1.1

Type:

ProceduralPages

[ Top ]

$quietMode = false

[line 248]

set in Setup.inc.php to the value of the quitemode commandline option.

If this option is true, informative output while parsing will not be displayed (documentation is unaffected)

Tutorial: -q, --quiet

Type:

boolean

[ Top ]

$ric = array()

[line 308]

Stores parsed CHANGELOG/INSTALL/README files

Var: Format: array(CHANGELOG => contents, INSTALL => contents, README => contents)

Type:

array

[ Top ]

$targetDir =

[line 119]

used to set the output directory

See: phpDocumentor_IntermediateParser::setTargetDir()

Type:

mixed

[ Top ]

$templateBase =

[line 125]

used to set the template base directory

See: phpDocumentor_IntermediateParser::setTemplateBase()

Type:

mixed

[ Top ]

$title = ''

[line 291]

Var: Title of generated documentation, passed to Converters

Type:

string

[ Top ]

$type = ''

[line 97]

type of the current parser Element being handled

This is used by HandleEvent() to set the $lasttype var, which is used to detect page-level DocBlocks

Type:

string

[ Top ]

$undocumentedElementWarnings = false

[line 261]

set in Setup.inc.php to the value of the undocumentedElementWarnings commandline option.

If this option is true, warnings about certain elements (classes, methods) that are not documented with DocBlocks will be shown while parsing, and will also be displayed in the errors.html page (other documentation is unaffected)

Tutorial: -ue, --undocumentedelements

Type:

boolean

[ Top ]

$uses = array()

[line 298]

Type:

mixed

[ Top ]

Method Detail

phpDocumentor_IntermediateParser (Constructor) [line 331]

phpDocumentor_IntermediateParser phpDocumentor_IntermediateParser(
[string
$title = 'Generated Documentation'], [
$charset = 'iso-8859-1'])

sets up basic data structures

See: phpDocumentor_IntermediateParser::$title, phpDocumentor_IntermediateParser::$data, phpDocumentor_IntermediateParser::$classes, phpDocumentor_IntermediateParser::$proceduralpages

Parameters:

string	`$title`	—	Title of generated documentation, passed to Converters
	`$charset`	—

[ Top ]

addConverter [line 1716]

void addConverter(
string
$output, string
$name, string
$template)

Add a converter name to use to the list of converters

Sets up the $converters array.

Parameters:

string	`$output`	—	output format (HTML, PDF, XML). Must be all caps
string	`$name`	—	Converter name (frames, for example, is the name of HTMLframesConverter)
string	`$template`	—	template to use, should be a relative path to the templates dir (like DOM/default)

[ Top ]

addElementToPage [line 1482]

void addElementToPage(
parserElement
$element, string
$path)

adds a processed descendant of parserElement to the $pages array or $privatepages array

This function expects the page to exist in either $pages or $privatepages. It calls the parserData::addElement() method to add $element to the page.

Parameters:

parserElement	`$element`	—	this will actually be a descendant of parserElement
string	`$path`	—

[ Top ]

addPackageParent [line 1693]

void addPackageParent(
parserClass
&$class)

If the parent class of $class is in a different package, adds it to the

$package_parents array

Parameters:

parserClass &$class —

[ Top ]

addPage [line 1376]

void addPage(
parserPage
$page, string
$path)

Replaces the parserPage represented by $this->pages[$path] with $page

Called by addPageIfNecessary(), handleDocBlock() and ProceduralPages::setupPages(), this method first checks to see if the page has been added. If not, it assumes that the page has either been @ignored or set with @access private with --parseprivate off, and returns addPrivatePage(). Otherwise, it sets the pages[$path] to be the parserPage $page and sets the package and subpackage to that of $page

See: phpDocumentor_IntermediateParser::$pages

Parameters:

parserPage	`$page`	—
string	`$path`	—	full path to the file

[ Top ]

addPageIfNecessary [line 1406]

void addPageIfNecessary(
string
$path, 
&$class)

add a new parserPage to the $pages array if none is found

This method is used when a page has been @ignored or marked with @access private, and a public class is in the page (a class with no @access private in its DocBlock). The method first creates a new page in the $pages array and then copies path information, and calls addPage() to set up packages

Parameters:

string	`$path`	—	full path of page
	`&$class`	—

[ Top ]

addPrivatePage [line 1444]

void addPrivatePage(
parserPage
$page, string
$path)

Adds a parserPage element to the parserData element in $this->privatepages[$path]

Performs a similar function to addPage, but adds to the $privatePages array

See: phpDocumentor_IntermediateParser::addPage()

Parameters:

parserPage	`$page`	—
string	`$path`	—	full path to the page

[ Top ]

addUses [line 1513]

void addUses(
parserElement
$element, string
$path)

Add all the @uses tags from $element to the $uses array so that @usedby

virtual tags can be added

Uses: parserUsesTag::getSeeElement() - used to initialize $uses
Uses: parserUsesTag::getDescription() - used to initialize $uses

Parameters:

parserElement	`$element`	—	descendant of parserElement
string	`$path`	—	full path to the file

[ Top ]

ClasselementCmp [line 1783]

int ClasselementCmp(
mixed
$a, mixed
$b)

does a natural case sort on two class elements (either parserClass, parserMethod or parserVar

See: generateElementIndex()

Parameters:

mixed	`$a`	—
mixed	`$b`	—

[ Top ]

Convert [line 1658]

void Convert(

$title, 
$converter)

Interface to the Converter

This function simply passes $pages and package_pages to the walk() method, and then calls the Output() method. Note that Output() is not required to do anything, and in fact doesn't in HTMLframesConverter.

Uses: Converter::walk() - passes $pages and $package_pages
Uses: Converter::Output()

Parameters:

	`$title`	—
	`$converter`	—

[ Top ]

elementCmp [line 1769]

int elementCmp(
mixed
$a, mixed
$b)

does a natural case sort on two parserElement descendants

See: generateElementIndex()

Parameters:

mixed	`$a`	—
mixed	`$b`	—

[ Top ]

handleClass [line 911]

void handleClass(
integer
$event, parserClass
$data)

handles post-parsing of classes

This function sets $data->clean to false to tell the phpDocumentor_IntermediateParser that a page-level DocBlock can't be found after this point on this page. It sets $cur_class to its name, and if an @ignore tag is found in the DocBlock, it sets $private_class to true, to prevent post-parsing of any of the class's vars or methods. Then it checks for the existence of a package page for the class's package

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserClass	`$data`	—

[ Top ]

handleConst [line 615]

void handleConst(
integer
$event, parserVar
$data)

handles post-parsing of class constants

This function aligns $data's $path var and packages to match the parent object

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserVar	`$data`	—

[ Top ]

handleDefine [line 855]

void handleDefine(
integer
$event, parserDefine
$data)

handles post-parsing of defines

This function sets $data->clean to false to tell the phpDocumentor_IntermediateParser that a page-level DocBlock can't be found after this point on this page. It then sets the package to be the same as the page and adds itself to the ProceduralPages class

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserDefine	`$data`	—

[ Top ]

handleDocBlock [line 1053]

void handleDocBlock(
integer
$event, parserDocBlock
$data)

handles post-parsing of DocBlocks

This function sets $last to the DocBlock represented by $data, to allow the next documentable element passed to phpDocumentor_IntermediateParser to link the DocBlock into its $docblock property. This function also checks for two special cases of DocBlocks:

First DocBlock in the file contains a @package tag
First DocBlock in the file is immediately followed by another DocBlock

In both cases, the function extracts this tag and uses it as the page-level package. If the @package tag is in the DocBlock of an element (function, global variable, whatever) that isn't a page-level DocBlock, a warning will be raised to notify the author that a @package tag belongs in a page-level DocBlock.

New in version 1.2.2, if the first DocBlock in a file contains a @package tag, it is a page-level DocBlock.

If the DocBlock is page-level, it is processed with _processPageLevelDocBlock

Finally, the function replaces the old parserPage in parserData::$data->parent with the new one containing information from the DocBlock by calling addPage(), and checks for package-level docs.

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserDocBlock	`$data`	—

[ Top ]

HandleEvent [line 1233]

void HandleEvent(
integer
$event, mixed
$data)

called via Parser::parse() and Parser's inherited method Publisher::publishEvent()

$event is one of the PHPDOC constants from Parser.inc. If it is not PHPDOCUMENTOR_EVENT_NEWSTATE, then a function name is retrieved from the $event_handlers array and called to handle the $data

Global: array $_phpDocumentor_setting$phpDocumentor_DefaultPackageName: we use 'sourcecode' to determine whether to highlight the source of the current file if it has no file-level docblock

Parameters:

integer	`$event`	—	event number from Parser.inc
mixed	`$data`	—	if $event is PHPDOCUMENTOR_EVENT_NEWSTATE, $data is a PHP_DOC_EVENT_END_PAGE or STATE_END_CLASS, otherwise $data is either a parserDocBlock, parserPage or descendant of parserElement

[ Top ]

handleFunction [line 769]

void handleFunction(
integer
$event, parserFunction
$data)

handles post-parsing of functions

If source code has been parsed by a {@source} tag, the source is added to its docblock, and then the parserFunction adds itself to the ProceduralPages class

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserFunction	`$data`	—

[ Top ]

handleGlobal [line 465]

void handleGlobal(
integer
$event, parserGlobal
$data)

handles post-parsing of global variables

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserGlobal	`$data`	—

[ Top ]

handleInclude [line 409]

void handleInclude(
integer
$event, parserInclude
$data)

handles post-parsing of include/require/include_once/require_once

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserInclude	`$data`	—

[ Top ]

handleMethod [line 665]

void handleMethod(
integer
$event, parserMethod
$data)

handles post-parsing of class methods

This function first aligns $data's path and package to match the parent object, and also aligns the docblock's @param, @global, and @staticvar tags with the information parsed from the method source code. It also checks to see if the method is a constructor and sets the $isConstructor flag. If source code has been parsed by a {@source} tag, the source is added to its docblock

Finally, it adds the method to the Classes class.

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserMethod	`$data`	—

[ Top ]

handlePackagePage [line 521]

void handlePackagePage(
integer
$event, parserPackagePage
$data)

handles post-parsing of Package-level documentation pages.

sets the $package_pages[$data->package] to $data

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserPackagePage	`$data`	—

[ Top ]

handlePage [line 1007]

void handlePage(
integer
$event, parserPage
$data)

handles post-parsing of procedural pages

this event is called at the start of a new page, before the Parser knows whether the page will contain any procedural pages or not

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserPage	`$data`	—

[ Top ]

handleTutorial [line 536]

void handleTutorial(
integer
$event, parserTutorial
$data)

handle post-parsing of Tutorials.

This adds the parsed tutorial to the tutorial tree

Since: 1.2
Uses: $tutorials - sets the value of tutorials to parameter $data

Parameters:

integer	`$event`	—	Event Number
parserTutorial	`$data`	—

[ Top ]

handleVar [line 556]

void handleVar(
integer
$event, parserVar
$data)

handles post-parsing of class vars

This function sets up a @var tag if none is found, and aligns $data's $path var and packages to match the parent object

Parameters:

integer	`$event`	—	Event number from Parser.inc
parserVar	`$data`	—

[ Top ]

Output [line 1813]

void Output(
[
$title = "Generated Documentation"])

call this method once parsing has completed.

This method calls the private methods fixClasses and fixProcPages, both of which adjust inheritance and package information based on complicated post-parsing rules described in ProceduralPages::setupPages() and Classes::Inherit(). Then, it sorts elements of the $pages array and calls Convert for each Converter in the $converters array

See: phpDocumentor_IntermediateParser::Convert()
See: phpDocumentor_IntermediateParser::$pages
See: phpDocumentor_IntermediateParser::$converters

Parameters:

$title —

[ Top ]

parsePackagePage [line 1187]

void parsePackagePage(
string
$package, string
$path)

Backward-compatibility only, use the new tutorials for more power

Tutorial: phpDocumentor Tutorials

Parameters:

string	`$package`	—	package name of package file to parse
string	`$path`	—	directory of file that contains package name

[ Top ]

setParsePrivate [line 1937]

void setParsePrivate(
bool
$parse)

set display of elements marked with @access private

If set to true, elements will be displayed

Parameters:

bool $parse —

[ Top ]

setQuietMode [line 1914]

void setQuietMode(
bool
$quietMode)

set parsing information output mode (quiet or verbose)

If set to false, no parsing information (parsing /php/file/thisfile.php, Converting etc.) will be displayed. Useful for cron jobs

Parameters:

bool $quietMode —

[ Top ]

setTargetDir [line 1890]

void setTargetDir(
string
$dir)

Sets the output directory

Parameters:

string $dir — the output directory

[ Top ]

setTemplateBase [line 1901]

void setTemplateBase(
string
$dir)

Sets the template base directory

Tutorial: -tb, --templatebase

Parameters:

string $dir — the template base directory

[ Top ]

setUndocumentedElementWarningsMode [line 1926]

void setUndocumentedElementWarningsMode(
bool
$undocumentedElementWarnings)

show warnings for undocumented elements

If set to false, no warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.

Parameters:

bool $undocumentedElementWarnings —

[ Top ]