Class parserTag

(line 62)

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag

Located in File: /phpDocumentor/DocBlockTags.inc

used to represent standard tags like @access, etc.

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



Classes extended from parserTag:
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"

Class Variables

Summary:
string $keyword
string $type

$keyword = '' (line 74)

Data type : string

tag name (see, access, etc.)

$type = '_tag' (line 69)

Data type : string

Overrides: Array

Type is used by many functions to skip the hassle of

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

Class Constants

Summary:

Method Detail

Summary:
parserTag parserTag (string $keyword, parserStringWithInlineTags $value, [boolean $noparse = false])
string Convert (Converter &$converter)
string getString ()
void HandleEvent (integer $a, array $desc)

Constructor parserTag (line 86)

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

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.     }

Parameters

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

Info

Method Convert (line 108)

string Convert( Converter &$converter)

Overridden in child classes 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

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

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

Parameters

  • Converter &$converter: the converter object

Info

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

Method getString (line 173)

string getString( )

Overridden in child classes as:

parserAccessTag::getString()
No inline tags are possible, returns 'public', 'protected' 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 is in the string)

Returns the text minus any inline tags

Info

Method HandleEvent (line 162)

void HandleEvent( integer $a, array $desc)

Called by the parserDescParser when processing a description.

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

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

parserStringWithInlineTags::hasInlineTag() - Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource() - Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen() - equivalent to trim(strlen($string))


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



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