Class: parserTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag

used to represent standard tags like @access, etc.

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $

Variables

Methods

Child classes:

parserNameTag: used to represent standard tags like @access, etc.

parserAccessTag: used to represent standard tags like @access, etc.

parserReturnTag: represents "@return"

parserLinkTag: represents "@link"

parserSourceTag: represents "@source"

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$cache
parserStringWithInlineTags::$value

Class: parserBase

parserBase::$linenum

Inherited Methods

Class: parserStringWithInlineTags

parserStringWithInlineTags::add(): equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString(): return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 18]
used to represent standard tags like @access, etc.

This class is aware of inline tags, and will automatically handle them using inherited functions

Version: $Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$keyword = ''

[line 30]

tag name (see, access, etc.)

Type:

string

[ Top ]

$type = '_tag'

[line 25]

Type is used by many functions to skip the hassle of if get_class($blah) == 'parserBlah'

always '_tag'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserTag (Constructor) [line 36]

parserTag parserTag(
string
$keyword, parserStringWithInlineTags
$value, [mixed
$noparse = false])

Parameters:

string	`$keyword`	—	tag name
parserStringWithInlineTags	`$value`	—

[ Top ]

Convert [line 51]

void Convert(
Converter
&$converter)

See: Converter

Overridden in child classes as:

parserNameTag::Convert()

parserAccessTag::Convert()

parserReturnTag::Convert(): sets up $converted_returnType

parserSeeTag::Convert()

parserUsedByTag::Convert()

parserTutorialTag::Convert()

parserSourceTag::Convert()

Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)

Parameters:

Converter &$converter —

[ Top ]

getString [line 74]

string getString(
)

Return: returns the text minus any inline tags
See: parserStringWithInlineTags::getString()

Overridden in child classes as:

parserAccessTag::getString(): No inline tags are possible, returns 'public' or 'private'

Overrides parserStringWithInlineTags::getString() (return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text)

[ Top ]

HandleEvent [line 65]

void HandleEvent(
mixed
$a, mixed
$desc)

[ Top ]