Class: parserList

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/DescHTML.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserList

Used for lists <ol> and <ul>

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.5.0a1

Copyright:

2002-2007 Gregory Beaver

Variables

Methods

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$type
parserStringWithInlineTags::$value

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

[line 359]
Used for lists <ol> and <ul>

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.5.0a1
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

[line 368]

Type:

integer

[ Top ]

$numbered =

[line 364]

Type:

boolean

[ Top ]

Method Detail

parserList (Constructor) [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

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 ]