Class parserStringWithInlineTags

(line 776)

Description

parserBase
   |
   --parserStringWithInlineTags

Located in File: /phpDocumentor/ParserData.inc

Used to represent strings that contain inline tags, so that they can be properly parsed at link time


Classes extended from parserStringWithInlineTags:
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)

Class Variables

Summary:
string $type
array $value

$type = '_string' (line 784)

Data type : string

Overrides: Array

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

always '_string'

$value = array() (line 795)

Data type : array

Overrides: Array

array of strings and parserInlineTags

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

Class Constants

Summary:

Method Detail

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 ()

Method add (line 804)

void add( mixed $stringOrInlineTag)

Overridden in child classes as:

parserXMLDocBookTag::add()
Add contents to this tag.
parserDesc::add()

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

Parameters

Info

Method Convert (line 924)

string Convert( Converter &$converter, [bool $postprocess = true], [bool $trim = true])

Overridden in child classes as:

parserCData::Convert()
calls the output conversion
parserXMLDocBookTag::Convert()
calls the output conversion
parserCode::Convert()
performs the conversion of code tags
parserPre::Convert()
performs the conversion of code tags
parserB::Convert()
performs the conversion of bold tags
parserI::Convert()
performs the conversion of italic tags
parserDescVar::Convert()
performs the conversion of variable tags
parserSamp::Convert()
performs the conversion of sample tags
parserKbd::Convert()
performs the conversion of keyboard tags
parserBr::Convert()
performs the conversion of linebreak tags
parserList::Convert()
performs the conversion of list tags
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
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
parserPackagePage::Convert()
parserTutorial::Convert()

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

Parameters

  • Converter &$converter: the output converter
  • bool $postprocess: true if one needs to postprocess
  • bool $trim: false if the output should not be trimmed

Info

Method getString (line 896)

string getString( [bool $trim = true])

Overridden in child classes as:

parserTag::getString()
Returns the text minus any inline tags
parserAccessTag::getString()
No inline tags are possible, returns 'public', 'protected' or 'private'

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

  • bool $trim: whether to trim the string

Info

Method hasInlineTag (line 835)

bool hasInlineTag( )

Determine whether the string contains any inline tags

Info

Method setSource (line 853)

void setSource( string|array $source)

Pass source code to any {@source} tags contained within the string for later conversion.

Parameters

  • string|array $source: source code ready to be highlighted

Info

Method trimmedStrlen (line 868)

integer trimmedStrlen( )

equivalent to trim(strlen($string))

Info

  • return - length of the string this object represents

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary

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