phpDocumentor phpDocumentor

Parsers

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

phpDocumentor

FAQ

Packages:

phpDocumentor
Converters

Tutorials/Manuals:

Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

actions.php
bug-560532.php
bug-772441.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
file_dialog.php
HighlightParserTests.php
IntermediateParser.inc
IntermediateParserTests.php
Io.inc
new_phpdoc.php
ParserClassTests.php
ParserDescCleanup.inc
ParserPageTests.php
phpdoc.inc
phpdoc.php
phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

DescHTML
DescHTML.inc

DocBlockTags
DocBlockTags.inc

Errors
Errors.inc

InlineTags
InlineTags.inc

Links
LinkClasses.inc

ParserData
ParserData.inc

ParserDocBlock
ParserDocBlock.inc

ParserElements
ParserElements.inc

Parsers
Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

setup
find_phpdoc.php

Tutorial
PackagePageElements.inc

WordParsers
phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
Parser
parserDescParser
phpDocumentorTParser
phpDocumentor_HighlightParser
phpDocumentor_HighlightWordParser
phpDocumentor_peardoc2_XML_Beautifier
phpDocumentor_TutorialHighlightParser
phpDocumentor_XML_Beautifier_Tokenizer
ppageParser
XMLPackagePageParser

bug_772441
Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

DescHTML
parserB
parserBr
parserCode
parserDescVar
parserI
parserKbd
parserList
parserPre
parserSamp

DocBlockTags
parserAccessTag
parserExampleTag
parserFileSourceTag
parserLicenseTag
parserLinkTag
parserMethodTag
parserNameTag
parserParamTag
parserPropertyReadTag
parserPropertyTag
parserPropertyWriteTag
parserReturnTag
parserSeeTag
parserStaticvarTag
parserTag
parserTutorialTag
parserUsedByTag
parserUsesTag
parserVarTag

Errors
ErrorTracker
RecordError
RecordWarning

InlineTags
parserExampleInlineTag
parserIdInlineTag
parserInheritdocInlineTag
parserInlineTag
parserLinkInlineTag
parserSourceInlineTag
parserTocInlineTag
parserTutorialInlineTag

Links
abstractLink
classLink
constLink
defineLink
functionLink
globalLink
methodLink
pageLink
tutorialLink
varLink

Tutorial
parserCData
parserEntity
parserXMLDocBookTag

ParserData
parserBase
parserData
parserPage
parserStringWithInlineTags

WordParsers
ObjectWordParser
phpDocumentorTWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
parserClass
parserConst
parserDefine
parserElement
parserFunction
parserGlobal
parserInclude
parserMethod
parserPackagePage
parserTutorial
parserVar

Class: phpDocumentorTParser

Source Location: /phpDocumentor/phpDocumentorTParser.inc

Class phpDocumentorTParser

Class Overview

Tokenizer-based parser for PHP source code

Located in /phpDocumentor/phpDocumentorTParser.inc [line 56]

Publisher
 |
 --Parser
 |
 --phpDocumentorTParser

Author(s):

Gregory Beaver <[email protected]>

Information Tags:

Version: Release: @VER@

Copyright: 2002-2008 Gregory Beaver

Link: http://pear.php.net/PhpDocumentor

Link: http://www.phpdoc.org

Todo: CS cleanup - change package to PhpDocumentor

Todo: CS cleanup - change classname to PhpDocumentor_*

License: LGPL

Properties

Methods

[ Top ]

Descendants

Child Class	Description
phpDocumentor_HighlightParser	Highlights source code using parse()

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Publisher Publisher::$subscriber	Inherited From Parser Parser::Parser() Set up invariant parsing variables Parser::categoryTagHandler() handles @category 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::defaultTagHandler() Handles all standard tags that only have a description Parser::endTag() Called to clean up at the end of parsing a @tag in a docblock Parser::exampleTagHandler() handles @example Parser::getParserEventName() Debugging function, takes an event number and attempts to return its name Parser::globalTagHandler() handles @global Parser::invalidTagHandler() Handles tags like '@filesource' that only work in PHP 4.3.0+ Parser::packageTagHandler() handles @package Parser::paramTagHandler() handles @param Parser::parse() Parse a new file Parser::propertyTagHandler() Handles @property(-read or -write) and @method magic tag Parser::returnTagHandler() handles @return Parser::setupStates() setup the parser tokens, and the pushEvent/popEvent arrays Parser::staticvarTagHandler() handles @staticvar Parser::usesTagHandler() handles @uses Parser::varTagHandler() handles @var Inherited From Publisher Publisher::publishEvent() Publish an event Publisher::subscribe() Adds a subscriber to the $subscriber array().

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Publisher

Publisher::$subscriber

Inherited From Parser

Parser::Parser()

Set up invariant parsing variables

Parser::categoryTagHandler()

handles @category

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::defaultTagHandler()

Handles all standard tags that only have a description

Parser::endTag()

Called to clean up at the end of parsing a @tag in a docblock

Parser::exampleTagHandler()

handles @example

Parser::getParserEventName()

Debugging function, takes an event number and attempts to return its name

Parser::globalTagHandler()

handles @global

Parser::invalidTagHandler()

Handles tags like '@filesource' that only work in PHP 4.3.0+

Parser::packageTagHandler()

handles @package

Parser::paramTagHandler()

handles @param

Parser::parse()

Parse a new file

Parser::propertyTagHandler()

Handles @property(-read or -write) and @method magic tag

Parser::returnTagHandler()

handles @return

Parser::setupStates()

setup the parser tokens, and the pushEvent/popEvent arrays

Parser::staticvarTagHandler()

handles @staticvar

Parser::usesTagHandler()

handles @uses

Parser::varTagHandler()

handles @var

Inherited From Publisher

Publisher::publishEvent()

Publish an event

Publisher::subscribe()

Adds a subscriber to the $subscriber array().

[ Top ]

Property Summary

mixed $eventHandlers

mixed $inlineTagHandlers

string $source_location relative path of the parsed file from the base parse directory

[ Top ]

Method Summary

phpDocumentorTParser phpDocumentorTParser() Constructor

bool parse() Parse a new file

[ Top ]

Properties

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]

[ Top ]

mixed $inlineTagHandlers = array(
'*' => 'handleDefaultInlineTag',
'link' => 'handleLinkInlineTag',
) [line 188]

[ Top ]

string $source_location [line 146]

relative path of the parsed file from the base parse directory

[ Top ]

Methods

Constructor phpDocumentorTParser [line 197]

phpDocumentorTParser phpDocumentorTParser(
)

Constructor

[ Top ]

parse [line 225]

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

Parse a new file

Parameters:

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: ???

API Tags:

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

Redefinition of:

Parser::parse(): Parse a new file

Redefined in descendants as:

phpDocumentor_HighlightParser::parse() : Parse a new file

[ Top ]

Documentation generated on 2011年12月06日 07:21:11 -0600 by phpDocumentor 1.4.4