Class parserStringWithInlineTags

Description
Direct descendents
Class Description
parserCData Represents <![CDATA[ ]]> sections.
parserXMLDocBookTag a standard XML DocBook Tag
parserCode Used for <code> in a description
parserPre Used for <pre> in a description
parserB Used for <b> in a description
parserI Used for <i> in a description
parserDescVar Used for <var> in a description
parserSamp Used for <samp> in a description
parserKbd Used for <kbd> in a description
parserBr Used for <br> in a description
parserList Used for lists <ol> and <ul>
parserTag used to represent standard tags like @access, etc.
parserPackagePage
parserDesc represents a short or long description in a DocBlock (parserDocBlock)
Variable Summary
string $type
array $value
Method Summary
void add (mixed $stringOrInlineTag)
string Convert (Converter &$converter, [bool $postprocess = true], [bool $trim = true])
string getString ([bool $trim = true])
bool hasInlineTag ()
void setSource (string|array $source)
integer trimmedStrlen ()
Variables
string $type = '_string' (line 784)

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

always '_string'


Redefinition of:
parserBase::$type
Type is used by many functions to skip the hassle of if

Redefined in descendants as:
  • parserTag::$type : Type is used by many functions to skip the hassle of
  • parserPackagePage::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
  • parserTutorial::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
  • parserDesc::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
array $value = array() (line 795)

array of strings and parserInlineTags

Format: array(string1,string2,parserInlineTag1,string3,parserInlineTag2,...)


Redefinition of:
parserBase::$value
set to different things by its descendants
Methods
add (line 804)

equivalent to the . operator ($a = $b . $c)

void add (mixed $stringOrInlineTag)

Redefined in descendants as:
Convert (line 924)

Use to convert the string to a real string with all inline tags parsed and linked

string Convert (Converter &$converter, [bool $postprocess = true], [bool $trim = true])
  • Converter &$converter: the output converter
  • bool $postprocess: true if one needs to postprocess
  • bool $trim: false if the output should not be trimmed

Redefined in descendants as:
getString (line 896)

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)

string getString ([bool $trim = true])
  • bool $trim: whether to trim the string

Redefined in descendants as:
hasInlineTag (line 835)

Determine whether the string contains any inline tags

bool hasInlineTag ()
setSource (line 853)

Pass source code to any [email protected]} tags contained within the string for later conversion.

void setSource (string|array $source)
  • string|array $source: source code ready to be highlighted
trimmedStrlen (line 868)

equivalent to trim(strlen($string))

  • return: length of the string this object represents
integer trimmedStrlen ()

Inherited Methods

Inherited From parserBase

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

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