Class parserDescParser

(line 298)

Description

Publisher
   |
   --Parser
      |
      --parserDescParser

Located in File: /phpDocumentor/ParserDescCleanup.inc

Parses a DocBlock description to retrieve abstract representations of

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



Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
parserDescParser parserDescParser ()
boolean doSimpleList (string $word)
void getParserEventName ( $value)
void parse (array &$parse_data, [boolean $sdesc = false], [string $ind_type = 'parserDesc'])
void setupStates (boolean $sdesc)

Constructor parserDescParser (line 349)

parserDescParser parserDescParser( )

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens

Info

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.

Parameters

  • string $word: line that may contain a simple list

Info

  • return - true if a list is found, false otherwise

Method getParserEventName (line 1462)

void getParserEventName( $value)

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

Parameters

  • $value:

Info

Method parse (line 363)

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

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

Parse a long or short description for tags

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

Info

Method setupStates (line 1231)

void setupStates( boolean $sdesc)

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

setup the parser tokens, and the pushEvent/popEvent arrays

Parameters

  • boolean $sdesc: determines whether to allow paragraph parsing

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Publisher

Publisher::$subscriber - Array of references objects that have Subscribed to this publisher

Inherited Methods

Inherited Method Summary

Inherited From 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


Inherited From Class Publisher

Publisher::publishEvent() - Publish an event

Publisher::subscribe() - Adds a subscriber to the $subscriber array().



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