Class: parserDescParser

Source Location: /PhpDocumentor-1.4.0/phpDocumentor/ParserDescCleanup.inc

Class Overview

Publisher
   |
   --Parser
      |
      --parserDescParser

Parses a DocBlock description to retrieve abstract representations of

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: Parser.inc,v 1.9 2007/06/22 14:58:30 ashnazg Exp $

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()
Publisher::subscribe(): Adds a subscriber to the $subscriber array().

Class Details

[line 298]
Parses a DocBlock description to retrieve abstract representations of

Tutorial: phpDocumentor Tutorial
Author: Greg Beaver <cellog@php.net>
Version: $Id: Parser.inc,v 1.9 2007/06/22 14:58:30 ashnazg Exp $
Since: 1.2

[ Top ]

Method Detail

parserDescParser (Constructor) [line 349]

parserDescParser parserDescParser(
)

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens

[ Top ]

doSimpleList [line 1176]

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.

Return: true if a list is found, false otherwise

Parameters:

string $word — line that may contain a simple list

[ Top ]

getParserEventName [line 1450]

void getParserEventName(

$value)

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

Parameters:

$value —

[ Top ]

parse [line 363]

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

Parse a long or short description for tags

Staticvar: integer $endrecur: used for recursion limiting if a handler for an event is not found
Usedby: parserDocBlock::postProcess()

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 [line 1219]

void setupStates(
boolean
$sdesc)

setup the parser tokens, and the pushEvent/popEvent arrays

Global: boolean 0: used to determine whether to slow things down or not by eliminating whitespace from comments
See: Publisher::$tokens, Publisher::$pushEvent, Publisher::$popEvent

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

Parameters:

boolean $sdesc — determines whether to allow paragraph parsing

[ Top ]