Class: parserStringWithInlineTags

Source Location: /phpDocumentor/ParserData.inc

Class parserStringWithInlineTags

Class Overview

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

Located in /phpDocumentor/ParserData.inc [line 615]

parserBase
   |
   --parserStringWithInlineTags

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserData.inc,v 1.6 2006/10/23 04:02:46 cellog Exp $
Since:	1.0rc1

Properties

$type
$value

Methods

[ Top ]

Direct descendents

Child Class	Description
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

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string	$type	Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
array	$value	array of strings and parserInlineTags

[ Top ]

Method Summary

void	add()	equivalent to the . operator ($a = $b . $c)
void	Convert()	Use to convert the string to a real string with all inline tags parsed and linked
string	getString()	return the string unconverted (all inline tags are taken out - this
boolean	hasInlineTag()	Determine whether the string contains any inline tags
void	setSource()	Pass source code to any {@source} tags contained within the string for later conversion.
integer	trimmedStrlen()	equivalent to trim(strlen($string))

[ Top ]

Properties

string $type = '_string' [line 622]

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 phpDocumentor_get_class($blah) == 'parserBlah'

Redefined in descendants as:

parserTag::$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'
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'

[ Top ]

array $value = array() [line 631]

array of strings and parserInlineTags

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

Redefinition of:

parserBase::$value: set to different things by its descendants

[ Top ]

Methods

add [line 637]

void add(
mixed
$stringOrInlineTag 
)

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

Parameters:

mixed

$stringOrInlineTag:

either a string or a parserInlineTag

Redefined in descendants as:

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

[ Top ]

Convert [line 750]

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

Parameters:

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

API Tags:

See:

Converter::returnSee()

Redefined in descendants 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()

[ Top ]

getString [line 726]

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)

Parameters:

$trim:

API Tags:

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

Redefined in descendants as:

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

[ Top ]

hasInlineTag [line 667]

boolean hasInlineTag(
)

Determine whether the string contains any inline tags

Information Tags:

Tutorial:

phpDocumentor Inline tags

[ Top ]

setSource [line 681]

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 696]

integer trimmedStrlen(
)

equivalent to trim(strlen($string))

API Tags:

Return:

length of the string this object represents

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:24:45 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserData

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]