Docs For Class AnchorList

Description

anchor list (<li><a href="$href">$name</a></li>) for a ChoiceList

Located in /inc/formslib/anchorlist.php (line 25)

Field
   |
   --ChoiceList
      |
      --AnchorList

Direct descendents

Class	Description
AnchorTableList	Anchor list similar to AnchorList, but this time in a table not dot points

Variable Summary

string $aclass

string $hrefbase

string $liclass

string $ulclass

Method Summary

AnchorList AnchorList (string $name, [string $description = ''])

string display ()

string format (array $data)

Variables

string $aclass = 'itemanchor' (line 33)

var: html/css class used for each anchor

Redefined in descendants as:

AnchorTableList::$aclass

string $hrefbase (line 27)

var: prepended to all hrefs genereated here

string $liclass = 'item' (line 31)

var: html/css class used for each list item

string $ulclass = 'selectlist' (line 29)

var: html/css class used for the entire unordered list

Inherited Variables

Inherited from ChoiceList

ChoiceList::$deleted
ChoiceList::$extendable
ChoiceList::$formatid
ChoiceList::$formatter
ChoiceList::$list

Inherited from Field

Field::$attr
Field::$changed
Field::$DEBUG
Field::$defaultValue
Field::$description
Field::$duplicateName
Field::$editable
Field::$errorclass
Field::$hidden
Field::$isValid
Field::$isValidTest
Field::$longname
Field::$name
Field::$namebase
Field::$notifyIdChange
Field::$oob_errorMessage
Field::$oob_status
Field::$ovalue
Field::$required
Field::$requiredTwoStage
Field::$sqlHidden
Field::$suppressValidation
Field::$useNullValues
Field::$value
Field::$valueCleaner

Methods

Constructor AnchorList (line 41)

Create a new AnchorList

AnchorList AnchorList (string $name, [string $description = ''])

string $name: the name of the field (db name, and html field name
string $description: used in the html title of the list

display (line 65)

create the html list

return: formatted list

string display ()

Redefinition of:

ChoiceList::display()

Redefined in descendants as:

AnchorTableList::display()

format (line 51)

format an individual element in the list

return: formatted entry

string format (array $data)

array $data: the data to format using the OutputFormatter

Redefinition of:

ChoiceList::format(): A test text-based format function for the object.

Redefined in descendants as:

AnchorTableList::format()

Inherited Methods

Inherited From ChoiceList

ChoiceList::ChoiceList()
ChoiceList::append()
ChoiceList::connectDB()
ChoiceList::display()
ChoiceList::displayInTable()
ChoiceList::format()
ChoiceList::getValue()
ChoiceList::isValid()
ChoiceList::prepend()
ChoiceList::selectedValue()
ChoiceList::set()
ChoiceList::setDefault()
ChoiceList::setFormat()
ChoiceList::setValuesArray()
ChoiceList::sqlSetStr()
ChoiceList::text_dump()
ChoiceList::update()
ChoiceList::__clone()

Inherited From Field

Field::Field()
Field::display()
Field::displayInTable()
Field::getValue()
Field::hidden()
Field::isValid()
Field::log()
Field::selectable()
Field::selectedValue()
Field::set()
Field::setattr()
Field::setEditable()
Field::setNamebase()
Field::sqlSetStr()
Field::text_dump()
Field::update()
Field::__clone()