Class parserTag

Description
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:
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

  1. function parserTag($keyword$value$noparse false)
  2.     {
  3.         $this->keyword $keyword;
  4.         if (!$noparse{
  5.             $parser new parserDescParser;
  6.             $parser->subscribe('*'$this);
  7.             $parser->parse($value->valuetrue'parserstringwithinlinetags');
  8.         else 
  9.             $this->value $value
  10.         }
  11.     }

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:
getString (line 173)

Returns the text minus any inline tags

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:
HandleEvent (line 162)

Called by the parserDescParser when processing a description.

void HandleEvent (integer $a, array $desc)

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()

Documentation generated on Mon, 05 Dec 2011 21:09:36 -0600 by phpDocumentor 1.4.4