Docs For Class parserList

Description

Used for lists <ol> and <ul>

author: Greg Beaver <[email protected]>
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

Located in /phpDocumentor/DescHTML.inc (line 359)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserList

Variable Summary

integer $items

boolean $numbered

Method Summary

parserList parserList (integer $numbered)

void addItem (parserStringWithInlineTags $item)

void addList (parserList $list)

string Convert (Converter &$c)

Variables

integer $items = 0 (line 368)

boolean $numbered (line 364)

Inherited Variables

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$type
parserStringWithInlineTags::$value

Methods

Constructor parserList (line 374)

Constructor - create a new list

parserList parserList (integer $numbered)

integer $numbered: a reference number for the new list

addItem (line 386)

add an item to a list

void addItem (parserStringWithInlineTags $item)

parserStringWithInlineTags $item: the item to add

addList (line 398)

add a list

void addList (parserList $list)

parserList $list: the list to add

Convert (line 413)

performs the conversion of list tags

return: the converted pre block
todo: CS cleanup - rename method to convert()
uses: Converter::ListItem() - enclose each item of the list
uses: Converter::EncloseList() - enclose the list

string Convert (Converter &$c)

Converter &$c: the converter object

Redefinition of:

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

Inherited Methods

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

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