phpDocumentor phpDocumentor
DocBlockTags
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserTag

Class Overview

used to represent standard tags like @access, etc.

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

Located in /phpDocumentor/DocBlockTags.inc [line 52]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
Author(s): Information Tags:
Version:  $Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Since:  1.0rc1

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
parserNameTag This class represents the @name tag
parserAccessTag This class represents the @access tag
parserReturnTag represents "@return"
parserLinkTag represents "@link"
parserFileSourceTag represents "@filesource"

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From 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
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 parserBase

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

[ Top ]
Property Summary
string   $keyword   tag name (see, access, etc.)
string   $type   Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]
Method Summary
parserTag   parserTag()   Set up the tag
void   Convert()  
string   getString()  
void   HandleEvent()   Called by the parserDescParser when processing a description.

[ Top ]
Properties
string   $keyword = '' [line 64]

tag name (see, access, etc.)


Redefined in descendants as:

[ Top ]
string   $type = '_tag' [line 59]

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'

[ Top ]
Methods
Constructor parserTag  [line 74]

  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.         {
  6.             $parser new parserDescParser;
  7.             $parser->subscribe('*',$this);
  8.             $parser->parse($value->value,true,'parserstringwithinlinetags');
  9.         else $this->value $value;
  10.     }

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


[ Top ]
Convert  [line 89]

  void Convert( Converter &$converter  )

Parameters:
Converter   &$converter: 

API Tags:
See:  Converter


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

Redefined in descendants as:

[ Top ]
getString  [line 147]

  string getString( )


API Tags:
Return:  returns the text minus any inline tags
See:  parserStringWithInlineTags::getString()


Redefinition of:
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this

Redefined in descendants as:

[ Top ]
HandleEvent  [line 138]

  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

API Tags:
See:  parserTag::parserTag()


[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:21 -0500 by phpDocumentor 1.3.1