phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier


Tutorials/Manuals:
В пакете: Files:
actions.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
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

subpackage DescHTML
DescHTML.inc

subpackage DocBlockTags
DocBlockTags.inc

subpackage Errors
Errors.inc

subpackage InlineTags
InlineTags.inc

subpackage Links
LinkClasses.inc

subpackage ParserData
ParserData.inc

subpackage ParserDocBlock
ParserDocBlock.inc

subpackage ParserElements
ParserElements.inc

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

subpackage setup
find_phpdoc.php

subpackage Tutorial
PackagePageElements.inc

subpackage 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
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 Overview

Publisher
   |
   --Parser
      |
      --phpDocumentorTParser

Tokenizer-based parser for PHP source code


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods

Child classes:

phpDocumentor_HighlightParser
Highlights source code using parse()

Inherited Variables

Class: Publisher

Publisher::$subscriber

Inherited Methods

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

Class: Publisher

Publisher::publishEvent()
Publish an event
Publisher::subscribe()
Adds a subscriber to the $subscriber array().

Class Details

[line 56]
Tokenizer-based parser for PHP source code



Tags:

author:  Gregory Beaver <cellog@php.net>
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


[ Top ]

Class Variables

$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]


Type:  mixed


[ Top ]

$inlineTagHandlers = array(
        '*'    => 'handleDefaultInlineTag',
        'link' => 'handleLinkInlineTag',
    )

[line 188]


Type:  mixed


[ Top ]

$source_location =

[line 146]

relative path of the parsed file from the base parse directory


Type:  string


[ Top ]


Class Methods

constructor phpDocumentorTParser [line 197]

phpDocumentorTParser phpDocumentorTParser( )

Constructor



[ Top ]

method parse [line 225]

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

Parse a new file



Tags:

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


Overridden in child classes as:

phpDocumentor_HighlightParser::parse()
Parse a new file

Overrides Parser::parse() (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  ???

[ Top ]
    Поддержать сайт на родительском проекте КГБ