Class: PhpdocParserTags

Source Location: /PHPDoc-0.1.0/parser/PhpdocParserTags.php

Class Overview

PhpdocObject
   |
   --PhpdocParserRegExp
      |
      --PhpdocParserTags

Functions used to parse PHPDoc Tags.

Author(s):

Ulf Wendel <mailto:ulf.wendel at phpdoc.de>

Version:

$Id: PhpdocParserTags.php,v 1.4 2002/07/21 21:13:00 derick Exp $

Child classes:

PhpdocParserCore: Provides basic parser functions.

Inherited Variables

Class: PhpdocParserRegExp

PhpdocParserRegExp::$C_BASE
PhpdocParserRegExp::$C_COMPLEX
PhpdocParserRegExp::$PHPDOC_TAGS
PhpdocParserRegExp::$PHP_BASE
PhpdocParserRegExp::$PHP_COMPLEX
PhpdocParserRegExp::$TAGS

Class: PhpdocObject

PhpdocObject::$application
PhpdocObject::$err
PhpdocObject::$flag_output
PhpdocObject::$warn

Inherited Methods

Class: PhpdocParserRegExp

PhpdocParserRegExp::buildComplexRegExps(): Builds complex regular expressions for the parser.

Class: PhpdocObject

PhpdocObject::introspection(): Dumps objects and arrays.
PhpdocObject::nameToUrl(): Encodes an element name so that it can be used as a file name.
PhpdocObject::out(): Print a string and flush the output buffer
PhpdocObject::outl(): Print a string, the specified HTML line break sign and flushes the output buffer
PhpdocObject::setFlagOutput(): Sets the output flag - if set to true out() and outl() print messages

Class Details

[line 7]
Functions used to parse PHPDoc Tags.

Author: Ulf Wendel <mailto:ulf.wendel@phpdoc.de>
Version: $Id: PhpdocParserTags.php,v 1.4 2002/07/21 21:13:00 derick Exp $

[ Top ]

Method Detail

analyseSeeTagRegs [line 563]

array analyseSeeTagRegs(
array
$regs)

Helperfunction to analyse see tags

Return: $see[0] = error, $see[1] = data
See: PhpdocParserTags::analyseTags()

Parameters:

array $regs — Array return by preg_match()

[ Top ]

analyseTags [line 19]

array analyseTags(
array
$tags, array
$data, array
$allowed)

Extract the value from the given tags and copy the data to the $data array if its an allowed tag

See: PhpdocParserTags::getTags(), analyseVariableParagraphs(), analyseFunctionParagraphs(), analyseClassParagraphs(), analyseSeeTags()
Throws: PhpdocError

Parameters:

array	`$tags`	—	array of tags returned by getTags
array	`$data`	—	array where the allowed tags and their values are copied to
array	`$allowed`	—	array of allowed (recognized) tags

[ Top ]

checkParserErrors [line 689]

array checkParserErrors(
array
$data, string
$mode)

Takes an array filled by analyseTags() and converts the parse errors into a single error message.

Checks for [syntaxerror], [notallowed] and [unknown] entries in the data hash, converts them into an error message and unsets the indizes. The function returns a hash containing the aggregates error message and the modified data hash.

Return: array( $error_msg, $data )

Parameters:

array	`$data`	—
string	`$mode`	—	Keyword where the data hash comes from eg. function/class...

[ Top ]

getTagPos [line 656]

array getTagPos(
string
$phpdoc, [integer
$offset = 0])

Find the position of the next phpdoc tag.

Return:
1. => tag, 1 => offset
See: findTags()

Parameters:

string	`$phpdoc`	—
integer	`$offset`	—

[ Top ]

getTags [line 619]

array getTags(
string
$phpdoc)

Extracts PHPDoc tags from a PHPDoc doc comment.

Return: List of tags ordered by their appearance containing the tag name and it's (unparsed) value.
See: PhpdocParserTags::getTagPos()

Parameters:

string $phpdoc — Doc comment.

[ Top ]