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
- 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
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
$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
getString
()
Constructor parserTag (line 86)
parserTag parserTag( string $keyword, parserStringWithInlineTags $value, [boolean $noparse = false])
Set up the tag
- {
- if (!$noparse) {
- $parser->subscribe('*', $this);
- } else {
- }
- }
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
- return - the text minus any inline tags
- see - parserStringWithInlineTags::getString()
Method HandleEvent (line 162)
void HandleEvent( integer $a, array $desc)
Called by the parserDescParser when processing a description.
Parameters
- integer $a: not used
- array $desc: array of parserStringWithInlineTags representing paragraphs in the tag description
Info
- see - parserTag::parserTag()
- todo - CS cleanup - rename to handleEvent for camelCase rule