Class: phpDocumentorTParser

Source Location: /phpDocumentor/phpDocumentorTParser.inc

Class phpDocumentorTParser

Class Overview

Tokenizer-based parser for PHP source code

Located in /phpDocumentor/phpDocumentorTParser.inc [line 45]

Publisher
   |
   --Parser
      |
      --phpDocumentorTParser

Author(s):

Gregory Beaver <[email protected]>

Information Tags:

Version:

$Revision: 1.18 $

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
phpDocumentor_HighlightParser	Highlights source code using parse()

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Publisher

Publisher::$subscriber

Inherited From Parser

Parser::Parser()

Set up invariant parsing variables

Parser::categoryTagHandler()

handles @category

Parser::checkEventPop()

this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

Parser::checkEventPush()

this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

Parser::configWordParser()

tell the parser's WordParser $wp to set up tokens to parse words by.

Parser::defaultTagHandler()

Handles all standard tags that only have a description

Parser::endTag()

Called to clean up at the end of parsing a @tag in a docblock

Parser::exampleTagHandler()

handles @example

Parser::getParserEventName()

Debugging function, takes an event number and attempts to return its name

Parser::globalTagHandler()

handles @global

Parser::invalidTagHandler()

Handles tags like '@filesource' that only work in PHP 4.3.0+

Parser::packageTagHandler()

handles @package

Parser::paramTagHandler()

handles @param

Parser::parse()

Parse a new file

Parser::returnTagHandler()

handles @return

Parser::setupStates()

setup the parser tokens, and the pushEvent/popEvent arrays

Parser::staticvarTagHandler()

handles @staticvar

Parser::usesTagHandler()

handles @uses

Parser::varTagHandler()

handles @var

Inherited From Publisher

Publisher::publishEvent()

Publisher::subscribe()

Adds a subscriber to the $subscriber array().

[ Top ]

Property Summary

mixed	$eventHandlers
mixed	$inlineTagHandlers
string	$source_location	relative path of the parsed file from the base parse directory

[ Top ]

Method Summary

phpDocumentorTParser	phpDocumentorTParser()
mixed	checkEventPop()	this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
mixed	checkEventPush()	this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
void	configWordParser()
void	getToken()
bool	parse()	Parse a new file
void	setupEventStates()	Creates the state arrays
void	setupStates()	setup the parser tokens, and the pushEvent/popEvent arrays

[ Top ]

Properties

mixed $eventHandlers = array(
PARSER_EVENT_ARRAY => 'handleArray',
PARSER_EVENT_VAR_ARRAY => 'handleArray',
PARSER_EVENT_VAR_ARRAY_COMMENT => 'handleVarArrayComment',
PARSER_EVENT_CLASS => 'handleClass',
PARSER_EVENT_COMMENT => 'handleComment',
PARSER_EVENT_DOCBLOCK_TEMPLATE => 'handleDocBlockTemplate',
PARSER_EVENT_END_DOCBLOCK_TEMPLATE => 'handleEndDocBlockTemplate',
PARSER_EVENT_LOGICBLOCK => 'handleLogicBlock',
PARSER_EVENT_NOEVENTS => 'defaultHandler',
PARSER_EVENT_OUTPHP => 'defaultHandler',
PARSER_EVENT_DEFINE => 'handleDefine',
PARSER_EVENT_DEFINE_PARAMS => 'handleDefineParams',
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS => 'handleDefineParamsParenthesis',
PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS => 'handleIncludeParamsParenthesis',
PARSER_EVENT_DOCBLOCK => 'handleDocBlock',
PARSER_EVENT_TAGS => 'handleTags',
PARSER_EVENT_DESC => 'handleDesc',
PARSER_EVENT_DOCKEYWORD => 'handleTag',
PARSER_EVENT_DOCKEYWORD_EMAIL => 'handleDockeywordEmail',
PARSER_EVENT_EOFQUOTE => 'handleHereDoc',
PARSER_EVENT_FUNCTION => 'handleFunction',
PARSER_EVENT_FUNCTION_PARAMS => 'handleFunctionParams',
PARSER_EVENT_FUNCTION_PARAM_VAR => 'handleFunctionParams',
PARSER_EVENT_FUNC_GLOBAL => 'handleFuncGlobal',
PARSER_EVENT_DEFINE_GLOBAL => 'handleGlobal',
PARSER_EVENT_GLOBAL_VALUE => 'handleGlobalValue',
PARSER_EVENT_INLINE_DOCKEYWORD => 'handleInlineDockeyword',
PARSER_EVENT_INCLUDE => 'handleInclude',
PARSER_EVENT_INCLUDE_PARAMS => 'handleIncludeParams',
PARSER_EVENT_QUOTE => 'handleQuote',
PARSER_EVENT_PHPCODE => 'handlePhpCode',
PARSER_EVENT_SINGLEQUOTE => 'handleSingleQuote',
PARSER_EVENT_STATIC_VAR => 'handleStaticVar',
PARSER_EVENT_STATIC_VAR_VALUE => 'handleStaticValue',
PARSER_EVENT_VAR => 'handleVar',
PARSER_EVENT_ACCESS_MODIFIER => 'handleAccessModifier',
PARSER_EVENT_IMPLEMENTS => 'handleImplements',
PARSER_EVENT_CLASS_CONSTANT => 'handleClassConstant',
) [line 131]

