Class: parserList

Source Location: /phpDocumentor/DescHTML.inc

Class parserList

Class Overview

Used for lists <ol> and <ul>

Located in /phpDocumentor/DescHTML.inc [line 359]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserList

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	Release: @VER@
Copyright:	2002-2007 Gregory Beaver
Link:	http://pear.php.net/PhpDocumentor
Link:	http://www.phpdoc.org
Todo:	CS cleanup - change package to PhpDocumentor
Todo:	CS cleanup - rename class to ParserList
Since:	1.2
License:	LGPL

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$type

parserStringWithInlineTags::$value

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()

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

parserStringWithInlineTags::Convert()

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

parserStringWithInlineTags::getString()

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)

parserStringWithInlineTags::hasInlineTag()

Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource()

Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen()

equivalent to trim(strlen($string))

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

integer	$items
boolean	$numbered

[ Top ]

Method Summary

parserList	parserList()	Constructor - create a new list
void	addItem()	add an item to a list
void	addList()	add a list
string	Convert()	performs the conversion of list tags

[ Top ]

Properties

integer $items = 0 [line 368]

[ Top ]

boolean $numbered [line 364]

[ Top ]

Methods

Constructor parserList [line 374]

parserList parserList(
integer
$numbered 
)

Constructor - create a new list

Parameters:

integer

$numbered:

a reference number for the new list

[ Top ]

addItem [line 386]

void addItem(
parserStringWithInlineTags
$item 
)

add an item to a list

Parameters:

parserStringWithInlineTags

$item:

the item to add

[ Top ]

addList [line 398]

void addList(
parserList
$list 
)

add a list

Parameters:

parserList

$list:

the list to add

[ Top ]

Convert [line 413]

string Convert(
Converter
&$c 
)

performs the conversion of list tags

Parameters:

Converter

&$c:

the converter object

API Tags:

Return:	the converted pre block
Uses:	Converter::ListItem() - enclose each item of the list
Uses:	Converter::EncloseList() - enclose the list

Information Tags:

Todo:

CS cleanup - rename method to convert()

Redefinition of:

parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:17:59 -0600 by phpDocumentor 1.4.4

	phpDocumentor DescHTML

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