Description
Publisher
|
--Parser
Located in File: /phpDocumentor/Parser.inc
PHP Parser for PHP 4.2.3-
This parser is slower than the tokenizer-based parser, and is deprecated.
Classes extended from Parser:
- phpDocumentorTParser
- Tokenizer-based parser for PHP source code
- parserDescParser
- Parses a DocBlock description to retrieve abstract representations of
- phpDocumentor_TutorialHighlightParser
- Highlights source code using parse()
- ppageParser
- Global package page parser
- XMLPackagePageParser
- Used to parse XML DocBook-based tutorials
- PDFParser
Method Detail
Summary:
bool
parse
(
&$parse_data,
string $path, [
int $base =
0], [
$packages =
false],
string $parse_data)
Constructor Parser (line 487)
Parser Parser(
)
Set up invariant parsing variables
Info
Method categoryTagHandler (line 2046)
void categoryTagHandler(
string
$word)
handles @category
Parameters
Info
Method checkEventPop (line 2612)
mixed checkEventPop(
$word,
$pevent)
Overridden in child classes as:
- phpDocumentor_TutorialHighlightParser::checkEventPop()
- This function checks whether parameter $word is a token for popping the current event off of the Event Stack.
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
Parameters
Info
- return - returns false, or the event number popped off of the stack
Method checkEventPush (line 2590)
mixed checkEventPush(
$word,
$pevent)
Overridden in child classes as:
- phpDocumentor_TutorialHighlightParser::checkEventPush()
- This function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
Parameters
Info
- return - returns false, or the event number
Method configWordParser (line 2957)
void configWordParser(
$value
$e)
Overridden in child classes as:
- phpDocumentor_HighlightParser::configWordParser()
- Give the word parser necessary data to begin a new parse
- phpDocumentor_TutorialHighlightParser::configWordParser()
- Tell the parser's WordParser $wp to set up tokens to parse words by.
tell the parser's WordParser $wp to set up tokens to parse words by.
tokens are word separators. In English, a space or punctuation are examples of tokens. In PHP, a token can be a ;, a parenthesis, or even the word "function"
Parameters
- $value $e: integer an event number
Info
Method defaultTagHandler (line 1989)
void defaultTagHandler(
string
$word)
Handles all standard tags that only have a description
Parameters
Info
Method endTag (line 1971)
void endTag(
)
Called to clean up at the end of parsing a @tag in a docblock
Info
Method exampleTagHandler (line 2031)
void exampleTagHandler(
string
$word)
handles @example
Parameters
Info
Method globalTagHandler (line 2062)
void globalTagHandler(
string
$word)
handles @global
Parameters
Info
Method invalidTagHandler (line 2003)
void invalidTagHandler(
string
$word)
Handles tags like '@filesource' that only work in PHP 4.3.0+
Parameters
Info
Method packageTagHandler (line 2015)
void packageTagHandler(
string
$word)
handles @package
Parameters
Info
Method paramTagHandler (line 2192)
void paramTagHandler(
string
$word)
handles @param
Parameters
Info
Method propertyTagHandler (line 2276)
void propertyTagHandler(
string
$word)
Handles @property(-read or -write) and @method magic tag
Parameters
Info
Method returnTagHandler (line 2228)
void returnTagHandler(
string
$word)
handles @return
Parameters
Info
Method staticvarTagHandler (line 2134)
void staticvarTagHandler(
string
$word)
handles @staticvar
Parameters
Info
Method usesTagHandler (line 2170)
void usesTagHandler(
string
$word)
handles @uses
Parameters
Info
Method varTagHandler (line 2252)
void varTagHandler(
string
$word)
handles @var
Parameters
Info