File: /phpDocumentor/Parser.inc

Description

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

Classes defined in this file

CLASS NAME

DESCRIPTION

Parser PHP Parser for PHP 4.2.3-
ppageParser Global package page parser

Include/Require Statements

Global Variables

Constants

PARSER_EVENT_ACCESS_MODIFIER (line 277)

PARSER_EVENT_ACCESS_MODIFIER : 139

used when parsing an access modifier

PARSER_EVENT_ARRAY (line 160)

PARSER_EVENT_ARRAY : 115

used when an array definition is encountered in parsing

PARSER_EVENT_CLASS (line 138)

PARSER_EVENT_CLASS : 111

used when a class definition is encountered in parsing

PARSER_EVENT_CLASS_CONSTANT (line 287)

PARSER_EVENT_CLASS_CONSTANT : 141

used when a class implements interfaces

PARSER_EVENT_CLASS_MEMBER (line 267)

PARSER_EVENT_CLASS_MEMBER : 137

used by the HighlightParser only, when ->var or ->function() is encountered in a method

PARSER_EVENT_COMMENT (line 108)

PARSER_EVENT_COMMENT : 105

used when short comment // is encountered in parsing

PARSER_EVENT_COMMENTBLOCK (line 103)

PARSER_EVENT_COMMENTBLOCK : 104

used when long comment /x x/ where x is an asterisk is encountered in parsing

PARSER_EVENT_DEFINE (line 118)

PARSER_EVENT_DEFINE : 107

used when a define statement is encountered in parsing

PARSER_EVENT_DEFINE_GLOBAL (line 222)

PARSER_EVENT_DEFINE_GLOBAL : 128

used when parsing a global variable declaration

PARSER_EVENT_DEFINE_PARAMS (line 123)

PARSER_EVENT_DEFINE_PARAMS : 108

used when a define statement opening parenthesis is encountered in parsing

PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS (line 185)

PARSER_EVENT_DEFINE_PARAMS_PARENTHESIS : 120

used when a define statement's opening parenthesis is encountered in parsing

PARSER_EVENT_DESC (line 212)

PARSER_EVENT_DESC : 126

used when parsing the desc part of a docblock

PARSER_EVENT_DOCBLOCK (line 145)

PARSER_EVENT_DOCBLOCK : 112

used when a DocBlock is encountered in parsing

PARSER_EVENT_DOCBLOCK_TEMPLATE (line 247)

PARSER_EVENT_DOCBLOCK_TEMPLATE : 133

