Source for file INFA_DBMS_TABLEOBJ.phpclass

Documentation is available at INFA_DBMS_TABLEOBJ.phpclass

  1. <?php
  2. /**
  3.   * interface file INFA_DBMS_TABLEOBJ.phpclass
  4.   *
  5.   * @project    Open CSP-Management
  6.   * @package    dbms_field
  7.   * @category   field
  8.   *
  9.   * @author     Peter Krebs <pitlinz@sourceforge.net>
  10.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  11.   *
  12.   ***/
  13.  
  14.  
  15. /**
  16.   * interface to handle a database table object
  17.   *
  18.   * @project    Open CSP-Management
  19.   * @package    dbms
  20.   *
  21.   * @author     Peter Krebs <pitlinz@sourceforge.net>
  22.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  23.   * 
  24.   * @since pk-08-01-31
  25.   */
  26. interface INFA_DBMS_TABLEOBJ
  27. {
  28.  
  29.     // ---------------------------------------------------
  30.     // database values
  31.     // ---------------------------------------------------    
  32.         
  33.     /**
  34.       *    returns an array of db default values
  35.       *
  36.       * @param boolean     $debug 
  37.       *
  38.       * @return array 
  39.       *
  40.       */
  41.     public function getDefaults($debug=FALSE);     
  42.  
  43.     // ---------------------------------------------------
  44.     // data manipulation
  45.     // ---------------------------------------------------    
  46.     
  47.     /**
  48.       * returns a field => value array
  49.       *
  50.       * used also in insert and update statements
  51.       *
  52.       * make sure to not include some special values
  53.       * and object columns are serialised
  54.       *
  55.       * @param boolean $withoutNull if True null values are not added to the array
  56.       * @param boolean $debug 
  57.       * @param boolean $withoutOV if False and $this->hasObjVals() the object value array is added with index __OCSP_OBJ_VALS__
  58.       * @param boolean $fldAutoPopulate 
  59.       * 
  60.       * @returns array
  61.       *
  62.       */
  63.     function getDBRow($withoutNull=True,$debug=False,$withoutOV=False,$fldAutoPopulate=True); 
  64.  
  65.     /**
  66.       * sets a database row to the object fields
  67.       *
  68.       * sets each key (=columname) value
  69.       *
  70.       * if $row['__OCSP_OBJ_VALS__'] isset and an array this values are set as object values
  71.       * else if $asPopulated object values are loaded
  72.       *
  73.       * @param  array $row            the row form a select * from DBMS_TABLEOBJ::myTable
  74.       * @param  boolean $asPopulated    set populateTS as if the object has been populated
  75.       * @param  boolean $debug 
  76.       *
  77.       * @return boolean 
  78.       *
  79.       */
  80.     function setDBRow($row,$asPopulated=True,$debug=False);     
  81.     
  82.     /**
  83.       * save the Object
  84.       *
  85.       * @param boolean   $debug  SHOW DEBUG INFO
  86.       *
  87.       * @returns mixed
  88.       *
  89.       */
  90.     function dbSave($debug=FALSE); 
  91.         
  92.     /**
  93.       * inserts a new row to the table
  94.       *
  95.       * @param boolean   $debug  show debug info
  96.       *
  97.       * @return int   returns the autoIncFld ID if exists or 1 on success
  98.       *
  99.       */
  100.     function dbInsert($debug=FALSE);    
  101.     
  102.     /**
  103.       * replaces a row in the table
  104.       *
  105.       * if the object has not been populated (!$this->populateTS)
  106.       * FALSE is returned
  107.       *
  108.       * @param boolean $debug  show debug info
  109.       * @param boolean $ignorPopulated (if false the table MUST have been populated)
  110.       *
  111.       * @return boolean 
  112.       * 
  113.       */
  114.     function dbReplace($debug=FALSE,$ignorPopulated=FALSE);   
  115.     
  116.     /**
  117.       * deletes the row from the database
  118.       *
  119.       * @param boolean $backupData 
  120.       * @param boolean $debug 
  121.       *
  122.       * @returns boolean
  123.       *
  124.       */
  125.     function dbDelete($backupData=FALSE,$debug=FALSE);
  126.     
  127.     // ---------------------------------------------------
  128.     // database row getter / setter
  129.     // ---------------------------------------------------        
  130.     
  131.     
  132.     
  133.     // --------------- linked tables (joins) -------------
  134.     
  135.     /**
  136.      * sets the row of an other table
  137.      * 
  138.      * this method is used to cache form values of other tables
  139.      * which are joined in to $this->myTable
  140.      * 
  141.      * this rows must be considert in insert,update,delete
  142.      * 
  143.      * possible commands are
  144.      * - _OCSP_DBCMD_INSERT_  (insert a new row)
  145.      * - _OCSP_DBCMD_REPLACE_ (update an existing row or insert if not exists)
  146.      * - _OCSP_DBCMD_UPDATE_  (update an existing row)
  147.      * - _OCSP_DBCMD_DELETE_  (delete an existing row)
  148.      *
  149.      * @param string $tblName 
  150.      * @param string $dbCmd 
  151.      * @param array $aRow 
  152.      * @param boolean $debug 
  153.      * 
  154.      */
  155.     function setLinkedTableRow($tblName,$dbCmd,$aRow,$debug=FALSE);
  156.     
  157. }
  158. ?>

Documentation generated on Thu, 08 Jan 2009 17:44:27 +0100 by phpDocumentor 1.4.0a2