Source for file dbobject.php

Documentation is available at dbobject.php

  1. <?php
  2. /**
  3. * database object base class (self-initialising and self-updating object)
  4. *
  5. * @author    Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage FormsLibrary
  11. */
  12.  
  13. /** Load ancillary functions */
  14. require_once 'inc/typeinfo.php';
  15. checkValidInclude();
  16.  
  17. /** database connection script */
  18. require_once 'inc/db.php';
  19. /** sql manipulation routines */
  20. require_once 'sql.php';
  21. /** status codes for success/failure of database actions */
  22. require_once 'inc/statuscodes.php';
  23.  
  24. /**
  25. * database object base class (self-initialising and self-updating object)
  26. *
  27. * @package    Bumblebee
  28. * @subpackage FormsLibrary
  29. */
  30. class DBO {
  31.   /** @var string   db table from which to take data */
  32.   var $table;
  33.   /** @var string   db column that is the id/key */
  34.   var $idfield;
  35.   /** @var string   ??? FIXME: unused? */
  36.   var $idfieldreal;
  37.   /** @var string   the id/key value for this particlar row. -1 means not assigned yet (new object not in table) */
  38.   var $id=-1;
  39.   /** @var boolean  if true, *don't* use the ID field in updates etc */
  40.   var $ignoreId = false;
  41.   /** @var array    list of Field objects in this row */
  42.   var $fields;
  43.   /** @var boolean  this field is able to be edited by the user  */
  44.   var $editable = 0;
  45.   /** @var boolean  this field is able to be deleted (or marked as deleted) */
  46.   var $deletable = 1;
  47.   /** @var boolean  the fields in this row have changed cf the database */
  48.   var $changed = 0;
  49.   /** @var boolean  the data in the fields are valid */
  50.   var $isValid = 0;
  51.   /** @var boolean  don't do validation on the data */
  52.   var $suppressValidation = 0;
  53.   /** @var string   output when doing text dumps of the object */
  54.   var $dumpheader = 'DBO object';
  55.   /** @var boolean  sql errors should be considered fatal and the script will die()  */
  56.   var $fatal_sql = 1;
  57.   /** @var string   prefixed to all name="$field[name]" sections of the html code */
  58.   var $namebase;
  59.   /** @var string   current error message  */
  60.   var $errorMessage = '';
  61.   /** @var integer  status code from operation from statuscodes.php  */
  62.   var $oob_status = STATUS_NOOP;
  63.   /** @var string    */
  64.   var $oob_errorMessage = '';
  65.  
  66.   /** @var integer   debug level 0=off    */
  67.   var $DEBUG = 0;
  68.  
  69.   /**
  70.   *  Create a new database object, designed to be superclasses
  71.   *
  72.   * @param string $table   see $this->table
  73.   * @param string $id       see $this->id
  74.   * @param mixed $idfield  if string, $this->idfield. if array, ($this->idfield, $this->idfieldreal).
  75.   */
  76.   function DBO($table, $id, $idfield = 'id') {
  77.     $this->table = $table;
  78.     $this->id = $id;
  79.     if (is_array($idfield)) {
  80.       $this->idfieldreal = $idfield[0];
  81.       $this->idfield = $idfield[1];
  82.     } else {
  83.       $this->idfield = $idfield;
  84.     }
  85.     $this->fields = array();
  86.   }
  87.  
  88.   /**
  89.   *  Sets a new name base for row and all fields within it
  90.   *
  91.   * The name base is prepended to the field name in all html name="" sequences for the widgets
  92.   * @param string $newname  new name-base to use
  93.   */
  94.   function setNamebase($newname='') {
  95.     $this->namebase = $newname;
  96.     foreach (array_keys($this->fields) as $k) {
  97.       $this->fields[$k]->setNamebase($newname);
  98.     }
  99.   }
  100.  
  101.   /**
  102.   * Sets whether a row and all fields within it are editable
  103.   *
  104.   * @param boolean $editable  new editable state
  105.   */
  106.   function setEditable($editable=1) {
  107.     $this->editable = $editable;
  108.     foreach (array_keys($this->fields) as $k) {
  109.       $this->fields[$k]->setEditable($editable);
  110.     }
  111.   }
  112.  
  113.   /**
  114.   * Create a quick text representation of the object
  115.   *
  116.   * @return string text representation
  117.   */
  118.   function text_dump() {
  119.     $t  = "<pre>$this->dumpheader $this->table (id=$this->id)\n{\n";
  120.     foreach ($this->fields as $v) {
  121.       $t .= "\t".$v->text_dump();
  122.     }
  123.     $t .= "}\n</pre>";
  124.     return $t;
  125.   }
  126.  
  127.   /**
  128.   * Display the object
  129.   *
  130.   * @return string object representation
  131.   */
  132.   function display() {
  133.     return $this->text_dump();
  134.   }
  135.  
  136.   /**
  137.   * Debug print function.
  138.   *
  139.   * @param string $logstring debug message to be output
  140.   * @param integer $priority  priority of the message, will not be written unless $priority <= $this->DEBUG
  141.   */
  142.   function log($logstring, $priority=10) {
  143.     if ($priority <= $this->DEBUG) {
  144.       echo $logstring."<br />\n";
  145.     }
  146.   }
  147.  
  148.   /**
  149.   * PHP5 clone method
  150.   *
  151.   * PHP5 clone statement will perform only a shallow copy of the object. Any subobjects must also be cloned
  152.   */
  153.   function __clone() {
  154.     //print "send in the clones! I'm cloning a ".get_class($this)."<br />";
  155.     //preDump($this->fields);
  156.     // Force a copy of contents of $this->fields array, otherwise the fields will only be references
  157.     $fields = $this->fields;
  158.     $this->fields = array();
  159.     foreach ($fields as $k => $f) {
  160.       //print "cloning $k<br />";
  161.       $this->fields[$k] = clone($f);
  162.     }
  163.     //print "done cloning";
  164.   }
  165.  
  166.  
  167. } // class dbo
  168.  
  169. ?>

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