Class: parserStringWithInlineTags

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserData.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags

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

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserData.inc,v 1.72 2003/01/17 07:01:29 CelloG Exp $

Variables

Methods

Child classes:

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

parserBr: Used for <br> in a description

parserList: Used for lists <ol> and <ul>

parserTag: used to represent standard tags like @access, etc.

parserCData

parserXMLDocBookTag: a standard XML DocBook Tag

parserDesc: represents a short or long description in a DocBlock (parserDocBlock)

parserPackagePage

Inherited Variables

Class: parserBase

parserBase::$linenum

Inherited Methods

Class: parserBase

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

Class Details

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

Version: $Id: ParserData.inc,v 1.72 2003/01/17 07:01:29 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$cache = false

[line 481]

Type:

mixed

[ Top ]

$type = '_string'

[line 480]

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

always '_string'

Type:	string
Overrides:	Array

[ Top ]

$value = array()

[line 488]

array of strings and parserInlineTags

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

Type:	array
Overrides:	Array

[ Top ]

Method Detail

add [line 494]

void add(
mixed
$stringOrInlineTag)

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

Overridden in child classes as:

parserXMLDocBookTag::add()

parserDesc::add()

Parameters:

mixed $stringOrInlineTag — either a string or a parserInlineTag

[ Top ]

Convert [line 584]

void Convert(
Converter
&$converter, [boolean
$postprocess = true])

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

Usedby: HTMLSmartyConverter::postProcess()
Usedby: HTMLframesConverter::postProcess()
Usedby: HTMLdefaultConverter::postProcess()
Usedby: CHMdefaultConverter::postProcess()
See: Converter::returnSee()

Overridden in child classes as:

parserCode::Convert()

parserPre::Convert()

parserB::Convert()

parserI::Convert()

parserBr::Convert()

parserList::Convert()

parserTag::Convert()

parserNameTag::Convert()

parserAccessTag::Convert()

parserReturnTag::Convert(): sets up $converted_returnType

parserSeeTag::Convert()

parserUsedByTag::Convert()

parserTutorialTag::Convert()

parserSourceTag::Convert()

parserCData::Convert()

parserXMLDocBookTag::Convert()

parserPackagePage::Convert()

parserTutorial::Convert()

Parameters:

Converter	`&$converter`	—
boolean	`$postprocess`	—	true if one needs to postprocess

[ Top ]

getString [line 561]

string getString(
[mixed
$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

Overridden in child classes as:

parserTag::getString()

parserAccessTag::getString(): No inline tags are possible, returns 'public' or 'private'

[ Top ]

setSource [line 519]

void setSource(
mixed
$source)

[ Top ]

trimmedStrlen [line 534]

integer trimmedStrlen(
)

equivalent to trim(strlen($string))

Return: length of the string this object represents

[ Top ]