Class parserDescVar

(line 227)

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDescVar

Located in File: /phpDocumentor/DescHTML.inc

Used for <var> in a description


Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
string Convert (Converter &$c)

Method Convert (line 238)

string Convert( Converter &$c)

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

performs the conversion of variable tags

Parameters

Info

  • return - the converted pre block
  • todo - CS cleanup - rename method to convert()
  • uses - Converter::Varize()

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$type - Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...

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:06 -0600 by phpDocumentor 1.4.4