Class ReferenceField

Description

a non-editable reference object to explain a table entry

Located in /inc/formslib/referencefield.php (line 31)

Field
   |
   --ReferenceField
Variable Summary
Method Summary
ReferenceField ReferenceField (string $name, [string $longname = ''], [string $description = ''])
void displayInTable ([ $cols = 3])
void extraInfo (string $table, string $matchfield, string $field, [integer $numentries = 1])
Variables
Methods
Constructor ReferenceField (line 42)

Create a new reference field object

ReferenceField ReferenceField (string $name, [string $longname = ''], [string $description = ''])
  • string $name: the name of the field (db name, and html field name
  • string $longname: long name to be used in the label of the field in display
  • string $description: used in the html title or longdesc for the field
displayInTable (line 58)
void displayInTable ([ $cols = 3])
  • $cols

Redefinition of:
Field::displayInTable()
render this form widget in an html table
extraInfo (line 54)

add an extra field to the end of the formatted data

void extraInfo (string $table, string $matchfield, string $field, [integer $numentries = 1])
  • string $table: db table for extra field
  • string $matchfield: id/key field
  • string $field: field to return in the list of examples
  • integer $numentries: (optional) the number of entries to return

Inherited Methods

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()

Documentation generated on Tue, 06 Mar 2007 10:01:56 +0000 by phpDocumentor 1.3.0