Docs For Class parserTag

Description

used to represent standard tags like @access, etc.

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

author: Greg Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
todo: CS cleanup - change classname to PhpDocumentor_*
since: 1.0rc1
license: LGPL

Located in /phpDocumentor/DocBlockTags.inc (line 62)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag

Direct descendents

Class	Description
parserNameTag	This class represents the @name tag
parserAccessTag	This class represents the @access tag
parserReturnTag	represents the "@return" tag
parserLinkTag	represents the "@link" tag
parserFileSourceTag	represents "@filesource"

Variable Summary

string $keyword

string $type

Method Summary

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

string Convert (Converter &$converter)

string getString ()

void HandleEvent (integer $a, array $desc)

Variables

string $keyword = '' (line 74)

tag name (see, access, etc.)

Redefined in descendants as:

parserNameTag::$keyword : tag name
parserAccessTag::$keyword : tag name
parserReturnTag::$keyword : always 'return'
parserPropertyTag::$keyword : always 'property'
parserPropertyReadTag::$keyword : always 'property-read'
parserPropertyWriteTag::$keyword : always 'property-write'
parserMethodTag::$keyword : always 'method'
parserVarTag::$keyword : always 'var'
parserParamTag::$keyword : always 'param'
parserStaticvarTag::$keyword : always 'staticvar'
parserLinkTag::$keyword : always 'link'
parserSeeTag::$keyword : always 'see'
parserUsesTag::$keyword : Always "uses"
parserUsedByTag::$keyword : Always "usedby"
parserTutorialTag::$keyword : Always "tutorial"
parserLicenseTag::$keyword : always 'license'
parserFileSourceTag::$keyword : Always "filesource"
parserExampleTag::$keyword : always "example"

string $type = '_tag' (line 69)

Type is used by many functions to skip the hassle of

if phpDocumentor_get_class($blah) == 'parserBlah' always '_tag'

Redefinition of:

parserStringWithInlineTags::$type: Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...

Inherited Variables

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserTag (line 86)

Set up the tag

function parserTag($keyword, $value, $noparse = false)
{
$this->keyword = $keyword;
if (!$noparse) {
$parser = new parserDescParser;
$parser->subscribe('*', $this);
$parser->parse($value->value, true, 'parserstringwithinlinetags');
} else {
$this->value = $value;
}
}

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

string $keyword: tag name
parserStringWithInlineTags $value: tag value
boolean $noparse: whether to parse the $value for html tags

Convert (line 108)

Perform the output conversion on this parserTag using the output converter that is passed in

see: Converter
todo: CS cleanup - rename to convert for camelCase rule

string Convert (Converter &$converter)

Converter &$converter: the converter object

Redefinition of:

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

Redefined in descendants as:

parserNameTag::Convert() : process this tag through the given output converter
parserAccessTag::Convert() : process this tag through the given output converter
parserReturnTag::Convert() : process this tag through the given output converter (sets up the $converted_returnType)
parserSeeTag::Convert() : process this tag through the given output converter
parserUsesTag::Convert() : Return a link to documentation for other element, and description of how it is used
parserUsedByTag::Convert() : process this tag through the given output converter
parserTutorialTag::Convert() : process this tag through the given output converter
parserFileSourceTag::Convert() : Return a link to the highlighted source and generate the source

getString (line 173)

Returns the text minus any inline tags

return: the text minus any inline tags
see: parserStringWithInlineTags::getString()

string getString ()

Redefinition of:

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 is in the string)

Redefined in descendants as:

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

HandleEvent (line 162)

Called by the parserDescParser when processing a description.

see: parserTag::parserTag()
todo: CS cleanup - rename to handleEvent for camelCase rule

void HandleEvent (integer $a, array $desc)

integer $a: not used
array $desc: array of parserStringWithInlineTags representing paragraphs in the tag description

Inherited Methods

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

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