Inherited Methods
Class: 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))
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
Used for lists <ol> and <ul>
Tags:
- 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
[ Top ]
Class Variables
$items = 0
[ Top ]
$numbered
[ Top ]
Class Methods
parserList
parserList parserList(
integer
$numbered)
[line 374]
Constructor - create a new list
Parameters:
- integer $numbered - a reference number for the new list
[ Top ]
addItem
void addItem(
parserStringWithInlineTags
$item)
[line 386]
add an item to a list
Parameters:
- parserStringWithInlineTags $item - the item to add
[ Top ]
addList
void addList(
parserList
$list)
[line 398]
add a list
Parameters:
- parserList $list - the list to add
[ Top ]
Convert
string Convert(
Converter
&$c)
[line 413]
performs the conversion of list tags
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
Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)
Parameters:
- Converter &$c - the converter object
[ Top ]