Class: parserTag

[line 74]

tag name (see, access, etc.)

Type: string

Overrides:

[line 69]

Type is used by many functions to skip the hassle of

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

Type: string

Overrides: Array

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

[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->value, true, '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

string Convert( Converter &$converter)

[line 108]

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

Tags:

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

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)

Parameters:

• Converter &$converter - the converter object

string getString( )

[line 173]

Returns the text minus any inline tags

Tags:

• return - the text minus any inline tags
• see - parserStringWithInlineTags::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))

Parameters:

void HandleEvent( integer $a, array $desc)

[line 162]

Called by the parserDescParser when processing a description.

Tags:

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

Parameters:

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