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

Class: parserList

Source Location: /phpDocumentor/DescHTML.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserList

Used for lists <ol> and <ul>


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2007 Gregory Beaver

Variables

Methods


Inherited Variables

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 [email protected]} 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



[ Top ]


Class Variables

$items =  0

[line 368]


Type:   integer


[ Top ]

$numbered =

[line 364]


Type:   boolean


[ Top ]



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

method addItem [line 386]

void addItem( parserStringWithInlineTags $item)

add an item to a list



Parameters:

parserStringWithInlineTags   $item   the item to add

[ Top ]

method addList [line 398]

void addList( parserList $list)

add a list



Parameters:

parserList   $list   the list to add

[ Top ]

method Convert [line 413]

string Convert( Converter &$c)

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 ]


Documentation generated on Tue, 06 Dec 2011 07:11:48 -0600 by phpDocumentor 1.4.4