Class: parserDescParser

Source Location: /phpDocumentor/ParserDescCleanup.inc

Class Overview [line 298]

Publisher
   |
   --Parser
      |
      --parserDescParser

Variables

Constants

Methods


Inherited Variables

Inherited Constants

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 [email protected]' 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

Parses a DocBlock description to retrieve abstract representations of

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

Tags:

[ Top ]


Class Variables


Class Methods

parserDescParser

parserDescParser parserDescParser( )

[line 349]

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens

Parameters:

[ Top ]

doSimpleList

boolean doSimpleList( string $word)

[line 1188]

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 ]

getParserEventName

void getParserEventName( $value)

[line 1462]

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

Parameters:

  • $value -

[ Top ]

parse

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

[line 363]

Parse a long or short description for tags

Tags:

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 ]

setupStates

void setupStates( boolean $sdesc)

[line 1231]

setup the parser tokens, and the pushEvent/popEvent arrays

Tags:

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

Parameters:

  • boolean $sdesc - determines whether to allow paragraph parsing

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:15 -0600 by phpDocumentor 1.4.4