used when encountering a /**#@+ comment marking a new docblock template

PARSER_EVENT_DOCKEYWORD (line 150)

PARSER_EVENT_DOCKEYWORD : 113

used when a @tag is encountered in DocBlock parsing

PARSER_EVENT_DOCKEYWORD_EMAIL (line 155)

PARSER_EVENT_DOCKEYWORD_EMAIL : 114

used when a <[email protected]> is encountered in parsing an @author tag

PARSER_EVENT_END_DOCBLOCK_TEMPLATE (line 252)

PARSER_EVENT_END_DOCBLOCK_TEMPLATE : 134

used when encountering a /**#@-* / comment (no space) marking the end of using a docblock template

PARSER_EVENT_END_STATEMENT (line 189)

PARSER_EVENT_END_STATEMENT : 121

PARSER_EVENT_EOFQUOTE (line 192)

PARSER_EVENT_EOFQUOTE : 122

used when a <<< is encountered in parsing

PARSER_EVENT_ESCAPE (line 40)

PARSER_EVENT_ESCAPE : 900

used when a backslash is encountered in parsing a string or other escapable entity

PARSER_EVENT_FUNCTION (line 170)

PARSER_EVENT_FUNCTION : 117

used when a function definition is encountered in parsing

PARSER_EVENT_FUNCTION_PARAMS (line 128)

PARSER_EVENT_FUNCTION_PARAMS : 109

used when a function statement opening parenthesis is encountered in parsing

PARSER_EVENT_FUNCTION_PARAM_VAR (line 302)

PARSER_EVENT_FUNCTION_PARAM_VAR : 144

used when a $param is encountered in a function definition

PARSER_EVENT_FUNC_GLOBAL (line 232)

PARSER_EVENT_FUNC_GLOBAL : 130

used when parsing a "global $var1, $var2;" declaration in a function

PARSER_EVENT_GLOBAL_VALUE (line 227)

PARSER_EVENT_GLOBAL_VALUE : 129

used when parsing the default value in a global variable declaration

PARSER_EVENT_IMPLEMENTS (line 282)

PARSER_EVENT_IMPLEMENTS : 140

used when a class implements interfaces

PARSER_EVENT_INCLUDE (line 197)

PARSER_EVENT_INCLUDE : 123

used when an include/require/include_once/include_once statement is encountered in parsing

PARSER_EVENT_INCLUDE_PARAMS (line 202)

PARSER_EVENT_INCLUDE_PARAMS : 124

used when an opening parenthesis of an include/require/include_once/include_once statement is encountered in parsing

PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS (line 207)

PARSER_EVENT_INCLUDE_PARAMS_PARENTHESIS : 125

used when an inner ( ) is encountered while parsing an include/require/include_once/include_once statement

PARSER_EVENT_INLINE_DOCKEYWORD (line 180)

PARSER_EVENT_INLINE_DOCKEYWORD : 119

used when an inline {@tag} is encountered in parsing a DocBlock

PARSER_EVENT_LOGICBLOCK (line 93)

PARSER_EVENT_LOGICBLOCK : 102

{ encountered in parsing a function or php code

PARSER_EVENT_METHOD (line 257)

PARSER_EVENT_METHOD : 135

used by the HighlightParser only, when a method starts

PARSER_EVENT_METHOD_LOGICBLOCK (line 262)

PARSER_EVENT_METHOD_LOGICBLOCK : 136

used by the HighlightParser only, when a method body is parsed

PARSER_EVENT_NOEVENTS (line 98)

PARSER_EVENT_NOEVENTS : 103

used for the beginning of parsing, before first < ? php encountered

PARSER_EVENT_OUTPHP (line 175)

PARSER_EVENT_OUTPHP : 118

used when a ? > (with no space) is encountered in parsing

PARSER_EVENT_PHPCODE (line 113)

PARSER_EVENT_PHPCODE : 106

used when php code processor instruction (< ? php) is encountered in parsing

PARSER_EVENT_QUOTE (line 88)

PARSER_EVENT_QUOTE : 101

used when double quotation mark (") encountered in parsing

PARSER_EVENT_QUOTE_VAR (line 272)

PARSER_EVENT_QUOTE_VAR : 138

used by the HighlightParser only, when {$var} is encountered in a string

PARSER_EVENT_SINGLEQUOTE (line 133)

PARSER_EVENT_SINGLEQUOTE : 110

used when a single quote (') is encountered in parsing

PARSER_EVENT_STATIC_VAR (line 237)

PARSER_EVENT_STATIC_VAR : 131

used when parsing a "static $var1, $var2;" declaration in a function

PARSER_EVENT_STATIC_VAR_VALUE (line 242)

PARSER_EVENT_STATIC_VAR_VALUE : 132

used when parsing the value in a "static $var1 = x" declaration in a function

PARSER_EVENT_TAGS (line 217)

PARSER_EVENT_TAGS : 127

used when parsing the @tag block of a docblock

PARSER_EVENT_VAR (line 165)

PARSER_EVENT_VAR : 116

used when a var statement is encountered in parsing a class definition

PARSER_EVENT_VAR_ARRAY (line 292)

PARSER_EVENT_VAR_ARRAY : 142

used when a variable value is an array

PARSER_EVENT_VAR_ARRAY_COMMENT (line 297)

PARSER_EVENT_VAR_ARRAY_COMMENT : 143

used when a comment is found in a variable array value

PHPDOCUMENTOR_EVENT_CLASS (line 45)

PHPDOCUMENTOR_EVENT_CLASS : 800

Class published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_CONST (line 57)

PHPDOCUMENTOR_EVENT_CONST : 806

Class Constant published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_DEFINE (line 55)

PHPDOCUMENTOR_EVENT_DEFINE : 805

Constant (define) published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_DOCBLOCK (line 47)

PHPDOCUMENTOR_EVENT_DOCBLOCK : 801

DocBlock published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE (line 84)

PHPDOCUMENTOR_EVENT_DOCBLOCK_TEMPLATE : 814

used when a docblock template is encountered in the source

PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE (line 86)

PHPDOCUMENTOR_EVENT_END_DOCBLOCK_TEMPLATE : 815

used when a docblock template is encountered in the source

PHPDOCUMENTOR_EVENT_END_PAGE (line 67)

PHPDOCUMENTOR_EVENT_END_PAGE : 808

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 (line 49)

PHPDOCUMENTOR_EVENT_FUNCTION : 802

Function published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_GLOBAL (line 82)

PHPDOCUMENTOR_EVENT_GLOBAL : 813

used when a global variable definition is encountered in the source

PHPDOCUMENTOR_EVENT_INCLUDE (line 71)

PHPDOCUMENTOR_EVENT_INCLUDE : 810

Include (include/require/include_once/include_once) published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_MESSAGE (line 59)

PHPDOCUMENTOR_EVENT_MESSAGE : 807

  • deprecated: -

PHPDOCUMENTOR_EVENT_NEWFILE (line 78)

PHPDOCUMENTOR_EVENT_NEWFILE : 811

use to inform ErrorTracker of a new file being parsed

PHPDOCUMENTOR_EVENT_NEWLINENUM (line 80)

PHPDOCUMENTOR_EVENT_NEWLINENUM : 812

use to inform ErrorTracker of the next line number being parsed

PHPDOCUMENTOR_EVENT_NEWSTATE (line 61)

PHPDOCUMENTOR_EVENT_NEWSTATE : 808

use to inform IntermediateParser of a new element being parsed

PHPDOCUMENTOR_EVENT_PACKAGEPAGE (line 69)

PHPDOCUMENTOR_EVENT_PACKAGEPAGE : 809

Package-level page published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_PAGE (line 53)

PHPDOCUMENTOR_EVENT_PAGE : 804

New File (page) published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG (line 75)

PHPDOCUMENTOR_EVENT_README_INSTALL_CHANGELOG : 812

Contents of README/INSTALL/CHANGELOG files published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_TUTORIAL (line 73)

PHPDOCUMENTOR_EVENT_TUTORIAL : 811

Tutorial published to IntermediateParser with this event

PHPDOCUMENTOR_EVENT_VAR (line 51)

PHPDOCUMENTOR_EVENT_VAR : 803

Class Variable published to IntermediateParser with this event

STATE_ACCESS_MODIFIER (line 279)

STATE_ACCESS_MODIFIER : 239

currently parsing an access modifier

STATE_ARRAY (line 162)

STATE_ARRAY : 215

currently parsing an array

STATE_CLASS (line 140)

STATE_CLASS : 211

currently parsing a class definition

STATE_CLASS_CONSTANT (line 289)

STATE_CLASS_CONSTANT : 241

currently parsing a class constant

STATE_CLASS_MEMBER (line 269)

STATE_CLASS_MEMBER : 237

currently parsing a class member using the HighlightParser

STATE_COMMENT (line 110)

STATE_COMMENT : 205

currently parsing a short comment //

STATE_COMMENTBLOCK (line 105)

STATE_COMMENTBLOCK : 204

currently parsing a long comment /x x/ where x is an asterisk

STATE_DEFINE (line 120)

STATE_DEFINE : 207

currently parsing a define statement

STATE_DEFINE_PARAMS (line 125)

STATE_DEFINE_PARAMS : 208

currently parsing the stuff in ( ) of a define statement

STATE_DEFINE_PARAMS_PARENTHESIS (line 187)

STATE_DEFINE_PARAMS_PARENTHESIS : 220

currently parsing an inner parenthetical statement of a define( )

STATE_DESC (line 214)

STATE_DESC : 226

currently parsing the desc part of a docblock

STATE_DOCBLOCK (line 147)

STATE_DOCBLOCK : 212

currently parsing a DocBlock

STATE_DOCBLOCK_TEMPLATE (line 249)

STATE_DOCBLOCK_TEMPLATE : 233

currently parsing the value in a "static $var1 = x" declaration in a function

STATE_DOCKEYWORD (line 152)

STATE_DOCKEYWORD : 213

currently parsing a @tag in a DocBlock

STATE_DOCKEYWORD_EMAIL (line 157)

STATE_DOCKEYWORD_EMAIL : 214

currently parsing an email in brackets in an @author tag of a DocBlock

STATE_END_CLASS (line 142)

STATE_END_CLASS : 311

used to tell Render that a class has been completely parsed, and to flush buffers

STATE_END_DOCBLOCK_TEMPLATE (line 254)

STATE_END_DOCBLOCK_TEMPLATE : 234

currently parsing the value in a "static $var1 = x" declaration in a function

STATE_EOFQUOTE (line 194)

STATE_EOFQUOTE : 222

currently parsing a string defined using Perl <<<

STATE_ESCAPE (line 42)

STATE_ESCAPE : 1000

used when a backslash is encountered in parsing a string or other escapable entity

STATE_FUNCTION (line 172)

STATE_FUNCTION : 217

currently parsing a Function or Method

STATE_FUNCTION_PARAMS (line 130)

STATE_FUNCTION_PARAMS : 209

currently parsing the stuff in ( ) of a function definition

STATE_FUNCTION_PARAM_VAR (line 304)

STATE_FUNCTION_PARAM_VAR : 244

currently parsing a $param in a function definition

STATE_FUNC_GLOBAL (line 234)

STATE_FUNC_GLOBAL : 230

currently parsing a "global $var1, $var2;" declaration in a function

STATE_GLOBAL (line 224)

STATE_GLOBAL : 228

currently parsing a global variable declaration

STATE_GLOBAL_VALUE (line 229)

STATE_GLOBAL_VALUE : 229

currently parsing the default value in a global variable declaration

STATE_IMPLEMENTS (line 284)

STATE_IMPLEMENTS : 240

currently parsing an implements clause

STATE_INCLUDE (line 199)

STATE_INCLUDE : 223

currently parsing an include/require/include_once/include_once

STATE_INCLUDE_PARAMS (line 204)

STATE_INCLUDE_PARAMS : 224

currently parsing the stuff in ( ) of a define statement

STATE_INCLUDE_PARAMS_PARENTHESIS (line 209)

STATE_INCLUDE_PARAMS_PARENTHESIS : 225

currently parsing an inner parenthetical statement of an include/includeonce/require/requireonce( )

STATE_INLINE_DOCKEYWORD (line 182)

STATE_INLINE_DOCKEYWORD : 219

currently parsing an inline tag like { @link} in a DocBlock

STATE_LOGICBLOCK (line 95)

STATE_LOGICBLOCK : 202

currently parsing a { } block

STATE_METHOD (line 259)

STATE_METHOD : 235

currently parsing a method using the HighlightParser

STATE_METHOD_LOGICBLOCK (line 264)

STATE_METHOD_LOGICBLOCK : 236

currently parsing the method body using the HighlightParser

STATE_NOEVENTS (line 100)

STATE_NOEVENTS : 203

out of < ? php tag

STATE_OUTPHP (line 177)

STATE_OUTPHP : 218

currently out of php code

STATE_PHPCODE (line 115)

STATE_PHPCODE : 206

currently parsing php code

STATE_QUOTE (line 90)

STATE_QUOTE : 201

currently parsing a quote

STATE_QUOTE_VAR (line 274)

STATE_QUOTE_VAR : 238

currently parsing a {$encapsed_var} using the HighlightParser

STATE_SINGLEQUOTE (line 135)

STATE_SINGLEQUOTE : 210

currently parsing a string enclosed in single quotes (')

STATE_STATIC_VAR (line 239)

STATE_STATIC_VAR : 231

currently parsing a "static $var1, $var2;" declaration in a function

STATE_STATIC_VAR_VALUE (line 244)

STATE_STATIC_VAR_VALUE : 232

currently parsing the value in a "static $var1 = x" declaration in a function

STATE_TAGS (line 219)

STATE_TAGS : 227

currently parsing the @tag block of a docblock

STATE_VAR (line 167)

STATE_VAR : 216

currently parsing a Class variable

STATE_VAR_ARRAY (line 294)

STATE_VAR_ARRAY : 242

currently parsing a variable value is an array

STATE_VAR_ARRAY_COMMENT (line 299)

STATE_VAR_ARRAY_COMMENT : 243

currently parsing a comment in a variable array value

T_ABSTRACT (line 312)

T_ABSTRACT : 'foo'

T_CONST (line 310)

T_CONST : 'foo'

T_DOC_COMMENT (line 325)

T_DOC_COMMENT : T_ML_COMMENT

T_FINAL (line 316)

T_FINAL : 'foo'

T_IMPLEMENTS (line 317)

T_IMPLEMENTS : 'foo'

T_INTERFACE (line 308)

T_INTERFACE : 'foo'

T_ML_COMMENT (line 321)

T_ML_COMMENT : T_COMMENT

T_PRIVATE (line 313)

T_PRIVATE : 'foo'

T_PROTECTED (line 315)

T_PROTECTED : 'foo'

T_PUBLIC (line 314)

T_PUBLIC : 'foo'

Functions


Documentation generated on Mon, 05 Dec 2011 21:28:36 -0600 by phpDocumentor 1.4.4