[ Top ]

mixed $inlineTagHandlers = array(
'*' => 'handleDefaultInlineTag',
'link' => 'handleLinkInlineTag',
) [line 172]

[ Top ]

string $source_location [line 130]

relative path of the parsed file from the base parse directory

[ Top ]

Methods

Constructor phpDocumentorTParser [line 177]

phpDocumentorTParser phpDocumentorTParser(
)

[ Top ]

checkEventPop [line 2309]

mixed checkEventPop(

$word, 
$pevent 
)

this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

Parameters:

	$word:
	$pevent:

API Tags:

Return:

returns false, or the event number popped off of the stack

Redefinition of:

Parser::checkEventPop(): this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

[ Top ]

checkEventPush [line 2277]

mixed checkEventPush(

$word, 
$pevent 
)

this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

Parameters:

	$word:
	$pevent:

API Tags:

Return:

returns false, or the event number

Redefinition of:

Parser::checkEventPush(): this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

[ Top ]

configWordParser [line 2697]

void configWordParser(

&$data 
)

Parameters:

&$data:

Redefinition of:

Parser::configWordParser(): tell the parser's WordParser $wp to set up tokens to parse words by.

Redefined in descendants as:

phpDocumentor_HighlightParser::configWordParser() : Give the word parser necessary data to begin a new parse

[ Top ]

getToken [line 2330]

void getToken(

$word 
)

Parameters:

$word:

[ Top ]

parse [line 197]

bool parse(

&$parse_data, string
$path, [int
$base = 0], [
$packages = false], string
$parse_data 
)

Parse a new file

Parameters:

string	$parse_data:
string	$path:
int	$base:	number of directories to drop off the bottom when creating names using path
	&$parse_data:
	$packages:

API Tags:

Staticvar:

integer $endrecur: used for recursion limiting if a handler for an event is not found

Redefinition of:

Parser::parse(): Parse a new file

Redefined in descendants as:

phpDocumentor_HighlightParser::parse() : Parse a new file

[ Top ]

setupEventStates [line 2398]

void setupEventStates(
)

Creates the state arrays

[ Top ]

setupStates [line 2341]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

API Tags:

See:

Publisher::$tokens, Publisher::$pushEvent, Publisher::$popEvent

Redefinition of:

Parser::setupStates(): setup the parser tokens, and the pushEvent/popEvent arrays

Redefined in descendants as:

phpDocumentor_HighlightParser::setupStates() : Initialize all parser state variables

[ Top ]

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

	phpDocumentor Parsers

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