Class: phpDocumentorTParser

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/phpDocumentorTParser.inc

Class Overview

Publisher
   |
   --Parser
      |
      --phpDocumentorTParser

Author(s):

Gregory Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Revision: 1.14 $

Variables

Methods

Inherited Variables

Class: Publisher

Publisher::$subscriber

Inherited Methods

Class: Parser

Parser::Parser()
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::getParserEventName(): Debugging function, takes an event number and attempts to return its name
Parser::parse(): Parse a new file
Parser::setupStates(): setup the parser tokens, and the pushEvent/popEvent arrays

Class: Publisher

Publisher::publishEvent()
Publisher::subscribe(): Adds a subscriber to the $subscriber array().

Class Details

[line 8]

Version: $Revision: 1.14 $
Author: Gregory Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$eventHandlers = array(
                                PARSER_EVENT_ARRAY => 'handleArray',
                                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 => 'handleEOFQuote',
                                PARSER_EVENT_FUNCTION => 'handleFunction',
                                PARSER_EVENT_FUNCTION_PARAMS => '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',
    )

[line 93]

Type:

mixed

[ Top ]

$inlineTagHandlers = array(
                                '*' => 'handleDefaultInlineTag',
                                'link' => 'handleLinkInlineTag',
                                )

[line 128]

Type:

mixed

[ Top ]

$source_location =

[line 92]

relative path of the parsed file from the base parse directory

Type:

string

[ Top ]

Method Detail

phpDocumentorTParser (Constructor) [line 133]

phpDocumentorTParser phpDocumentorTParser(
)

[ Top ]

checkEventPop [line 1678]

mixed checkEventPop(
mixed
$word, mixed
$pevent)

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

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

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

[ Top ]

checkEventPush [line 1646]

mixed checkEventPush(
mixed
$word, mixed
$pevent)

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

Return: returns false, or the event number

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

[ Top ]

configWordParser [line 2007]

void configWordParser(
mixed
&$data)

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

[ Top ]

getToken [line 1699]

void getToken(
mixed
$word)

[ Top ]

parse [line 152]

bool parse(
string
&$parse_data, string
$path, [int
$base = 0], [mixed
$packages = false])

Parse a new file

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

Overrides Parser::parse() (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

[ Top ]

setupStates [line 1710]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

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

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

[ Top ]

Class: phpDocumentorTParser

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: Publisher

Inherited Methods

Class: Parser

Class: Publisher

Class Details

Class Variables

$inlineTagHandlers = array( '*' => 'handleDefaultInlineTag', 'link' => 'handleLinkInlineTag', )

$source_location =

Method Detail

phpDocumentorTParser (Constructor) [line 133]

checkEventPop [line 1678]

checkEventPush [line 1646]

configWordParser [line 2007]

getToken [line 1699]

parse [line 152]

Parameters:

setupStates [line 1710]

$inlineTagHandlers = array(
'*' => 'handleDefaultInlineTag',
'link' => 'handleLinkInlineTag',
)