Docs For Class parserStringWithInlineTags

void add(
mixed
$stringOrInlineTag)

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

Overridden in child classes as:

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

parserDesc::add()

Parameters:

mixed $stringOrInlineTag — either a string or a parserInlineTag

[ Top ]

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

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

Overridden in child classes as:

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

parserCData::Convert(): calls the output conversion

parserXMLDocBookTag::Convert(): calls the output conversion

parserPackagePage::Convert()

parserTutorial::Convert()

Parameters:

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

[ Top ]

string getString(
[bool
$trim = true])

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.

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'

Parameters:

bool $trim — whether to trim the string

[ Top ]

bool hasInlineTag(
)

Determine whether the string contains any inline tags

Tutorial: phpDocumentor Inline tags

[ Top ]

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

[ Top ]

integer trimmedStrlen(
)

equivalent to trim(strlen($string))

Return: length of the string this object represents

[ Top ]

Class: parserStringWithInlineTags

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class: parserBase

Class Details

Class Variables

$type = '_string'

$value = array()

Method Detail

add [line 804]

Parameters:

Convert [line 924]

Parameters:

getString [line 896]

Parameters:

hasInlineTag [line 835]

setSource [line 853]

Parameters:

trimmedStrlen [line 868]