Source for file DataBaseConnector.class.php

Documentation is available at DataBaseConnector.class.php

  1. <?php
  2.   /**
  3.     * Encapsulates databse functions.
  4.     *
  5.     * This class encapsulates all of the functions for connecting to the database.
  6.     * @author Richard Sharp
  7.     * @copyright 2011
  8.     * @package Database
  9. */
  10. class DataBaseConnector
  11. {
  12.       /**
  13.         * Encapsulates database functions..
  14.         *
  15.         * This class encapsulates all of the functions for connecting to the database.
  16.         * @author Richard Sharp
  17.         * @copyright 2010
  18.         * @package Database
  19.     */
  20.     
  21.     /********************************* Public Variables **********************************************/
  22.     
  23.     /**
  24.      * Gets or sets whether or not to automaticllay update the Modified and Created fields in the  table (must be those exact names).
  25.      *    @var boolean 
  26.      */
  27.     public $UpdateTimestamps=true;
  28.     
  29.     /**
  30.      * Gets or sets the database name.
  31.      *    @var string 
  32.      */
  33.     public $DatabaseName="";
  34.     
  35.     /**
  36.      * Gets or sets the database host. Default is localhost.
  37.      *    @var string 
  38.      */
  39.     public $Host="localhost";
  40.     
  41.     /**
  42.      * Gets the raw text of the last query performed.
  43.      *    @var string 
  44.      */
  45.     public $LastQuery="";
  46.     
  47.     /**
  48.      * If set, an error log will be written to this file. Use a full file path.
  49.      *    @var string 
  50.      */
  51.     public $LogFile="";
  52.     
  53.     /**
  54.      * Gets or sets the database password.
  55.      *    @var string 
  56.      */
  57.     public $Password="";
  58.     
  59.     /**
  60.      * Gets or sets the database username.
  61.      *    @var string 
  62.      */
  63.     public $Username="";
  64.     
  65.     /********************************* Private Variables **********************************************/
  66.     /*
  67.     * @access private
  68.     * This is a mysqli class instance.
  69.     */
  70.     private $objConnection;
  71.     
  72.     
  73.     /********************************* Methods **********************************************/
  74.     
  75.      /**
  76.      * Constructor for the class.
  77.      * @param string The database username.
  78.      * @param string The database password.
  79.      * @param string The database name.
  80.      * @param string The database host.
  81.      * @return void 
  82.      */ 
  83.     function __construct($Username="",$Password="",$DatabaseName="",$Host="")
  84.     {
  85.         if(isset($Host)) $this->Host=$Host;
  86.         else $this->Host="localhost";
  87.         if(isset($Username)) $this->Username=$Username;
  88.         if(isset($Password)) $this->Password=$Password;
  89.         if($DatabaseName!="") $this->DatabaseName=$DatabaseName;
  90.     }
  91.     
  92.     /**
  93.      * Destructor for the class.
  94.      * @return void 
  95.      */ 
  96.      function __destruct()
  97.      {
  98.          try
  99.         {
  100.             if($this->objConnection) $this->objConnection->Close();
  101.         }
  102.         catch(Exception $e){}
  103.      }
  104.     
  105.     /**
  106.      * Connects to the database. Returns true on success, or false on failure.
  107.      * @return void 
  108.      * @access private
  109.      */ 
  110.     private function Connect($bRedirect=false)
  111.     {
  112.         try
  113.         {
  114.             //make sure to release any previous connection.
  115.             unset($this->objConnection);
  116.             //create a new mysqli class and connect.
  117.             $objConnection=new mysqli($this->Host,$this->Username,$this->Password,$this->DatabaseName);
  118.             //check for connection error
  119.             if($objConnection->connect_error)
  120.             {
  121.                 throw new Exception("MySQL Connection Failure: ".$objConnection->connect_error);
  122.             }
  123.             //check for connection error prior to  PHP 5.2.9
  124.             if (mysqli_connect_error()) 
  125.             {
  126.                 throw new Exception("MySQL Connection Failure: ".mysqli_connect_error());
  127.             }
  128.             //no error, so return the object and store a reference.
  129.             $this->objConnection=$objConnection;
  130.             return true;
  131.         } 
  132.         catch(Exception $e)
  133.         {
  134.             //log the error
  135.             $this->LogError("MySQL Connection Failure: ".$e->getMessage());
  136.             return false;
  137.         }
  138.     }
  139.     /**
  140.     * Escapes the value to be placed in a field. This helps prevent problems with quotes, and mitigates SQL injection attacks.
  141.     * @param string The value to escape.
  142.     * @return string 
  143.     */
  144.     public function Escape($Value)
  145.     {
  146.         if($this->TestConnection())
  147.         {
  148.             return($this->objConnection->real_escape_string($Value));
  149.         }
  150.         else return(false);
  151.     }
  152.     
  153.     /**
  154.     * Returns the number of rows affected by the previous query
  155.     * @return int 
  156.     */
  157.     public function GetAffectedRows()
  158.     {
  159.         if(!$this->objConnection) return 0;
  160.         return($this->objConnection->affected_rows);
  161.     }
  162.     
  163.      /**
  164.      * Gets the text of the last error, if any.
  165.      * @return string 
  166.      */ 
  167.     public function GetLastError()
  168.     {
  169.         if(!$this->objConnection) return "";
  170.         return($this->objConnection->error);
  171.     }
  172.     
  173.     /**
  174.      * Inserts a record into the database. Returns the insert auto-incremented ID on success, false on failure. Unless UpdateTimestamps is set to false, fields will automatically be added for Modified and Created.
  175.      * @param string The name of the table.
  176.      * @param array An array of the fields/values to insert. Each element key is the column name for the table, and the value is the value to insert.
  177.      * @return int 
  178.      */ 
  179.     public function Insert($Table,$Fields)
  180.     {
  181.         try
  182.         {
  183.             if(!is_array($Fields)) throw new Exception("Attempted to insert with no fields.");
  184.             if(true===$this->TestConnection())
  185.             {
  186.                 foreach($Fields as $sKey => $sValue)
  187.                 {
  188.                     $aKeys[]=$sKey;
  189.                     if(substr_count($sValue,"password(")>0) $aValues[]=$sValue; //if we are using the password function, don't escape or add quotes.
  190.                     elseif(strtolower($sValue)=="null") $aValues[]="NULL"; //if we are setting a field to NULL, don't escape or add quotes.
  191.                     else $aValues[]='"'.$this->Escape($sValue).'"'; //escape and add quotes
  192.                 }
  193.                 $sQuery='INSERT INTO '.$Table.' ('.implode(",",$aKeys);
  194.                 if($this->UpdateTimestamps) $sQuery.=',Modified,Created';
  195.                 $sQuery.=') VALUES ('.implode(',',$aValues);
  196.                 if($this->UpdateTimestamps) $sQuery.=',now(),now()';
  197.                 $sQuery.=')';
  198.                 $this->LastQuery=$sQuery;
  199.                 $bResult=$this->objConnection->query($sQuery);
  200.                 if(true==$bResult) return($this->objConnection->insert_id);
  201.                 else throw new Exception("Insert Failed: ".$sQuery." Error: ".$this->objConnection->error);
  202.             }
  203.             else return(false);
  204.         }
  205.         catch(Exception $e)
  206.         {
  207.             $this->LogError($e->getMessage());
  208.             return false;
  209.         }
  210.     }
  211.     
  212.      /**
  213.      * Runs a raw query on the database that does not expect any return. Returns the result of that query, which may be a boolean for failure or an object for success of some queries.
  214.      * @param string The query to run.
  215.      * @return mixed 
  216.      */ 
  217.     public function Query($Query)
  218.     {
  219.         try
  220.         {
  221.             if($this->TestConnection())
  222.             {
  223.                 $this->LastQuery=$Query;
  224.                 $oResult=$this->objConnection->query($Query);
  225.                 if(false==$oResult) throw new Exception("Query failed: $query Error: ".$objConnection->error);
  226.                 else return $oResult;
  227.             }
  228.             else throw new Exception("Connection Failed.");
  229.         }
  230.         catch(Exception $e)
  231.         {
  232.             $this->LogError($e->getMessage());
  233.             return false;
  234.         }
  235.     }
  236.     
  237.      /**
  238.      * Performs an Update query on the database. Returns true on success, false on failure.
  239.      * @param string The name of the table.
  240.      * @param array An associative array of the fields to update. Each element's key is the column name in the table, and the value of the element is the value to update.
  241.      * @param boolean Whether or not to use delayed replace. Default false.
  242.      * @return bool 
  243.      */ 
  244.     public function Replace($Table,$Fields,$Delayed=false)
  245.     {
  246.         try
  247.         {
  248.             if(!is_array($Fields)) throw new Exception("Attempted to update with no fields selected");
  249.             if($this->TestConnection())
  250.             {
  251.                 foreach($Fields as $sKey => $sValue)
  252.                 {
  253.                     $aKeys[]=$sKey;
  254.                     if(substr_count($sValue,"password(")>0) $aValues[]=$sValue; //if we are using the password function, don't escape or add quotes.
  255.                     elseif(strtolower($sValue)=="null") $aValues[]="NULL"; //if we are setting a field to NULL, don't escape or add quotes.
  256.                     else $aValues[]='"'.$this->Escape($sValue).'"'; //escape and add quotes
  257.                 }
  258.                 $sQuery='REPLACE'.(true===$Delayed?" DELAYED":"").' INTO '.$Table.' ('.implode(",",$aKeys);
  259.                 if(true===$this->UpdateTimestamps) $sQuery.=',Modified,Created';
  260.                 $sQuery.=') VALUES ('.implode(',',$aValues);
  261.                 if(true===$this->UpdateTimestamps) $sQuery.=',now(),now()';
  262.                 $sQuery.=')';
  263.                 $this->LastQuery=$sQuery;
  264.                 $bResult=$this->objConnection->query($sQuery);
  265.                 if(true==$bResult) return true;
  266.                 else throw new Exception("Replace Failed: ".$sQuery." Error: ".$this->objConnection->error);
  267.             }
  268.             else throw new Exception("Failed to conenct to database.");
  269.         }
  270.         catch(Exception $e)
  271.         {
  272.             $this->LogError($e->getMessage());
  273.             return false;
  274.         }
  275.     }
  276.     
  277.      /**
  278.      * Runs a Select query on the database. Returns an associative array of rows on success, false on failure. This will also loop through all of the results and clean the data (stripslashes).
  279.      * @param string The query to run.
  280.      * @return mixed 
  281.      */ 
  282.     public function Select($Query)
  283.     {
  284.         try
  285.         {
  286.             if($this->TestConnection())
  287.             {
  288.                 $this->LastQuery=$Query;
  289.                 $oResult=$this->objConnection->query($Query);
  290.                 if(false===$oResult) throw new Exception("Select failed: $Query Error: ".$this->objConnection->error);
  291.                 while($aRow=$oResult->fetch_assoc())
  292.                 {
  293.                     foreach($aRow as $sKey => $sValue) $aRow[$sKey]=stripslashes($sValue);
  294.                     $aReturn[]=$aRow;
  295.                 }
  296.             }
  297.             else throw new Exception("Failed to connect to database.");
  298.             return($aReturn);
  299.         }
  300.         catch(Exception $e)
  301.         {
  302.             $this->LogError($e->getMessage());
  303.             return false;
  304.         }
  305.     }
  306.     
  307.      /**
  308.      * Tests to make sure the connection to the database is open, and if not, attempts to re-open the connection.
  309.      * @return bool 
  310.      */ 
  311.     public function TestConnection()
  312.     {
  313.         try
  314.         {
  315.             if(!$this->objConnection) 
  316.             {
  317.                 if(false===$this->Connect()) throw new Exception("Failed to connect in TestConnection.");
  318.             }
  319.             if(false===$this->objConnection->ping()) throw new Exception("Failed to ping connection in TestConnection.");
  320.             return(true);
  321.         }
  322.         catch(Exception $e)
  323.         {
  324.             $this->LogError($e->getMessage());
  325.             return false;
  326.         }
  327.     }
  328.     
  329.      /**
  330.      * Performs an Update query on the database. Returns success or failure.
  331.      * @param string The name of the table.
  332.      * @param array An associative array of the fields to update. Each element's key is the column name in the table, and the value of the element is the value to update.
  333.      * @param string The WHERE clause of the query.
  334.      * @param int Optional. The limit to the number of rows that should be affected.
  335.      * @return bool 
  336.      */ 
  337.     public function Update($Table,$Fields,$Condition,$Limit=0)
  338.     {
  339.         try
  340.         {
  341.             if(!is_array($Fields)) throw new Exception("Tried to update with an empty field list.");
  342.             if(true===$this->TestConnection())
  343.             {
  344.                 foreach($Fields as $sKey => $sValue) 
  345.                 {
  346.                     if(substr_count($sValue,"password(")>0) $aUpdates[]=$sKey.'='.$sValue; //if we are using the password function, don't escape or add quotes.
  347.                     elseif(strtolower($sValue)=="null") $aValues[]="NULL";  //if we are setting a field to NULL, don't escape or add quotes.
  348.                     else $aUpdates[]=$sKey.'="'.$this->objConnection->real_escape_string($sValue).'"'; //escape and add quotes
  349.                 }
  350.                 $sQuery='UPDATE '.$Table.' SET '.implode(",",$aUpdates);
  351.                 if($this->UpdateTimestamps) $sQuery.=',Modified=now() ';
  352.                 $sQuery.=' WHERE '.$Condition;
  353.                 if($Limit) $sQuery.=' LIMIT '.$Limit;
  354.                 $this->LastQuery=$sQuery;
  355.                 $bResult=$this->objConnection->query($sQuery);
  356.                 if(true==$bResult) return true;
  357.                 else throw new Exception("Replace Failed: ".$sQuery." Error: ".$this->objConnection->error);
  358.             }
  359.             else throw new Exception("Failed to connect to database.");
  360.         }
  361.         catch(Exception $e)
  362.         {
  363.             $this->LogError($e->getMessage());
  364.             return false;
  365.         }
  366.     }
  367.     
  368.     
  369.     
  370.     private function LogError($ErrorText)
  371.     {
  372.         if($this->LogFile!="")
  373.         {
  374.             try
  375.             {
  376.                 $oFile=@fopen($this->LogFile,"a");
  377.                 if($oFile)
  378.                 {
  379.                     $message=date("m/d/y H:i:s")."\n".$ErrorText."\n--------------------------------------------------------------------\n";
  380.                     fputs($oFile,$message,strlen($message));
  381.                     fclose($oFile);
  382.                 }
  383.             }
  384.             catch(Exception $e){}
  385.         }
  386.     }
  387. }
  388. ?>

Documentation generated on Wed, 26 Jan 2011 15:24:43 -0700 by phpDocumentor 1.4.3