Class phpDocumentorTParser

Description
Direct descendents
Class Description
 class phpDocumentor_HighlightParser Highlights source code using parse()
Variable Summary
Method Summary
 phpDocumentorTParser phpDocumentorTParser ()
 bool parse (string &$parse_data, string $path, [int $base = 0], [bool $packages = false])
Variables
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 147)
mixed $inlineTagHandlers = array(
'*' => 'handleDefaultInlineTag',
'link' => 'handleLinkInlineTag',
)
(line 188)
string $source_location (line 146)

relative path of the parsed file from the base parse directory

Inherited Variables

Inherited from Publisher

Publisher::$subscriber
Methods
Constructor phpDocumentorTParser (line 197)

Constructor

phpDocumentorTParser phpDocumentorTParser ()
parse (line 225)

Parse a new file

  • staticvar: int $endrecur: used for recursion limiting if a handler for an event is not found
bool parse (string &$parse_data, string $path, [int $base = 0], [bool $packages = false])
  • string &$parse_data: the parse data
  • string $path: the path
  • int $base: number of directories to drop off the bottom when creating names using path
  • bool $packages: ???

Redefinition of:
Parser::parse()
Parse a new file

Redefined in descendants as:

Inherited Methods

Inherited From Parser

 Parser::Parser()
 Parser::categoryTagHandler()
 Parser::checkEventPop()
 Parser::checkEventPush()
 Parser::configWordParser()
 Parser::defaultTagHandler()
 Parser::endTag()
 Parser::exampleTagHandler()
 Parser::getParserEventName()
 Parser::globalTagHandler()
 Parser::invalidTagHandler()
 Parser::packageTagHandler()
 Parser::paramTagHandler()
 Parser::parse()
 Parser::propertyTagHandler()
 Parser::returnTagHandler()
 Parser::setupStates()
 Parser::staticvarTagHandler()
 Parser::usesTagHandler()
 Parser::varTagHandler()

Inherited From Publisher

 Publisher::publishEvent()
 Publisher::subscribe()

Documentation generated on Mon, 05 Dec 2011 21:06:46 -0600 by phpDocumentor 1.4.4