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


Tutorials/Manuals:
Package-level: 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

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

Source Location: /phpDocumentor/ParserDescCleanup.inc

Class Overview

Publisher
 |
 --Parser
 |
 --parserDescParser

Parses a DocBlock description to retrieve abstract representations of


Author(s):

Version:

  • $Id: Parser.inc 238276 2007年06月22日 14:58:30Z ashnazg $

Copyright:

  • 2000-2007 Kellin, Joshua Eichorn

Methods


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 298]
Parses a DocBlock description to retrieve abstract representations of

<pre>,<code>,<p>,<ul>,<ol>,<li>,<b>,<i>




Tags:

author: Greg Beaver <[email protected]>
version: $Id: Parser.inc 238276 2007年06月22日 14:58:30Z ashnazg $
copyright: 2000-2007 Kellin, Joshua Eichorn
since: 1.2


[ Top ]


Class Methods


constructor parserDescParser [line 349]

parserDescParser parserDescParser( )

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens




[ Top ]

method doSimpleList [line 1188]

boolean doSimpleList( string $word)

Return a simple list, if found

This helper function extracts a simple list beginning with any of 'o','-'.'#','+','0','1','0.','1.' and starts parsing it.




Tags:

return: true if a list is found, false otherwise


Parameters:

string $word line that may contain a simple list

[ Top ]

method getParserEventName [line 1462]

void getParserEventName( $value)



Overrides Parser::getParserEventName() (Debugging function, takes an event number and attempts to return its name)

Parameters:

$value

[ Top ]

method parse [line 363]

void parse( array &$parse_data, [boolean $sdesc = false], [string $ind_type = 'parserDesc'])

Parse a long or short description for tags



Tags:

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


Overrides Parser::parse() (Parse a new file)

Parameters:

array &$parse_data array of strings or parserInlineTags
boolean $sdesc true if the description is a short description. (only 1 paragraph allowed in short desc)
string $ind_type name of the class to instantiate for each paragraph. parserDesc for desc/sdesc, parserStringWithInlineTags for tag data

[ Top ]

method setupStates [line 1231]

void setupStates( boolean $sdesc)

setup the parser tokens, and the pushEvent/popEvent arrays



Tags:

global: boolean 0: used to determine whether to slow things down or not by eliminating whitespace from comments


Overrides Parser::setupStates() (setup the parser tokens, and the pushEvent/popEvent arrays)

Parameters:

boolean $sdesc determines whether to allow paragraph parsing

[ Top ]


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

AltStyle によって変換されたページ (->オリジナル) /