Source for file referencefield.php

Documentation is available at referencefield.php

  1. <?php
  2. /**
  3. * a non-editable reference object to explain a table entry
  4. *
  5. * e.g. translates the userid into the user's real name.
  6. *
  7. *
  8. * @author    Stuart Prescott
  9. * @copyright  Copyright Stuart Prescott
  10. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  11. * @version    $Id$
  12. * @package    Bumblebee
  13. * @subpackage FormsLibrary
  14. */
  15.  
  16. /** Load ancillary functions */
  17. require_once 'inc/typeinfo.php';
  18. checkValidInclude();
  19.  
  20. /** parent object */
  21. require_once 'field.php';
  22. /** uses ExampleEntries object */
  23. require_once 'exampleentries.php';
  24.  
  25. /**
  26. * a non-editable reference object to explain a table entry
  27. *
  28. * @package    Bumblebee
  29. * @subpackage FormsLibrary
  30. */
  31. class ReferenceField extends Field {
  32.    /** @var ExampleEntries   list of example entries from the db */
  33.    var $example;
  34.  
  35.   /**
  36.   *  Create a new reference field object
  37.   *
  38.   * @param string $name   the name of the field (db name, and html field name
  39.   * @param string $longname  long name to be used in the label of the field in display
  40.   * @param string $description  used in the html title or longdesc for the field
  41.   */
  42.   function ReferenceField($name, $longname='', $description='') {
  43.     parent::Field($name, $longname, $description);
  44.   }
  45.  
  46.   /**
  47.   * add an extra field to the end of the formatted data
  48.   *
  49.   * @param string $table       db table for extra field
  50.   * @param string $matchfield  id/key field
  51.   * @param string $field       field to return in the list of examples
  52.   * @param integer $numentries (optional) the number of entries to return
  53.   */
  54.   function extraInfo($table, $matchfield, $field, $numentries=1) {
  55.     $this->example = new ExampleEntries('id', $table, $matchfield, $field, $numentries);
  56.   }
  57.  
  58.   function displayInTable($cols=3) {
  59.     $t = "<tr><td>$this->longname</td>\n"
  60.         ."<td title='$this->description'>";
  61.     $t .= xssqw($this->getValue());
  62.     $refdata = array('id'=>$this->getValue());
  63.     $t .= ' ('. $this->example->format($refdata).')';
  64.     $t .= "<input type='hidden' name='$this->namebase$this->name' "
  65.          ."value='".xssqw($this->getValue())."' />";
  66.     if (isset($this->duplicateName)) {
  67.       $t .= "<input type='hidden' name='$this->duplicateName' "
  68.            ."value='".xssqw($this->getValue())."' />";
  69.     }
  70.     $t .= "</td>\n";
  71.     for ($i=0; $i<$cols-2; $i++) {
  72.       $t .= '<td></td>';
  73.     }
  74.     $t .= '</tr>';
  75.     return $t;
  76.   }
  77.  
  78. } // class ReferenceField
  79.  
  80.  
  81. ?>

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