Class: parserStringWithInlineTags

Source Location: /PhpDocumentor-1.4.0RC1/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 <cellog at php.net>

Version:

$Id: ParserData.inc,v 1.8 2007/04/24 21:27:43 ashnazg Exp $

Variables

$type
$value

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

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.

parserCData: Represents <![CDATA[ ]]> sections.

parserXMLDocBookTag: a standard XML DocBook Tag

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

parserPackagePage

Inherited Variables

Inherited Methods

Class: parserBase

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

Class Details

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

Author: Greg Beaver <cellog@php.net>
Version: $Id: ParserData.inc,v 1.8 2007/04/24 21:27:43 ashnazg Exp $
Since: 1.0rc1

[ Top ]

Class Variables

$type = '_string'

[line 630]

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

always '_string'

Type:	string
Overrides:	Array

[ Top ]

$value = array()

[line 639]

array of strings and parserInlineTags

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

Type:	array
Overrides:	Array

[ Top ]

Method Detail

add [line 645]

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 ]

Convert [line 758]

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

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

See: Converter::returnSee()

Overridden in child classes as:

parserCode::Convert()

parserPre::Convert()

parserB::Convert()

parserI::Convert()

parserDescVar::Convert()

parserSamp::Convert()

parserKbd::Convert()

parserBr::Convert()

parserList::Convert()

parserTag::Convert()

parserNameTag::Convert()

parserAccessTag::Convert()

parserReturnTag::Convert(): sets up $converted_returnType

parserSeeTag::Convert()

parserUsesTag::Convert(): Return a link to documentation for other element, and description of how it is used

parserUsedByTag::Convert()

parserTutorialTag::Convert()

parserFileSourceTag::Convert(): Return a link to the highlighted source and generate the source

parserCData::Convert()

parserXMLDocBookTag::Convert()

parserPackagePage::Convert()

parserTutorial::Convert()

Parameters:

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

[ Top ]

getString [line 734]

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

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

Parameters:

$trim —

[ Top ]

hasInlineTag [line 675]

boolean hasInlineTag(
)

Determine whether the string contains any inline tags

Tutorial: phpDocumentor Inline tags

[ Top ]

setSource [line 689]

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 ]

trimmedStrlen [line 704]

integer trimmedStrlen(
)

equivalent to trim(strlen($string))

Return: length of the string this object represents

[ Top ]