/phpDocumentor/Parser.inc
Base parser for all parsers
phpDocumentor :: automatic documentation generator
PHP versions 4 and 5
Copyright (c) 2000-2006 Joshua Eichorn, Gregory Beaver
LICENSE:
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
| Class | Description |
|---|---|
Parser
|
PHP Parser for PHP 4.2.3- |
|
ppageParser
|
Global package page parser |
PARSER_EVENT_ACCESS_MODIFIER = 139
(line 277)
used when parsing an access modifier
PARSER_EVENT_ARRAY = 115
(line 160)
used when an array definition is encountered in parsing
PARSER_EVENT_CLASS = 111
(line 138)
used when a class definition is encountered in parsing
PARSER_EVENT_CLASS_CONSTANT = 141
(line 287)
used when a class implements interfaces
PARSER_EVENT_CLASS_MEMBER = 137
(line 267)
used by the HighlightParser only, when ->var or ->function() is encountered in a method
PARSER_EVENT_COMMENT = 105
(line 108)
used when short comment // is encountered in parsing
PARSER_EVENT_COMMENTBLOCK = 104
(line 103)
used when long comment /x x/ where x is an asterisk is encountered in parsing
PARSER_EVENT_DEFINE = 107
(line 118)
used when a define statement is encountered in parsing
PARSER_EVENT_DEFINE_GLOBAL = 128
(line 222)
used when parsing a global variable declaration
PARSER_EVENT_DEFINE_PARAMS = 108
(line 123)
used when a define statement opening parenthesis is encountered in parsing
PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS = 120
(line 185)
used when a define statement's opening parenthesis is encountered in parsing
PARSER_EVENT_DESC = 126
(line 212)
used when parsing the desc part of a docblock
PARSER_EVENT_DOCBLOCK = 112
(line 145)
used when a DocBlock is encountered in parsing
PARSER_EVENT_DOCBLOCK_TEMPLATE = 133
(line 247)
used when encountering a /**#@+ comment marking a new docblock template
PARSER_EVENT_DOCKEYWORD = 113
(line 150)
used when a @tag is encountered in DocBlock parsing
PARSER_EVENT_DOCKEYWORD_EMAIL = 114
(line 155)
used when a <email@address> is encountered in parsing an @author tag
PARSER_EVENT_END_DOCBLOCK_TEMPLATE = 134
(line 252)
used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template
PARSER_EVENT_END_STATEMENT = 121
(line 189)
PARSER_EVENT_EOFQUOTE = 122
(line 192)
used when a <<< is encountered in parsing
PARSER_EVENT_ESCAPE = 900
(line 40)
used when a backslash is encountered in parsing a string or other escapable entity
PARSER_EVENT_FUNCTION = 117
(line 170)
used when a function definition is encountered in parsing
PARSER_EVENT_FUNCTION_PARAMS = 109
(line 128)
used when a function statement opening parenthesis is encountered in parsing
PARSER_EVENT_FUNCTION_PARAM_VAR = 144
(line 302)
used when a $param is encountered in a function definition
PARSER_EVENT_FUNC_GLOBAL = 130
(line 232)
used when parsing a "global $var1, $var2;" declaration in a function
PARSER_EVENT_GLOBAL_VALUE = 129
(line 227)
used when parsing the default value in a global variable declaration
PARSER_EVENT_IMPLEMENTS = 140
(line 282)
used when a class implements interfaces
PARSER_EVENT_INCLUDE = 123
(line 197)
used when an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS = 124
(line 202)
used when an opening parenthesis of an include/require/include_once/include_once statement is encountered in parsing
PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS = 125
(line 207)
used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement
PARSER_EVENT_INLINE_DOCKEYWORD = 119
(line 180)
used when an inline {@tag} is encountered in parsing a DocBlock
PARSER_EVENT_LOGICBLOCK = 102
(line 93)
{ encountered in parsing a function or php code
PARSER_EVENT_METHOD = 135
(line 257)
used by the HighlightParser only, when a method starts
PARSER_EVENT_METHOD_LOGICBLOCK = 136
(line 262)
used by the HighlightParser only, when a method body is parsed
PARSER_EVENT_NOEVENTS = 103
(line 98)
used for the beginning of parsing, before first < ? php encountered
PARSER_EVENT_OUTPHP = 118
(line 175)
used when a ? > (with no space) is encountered in parsing
PARSER_EVENT_PHPCODE = 106
(line 113)
used when php code processor instruction (< ? php) is encountered in parsing
PARSER_EVENT_QUOTE = 101
(line 88)
used when double quotation mark (") encountered in parsing
PARSER_EVENT_QUOTE_VAR = 138
(line 272)
used by the HighlightParser only, when {$var} is encountered in a string
PARSER_EVENT_SINGLEQUOTE = 110
(line 133)
used when a single quote (') is encountered in parsing
PARSER_EVENT_STATIC_VAR = 131
(line 237)
used when parsing a "static $var1, $var2;" declaration in a function
PARSER_EVENT_STATIC_VAR_VALUE = 132
(line 242)
used when parsing the value in a "static $var1 = x" declaration in a function
PARSER_EVENT_TAGS = 127
(line 217)
used when parsing the @tag block of a docblock
PARSER_EVENT_VAR = 116
(line 165)
used when a var statement is encountered in parsing a class definition
PARSER_EVENT_VAR_ARRAY = 142
(line 292)
used when a variable value is an array
PARSER_EVENT_VAR_ARRAY_COMMENT = 143
(line 297)
used when a comment is found in a variable array value
PHPDOCUMENTOR_EVENT_CLASS = 800
(line 45)
Class published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_CONST = 806
(line 57)
Class Constant published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DEFINE = 805
(line 55)
Constant (define) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK = 801
(line 47)
DocBlock published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE = 814
(line 84)
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE = 815
(line 86)
used when a docblock template is encountered in the source
PHPDOCUMENTOR_EVENT_END_PAGE = 808
(line 67)
used to inform phpDocumentor_IntermediateParser that the current file has been completely parsed.
Render then flushes all buffers for functions/classes/defines/includes on the current page
PHPDOCUMENTOR_EVENT_FUNCTION = 802
(line 49)
Function published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_GLOBAL = 813
(line 82)
used when a global variable definition is encountered in the source
PHPDOCUMENTOR_EVENT_INCLUDE = 810
(line 71)
Include (include/require/include_once/include_once) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_MESSAGE = 807
(line 59)
PHPDOCUMENTOR_EVENT_NEWFILE = 811
(line 78)
use to inform ErrorTracker of a new file being parsed
PHPDOCUMENTOR_EVENT_NEWLINENUM = 812
(line 80)
use to inform ErrorTracker of the next line number being parsed
PHPDOCUMENTOR_EVENT_NEWSTATE = 808
(line 61)
use to inform IntermediateParser of a new element being parsed
PHPDOCUMENTOR_EVENT_PACKAGEPAGE = 809
(line 69)
Package-level page published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_PAGE = 804
(line 53)
New File (page) published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG = 812
(line 75)
Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_TUTORIAL = 811
(line 73)
Tutorial published to IntermediateParser with this event
PHPDOCUMENTOR_EVENT_VAR = 803
(line 51)
Class Variable published to IntermediateParser with this event
STATE_ACCESS_MODIFIER = 239
(line 279)
currently parsing an access modifier
STATE_ARRAY = 215
(line 162)
currently parsing an array
STATE_CLASS = 211
(line 140)
currently parsing a class definition
STATE_CLASS_CONSTANT = 241
(line 289)
currently parsing a class constant
STATE_CLASS_MEMBER = 237
(line 269)
currently parsing a class member using the HighlightParser
STATE_COMMENT = 205
(line 110)
currently parsing a short comment //
STATE_COMMENTBLOCK = 204
(line 105)
currently parsing a long comment /x x/ where x is an asterisk
STATE_DEFINE = 207
(line 120)
currently parsing a define statement
STATE_DEFINE_PARAMS = 208
(line 125)
currently parsing the stuff in ( ) of a define statement
STATE_DEFINE_PARAMS_PARENTHESIS = 220
(line 187)
currently parsing an inner parenthetical statement of a define( )
STATE_DESC = 226
(line 214)
currently parsing the desc part of a docblock
STATE_DOCBLOCK = 212
(line 147)
currently parsing a DocBlock
STATE_DOCBLOCK_TEMPLATE = 233
(line 249)
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_DOCKEYWORD = 213
(line 152)
currently parsing a @tag in a DocBlock
STATE_DOCKEYWORD_EMAIL = 214
(line 157)
currently parsing an email in brackets in an @author tag of a DocBlock
STATE_END_CLASS = 311
(line 142)
used to tell Render that a class has been completely parsed, and to flush buffers
STATE_END_DOCBLOCK_TEMPLATE = 234
(line 254)
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_EOFQUOTE = 222
(line 194)
currently parsing a string defined using Perl <<<
STATE_ESCAPE = 1000
(line 42)
used when a backslash is encountered in parsing a string or other escapable entity
STATE_FUNCTION = 217
(line 172)
currently parsing a Function or Method
STATE_FUNCTION_PARAMS = 209
(line 130)
currently parsing the stuff in ( ) of a function definition
STATE_FUNCTION_PARAM_VAR = 244
(line 304)
currently parsing a $param in a function definition
STATE_FUNC_GLOBAL = 230
(line 234)
currently parsing a "global $var1, $var2;" declaration in a function
STATE_GLOBAL = 228
(line 224)
currently parsing a global variable declaration
STATE_GLOBAL_VALUE = 229
(line 229)
currently parsing the default value in a global variable declaration
STATE_IMPLEMENTS = 240
(line 284)
currently parsing an implements clause
STATE_INCLUDE = 223
(line 199)
currently parsing an include/require/include_once/include_once
STATE_INCLUDE_PARAMS = 224
(line 204)
currently parsing the stuff in ( ) of a define statement
STATE_INCLUDE_PARAMS_PARENTHESIS = 225
(line 209)
currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )
STATE_INLINE_DOCKEYWORD = 219
(line 182)
currently parsing an inline tag like { @link} in a DocBlock
STATE_LOGICBLOCK = 202
(line 95)
currently parsing a { } block
STATE_METHOD = 235
(line 259)
currently parsing a method using the HighlightParser
STATE_METHOD_LOGICBLOCK = 236
(line 264)
currently parsing the method body using the HighlightParser
STATE_NOEVENTS = 203
(line 100)
out of < ? php tag
STATE_OUTPHP = 218
(line 177)
currently out of php code
STATE_PHPCODE = 206
(line 115)
currently parsing php code
STATE_QUOTE = 201
(line 90)
currently parsing a quote
STATE_QUOTE_VAR = 238
(line 274)
currently parsing a {$encapsed_var} using the HighlightParser
STATE_SINGLEQUOTE = 210
(line 135)
currently parsing a string enclosed in single quotes (')
STATE_STATIC_VAR = 231
(line 239)
currently parsing a "static $var1, $var2;" declaration in a function
STATE_STATIC_VAR_VALUE = 232
(line 244)
currently parsing the value in a "static $var1 = x" declaration in a function
STATE_TAGS = 227
(line 219)
currently parsing the @tag block of a docblock
STATE_VAR = 216
(line 167)
currently parsing a Class variable
STATE_VAR_ARRAY = 242
(line 294)
currently parsing a variable value is an array
STATE_VAR_ARRAY_COMMENT = 243
(line 299)
currently parsing a comment in a variable array value
T_ABSTRACT = 'foo'
(line 312)
T_CONST = 'foo'
(line 310)
T_DOC_COMMENT = T_ML_COMMENT
(line 325)
T_FINAL = 'foo'
(line 316)
T_IMPLEMENTS = 'foo'
(line 317)
T_INTERFACE = 'foo'
(line 308)
T_ML_COMMENT = T_COMMENT
(line 321)
T_PRIVATE = 'foo'
(line 313)
T_PROTECTED = 'foo'
(line 315)
T_PUBLIC = 'foo'
(line 314)
Documentation generated on Mon, 05 Dec 2011 21:39:47 -0600 by phpDocumentor 1.4.4