Docs For Class parserStringWithInlineTags

Description

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

author: Gregory 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
since: 1.0rc1
license: LGPL

Located in /phpDocumentor/ParserData.inc (line 776)

parserBase
   |
   --parserStringWithInlineTags

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)

mixed $stringOrInlineTag: either a string or a parserInlineTag

Redefined in descendants as:

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

Convert (line 924)

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

see: Converter::returnSee()
todo: CS cleanup - rename to convert for camelCase rule

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:

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

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)

return: trimmed value
uses: parserInlineTag::getString() - removes inline tag length, as it is indeterminate until conversion.

string getString ([bool $trim = true])

bool $trim: whether to trim the string

Redefined in descendants as:

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

hasInlineTag (line 835)

Determine whether the string contains any inline tags

tutorial: phpDocumentor Inline tags

bool hasInlineTag ()

setSource (line 853)

Pass source code to any {@source} 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()