tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Source for file db_connection_installer.class.php

Documentation is available at db_connection_installer.class.php

  1. <?php
  2.  
  3. /**
  4.  * Contains DB_Connection_Installer class
  5.  *
  6.  * @package tangra_lib
  7.  * @subpackage db
  8.  */
  9.  
  10. /**
  11.  *
  12.  */
  13. require_once(TANGRA_MAIN_DIR.'db/db_connection.class.php');
  14. /**
  15.  *
  16.  */
  17. require_once(TANGRA_MAIN_DIR.'db/db_recordset_installer.class.php');
  18. /**
  19.  *
  20.  */
  21. require_once(TANGRA_MAIN_DIR.'exceptions/te_dbc_sql_failed.class.php');
  22. /**
  23.  *
  24.  */
  25. require_once(TANGRA_MAIN_DIR.'exceptions/te_dbc_connect_failed.class.php');
  26. /**
  27.  *
  28.  */
  29. require_once(TANGRA_MAIN_DIR.'exceptions/te_dbc_generate_id_failed.class.php');
  30.  
  31.  
  32. /**
  33.  * This class is ment to be used ONLY by module installers
  34.  *
  35.  * DB_Connection_Installer resembles adodb_db_connection but is created with already connected db connection instead of DSN. It's purpose is to fake "normal" db connection in order module instalators to be able to use *_DBC when installing/uninstalling
  36.  *
  37.  * @package tangra_lib
  38.  * @subpackage db
  39.  */
  40. class DB_Connection_Installer extends DB_Connection {
  41.  
  42.     /**
  43.      * Constructor
  44.      *
  45.      * @param ADODB_Connection $conn 
  46.      */
  47.     function __construct($conn) {
  48.         $this->conn = $conn;
  49.         $this->conn->SetFetchMode(ADODB_FETCH_NUM);
  50.         $this->set_connected(true);
  51.     }
  52.  
  53.  
  54.     /**
  55.      * Fake
  56.      *
  57.      * @return boolean 
  58.      */
  59.     public function connect() {
  60.         $ret = true;
  61.  
  62.         return $ret;
  63.     }
  64.  
  65.  
  66.     /**
  67.      * Disconnects
  68.      *
  69.      */
  70.     public function disconnect() {
  71.         if ($this->is_connected()) {
  72.             $this->conn->Close();
  73.             $this->set_connected(false);
  74.         }
  75.     }
  76.  
  77.  
  78.     /**
  79.      * Starts db transaction
  80.      *
  81.      */
  82.     public function start_trans() {
  83.         $old_err_rep = error_reporting(SYSTEM_ERROR_REPORTING_PHP4_LIBS);
  84.         $this->conn->StartTrans();
  85.         error_reporting($old_err_rep);
  86.     }
  87.  
  88.  
  89.     /**
  90.      * Ends (commit) db transaction
  91.      *
  92.      */
  93.     public function complete_trans() {
  94.         $old_err_rep = error_reporting(SYSTEM_ERROR_REPORTING_PHP4_LIBS);
  95.         $this->conn->CompleteTrans();
  96.         error_reporting($old_err_rep);
  97.     }
  98.  
  99.  
  100.     /**
  101.      * Executes SQL statemen
  102.      *
  103.      *
  104.      * @param string $sql 
  105.      * @throws TE_DBC_SQL_Failed
  106.      * @throws TE_DBC
  107.      */
  108.     public function execute($sql, $ignore_sql_injection_warning = false) {
  109.         if ($this->is_connected()) {
  110.             $old_err_rep = error_reporting(SYSTEM_ERROR_REPORTING_PHP4_LIBS);
  111.  
  112.             $rs_cache = $this->conn->Execute($sql);
  113.             error_reporting($old_err_rep);
  114.  
  115.             $tmp_error_msg = $this->conn->ErrorMsg();
  116.             if (!$rs_cache) {
  117.                 if ($this->conn->transOff > 0) {
  118.                     $this->conn->CompleteTrans();
  119.                 }
  120.  
  121.                 throw new TE_DBC_SQL_Failed($sql, $tmp_error_msg);
  122.             }
  123.  
  124.             $rs = new DB_Recordset_Installer($rs_cache);
  125.         } else {
  126.             throw new TE_DBC('Database connection is in disconnected state. May be you called $dbc->disconnect() somewhere?');
  127.         }
  128.  
  129.         return $rs;
  130.     }
  131.  
  132.  
  133.     /**
  134.      * Alias of execute
  135.      *
  136.      * @param string $sql 
  137.      */
  138.     public function query($sql) { //alias of execute()
  139.         $this->execute($sql);
  140.     }
  141.  
  142.  
  143.     /**
  144.      * Generates ID
  145.      *
  146.      * @param string $sequence_name Name of the sequence that will be used (for MySQL where sequences are not available - name of the db table that fakes the sequence)
  147.      * @param integer $start Starting value of the sequence (will be used only if sequence does not exist yet, i.e. for initialization)
  148.      * @return integer Generated ID
  149.      */
  150.     public function generate_id($sequence_name, $start = 1) {
  151.         $old_err_rep = error_reporting(SYSTEM_ERROR_REPORTING_PHP4_LIBS);
  152.  
  153.         $ret = $this->conn->GenID($sequence_name, $start);
  154.         error_reporting($old_err_rep);
  155.  
  156.         if (!$ret) {
  157.             throw new TE_DBC_Generate_Id_Failed($sequence_name);
  158.         }
  159.  
  160.         return $ret;
  161.     }
  162.  
  163.  
  164.     /**
  165.      * Fails transaction (rollback)
  166.      *
  167.      */
  168.     public function fail_trans() {
  169.         $this->conn->FailTrans();
  170.     }
  171.  
  172.  
  173.     /**
  174.      * Return error message (if any)
  175.      *
  176.      */
  177.     public function get_error_msg() {
  178.         $this->conn->ErrorMsg();
  179.     }
  180.  
  181.  
  182.     /**
  183.      * Fake
  184.      *
  185.      * @param unknown_type $sql 
  186.      * @param unknown_type $num_rows 
  187.      * @param unknown_type $offset 
  188.      */
  189.     public function select_limit($sql, $num_rows, $offset) {
  190.  
  191.     }
  192.  
  193.  
  194.     /**
  195.      * Destructor
  196.      *
  197.      * Disconnects
  198.      *
  199.      */
  200.     function __destruct() {
  201.         $this->disconnect();
  202.  
  203.     }
  204. }