Subversion Repositories phpLibraryV2

<?php

   //require_once "DBDatabase.class.php";

   require_once "Logging.class.php"; // For logging

   global $LOGFILE;

   define( 'HTML_QUOTE_CHAR', '"' );

   define( 'CONSTANT_NO_VALUE_DROPDOWN', '--------' );

   class DBQuery {

      // following are used for the class with no instantiation

      protected static $connected = false;

      protected static $connectionInfo = null; // connection information for database

      protected $query;          // the query to be processed

      protected $rowsAffected;   // the number of rows 1) affectd by an insert, update or delete or 2) returned by a select

      protected $lastInsertKey;  // the value of the last row inserted (mysql only)

      protected $returnData;     // an array that contains the data retrieved by a query (select only)

      protected $columnMetaData; // an array that contains the meta data from the query

      protected $useAssociativeArray;   // if true, $returnData is an array of associative array, with the column names being the key fields

      protected $showErrors;     // if true, will return errors to STDOUT

      protected $error;          // set to last error returned

      protected $log;            // Wil be instantiation of a  Logging instance if set

      protected $auditTable;     // if set to a table name, all queries are written to it

      protected $orderBy;

      public static function connect( $connectionInfo = null ) {

         if ( isset ( $connectionInfo ) ) {

            DBQuery::$connectionInfo = $connectionInfo;

            if ( ! isset( DBQuery::$connectionInfo['host'] ) || DBQuery::$connectionInfo['host'] == '' )

               DBQuery::$connectionInfo['host'] = '127.0.0.1';

         } // if they passed in a connection string

         if ( ! DBQuery::$connected ) {

            try {

               if ( mysql_connect( DBQuery::$connectionInfo['host'], DBQuery::$connectionInfo['username'], DBQuery::$connectionInfo['password'] ) === false )

                  throw new Exception( mysql_error() );

               if ( mysql_select_db( DBQuery::$connectionInfo['name'] ) === false )

                  throw new Exception(mysql_error());

               DBQuery::$connected = true;

            } catch ( Exception $e ) {

               die( $e->getMessage() );

            }

         } // if we are not connected

      } // static function connect

      public function __construct( $query, $whereClause = null, $orderBy = null, $runImmediate = false ) {

         $this->query = $query;

         if ( isset( $whereClause ) ) {

            $this->query .= $this->makeWhereClause( $whereClause );

         } // whereclause

         if ( isset( $orderBy ) ) {

            $this->orderBy .= ' order by ' . implode( ',', $orderBy );

         } // orderby

         $this->rowsAffected = 0;

         $this->lastInsertKey = '';

         $this->returnData = array();

         $this->columnMetaData = array();

         $this->useAssociativeArray = true;

         $this->showErrors = true;

         $this->error = '';

         if (isset( $LOGFILE ) ) $this->logFile =  new Logging( $LOGFILE );

         if ( $runImmediate )

            $this->run();

         // if (isset( $AUDITTABLE ) ) $this->auditTable =  new Logging( $LOGFILE );

      } // __construct

      public function __set( $name, $value ) {

         $this->$name = $value;

         return $value;

      }

      public function __get( $name ) {

         return isset( $this->$name ) ? $this->$name : null;

      }

      public function __isset( $name ) {

         return isset( $this->$name );

      }

      /* 

         function actually executes the query, populating the members with the results

         returns true if no errors, false if errors (see $this->error for code)

      */

      function run () {

         // print "<pre>In Query database\n---------------------\n$query\n---------------------\n</pre>";

         if ( isset($this->log) ) $this->log->printLog( $query );

//         if ( isset( $this->auditTable) ) audit( $query );

         $result = @mysql_query($this->query);

         if( mysql_errno() ) {

            $this->error = 'MYSQL ERROR #'.mysql_errno().' : <small>' . mysql_error(). "</small><br><VAR>$this->query</VAR>";

            if ( $this->showErrors ) echo($this->error);

            return false;

         } // if

         if( preg_match ( '/^\s*select/i', $this->query ) ) { // this is a select statement

            $this->rowsAffected = @mysql_num_rows($result);

            $this->columnMetaData = array();

            for ($i = 0; $i < mysql_num_fields( $result ); $i++) {

               $meta = mysql_fetch_field ( $result );

               $this->columnMetaData[] = array('name' => $meta->name, 'length' => $meta->max_length, 'numeric' => $meta->numeric, 'type' => $meta->type );

            }

            if( ! $this->rowsAffected ) return;

            $this->returnData = array();

            for( $i = 0; $i < $this->rowsAffected; $i++ ) {

               $this->returnData[] = $this->useAssociativeArray ? mysql_fetch_assoc($result) : mysql_fetch_row($result);

            }

            mysql_free_result($result);

         } else { // not a select statement

            $this->rowsAffected = mysql_affected_rows();

            $this->lastInsertKey = mysql_insert_id();

         }

         return true;

      } // function run

      /*

       * function will return one and only one row, NOT as an array of array

       * but as a single row array

       * if more than one row is returned by query, error is set and function

       * returns false.

       * Otherwise, function returns true

       */

      public function getOneRow( $sql = null ) {

         if ( isset( $sql ) )

            $this->query = $sql;

         $save = $this->useAssociativeArray;

         $useAssociativeArray = true;

         $this->run();

         $useAssociativeArray = $save;

         if ( $this->rowsAffected == 1 ) {

            $this->returnData = $this->returnData[0];

            return true;

         } else

            $this->error = "$this->rowsAffected rows returned from getOneRow";

         return false;

      } // getOneRow

      // function returns the first column of the first row of data returned from query

      // or null no value returned

      function getOneDBValue( $sql = null ) {

         if ( isset( $sql ) )

            $this->query = $sql;

         $save = $this->useAssociativeArray;

         $useAssociativeArray = false;

         $this->run();

         $useAssociativeArray = $save;

         return $this->rowsAffected ? $this->returnData[0][0] : null;

      }

      function countNumberOfRows ( $sql = null ) {

         if ( isset( $sql ) )

            $this->query = $sql;

         $save = $this->useAssociativeArray;

         $useAssociativeArray = false;

         $this->run();

         $useAssociativeArray = $save;

         return $this->rowsAffected;

      }

      function makeWhereClause ($conditions, $joinedBy = 'and') {

         $joinedBy = " $joinedBy "; // make sure there are spaces around it

         $whereClause = ' where ' . implode ( $joinedBy, $conditions );

         return $whereClause;

      }

      /* 

         values is an associative array of name/value pairs

         function will replace all items of the form <$name> with its values (the less than and greater than symbols around the key)

      */

      function insertValuesIntoQuery( $values ) {

         foreach ( $values as $name => $value ) {

            $this->query = search_replace_string($this->query, "<$name>", $value );

         }

      }

      /*

       * function will attempt to make a constant ($value) safe for SQL depending on the type.

       * 

       * if $value is empty, $default is returned, as will happen if any of the

       * conversions (date, datetime, etc...) fail.

       * 

       * First, it will pass it through get_magic_quotes_gpc, 

       * then will run through mysql_real_escape_string

       * 

       * For strings, will encapsulate in quotes

       * Dates will attempt a conversion, then change to YYYY-MM-DD and encapsulate in quotes

       * DateTime will perform the same, but change to YYYY-MM-DD HH:MM:SS

       * Integer and Floats are passed through builtins intval and floatval

       * Boolean only checks the first character, a '0', 'f' and 'n' denoting false

       *    all else denoting true. The result is converted based on the variable

       *    $falsetrue, with the first char denoting false and the second denoting true

       */

      public static function makeSafeSQLConstant ( $value, $type='S', $default='null', $falsetrue='10' ) {

         if (strlen($value) == 0) // simply set any empty values to null

            return $default;

         // print "Processing $value as $type with default $default<br>\n";

         switch ( strtolower( $type ) ) {

            case 'string' :

            case 's' : 

                     if ( get_magic_quotes_gpc() ) 

                        $value = stripslashes($value);

                     $value = mysql_real_escape_string( $value );

                     $value = strlen( $value ) > 0 ? "'$value'" : $default;

                     break;

            case 'date' :

            case 'd' :

                     if ( $value != 'null' ) {

                        $result = strtotime( $value );

                        $value = ( $result === false ) ? $default : "'" . Date( 'Y-m-d', $result) . "'";

                     }

                     break;

            case 'datetime':

            case 'timestamp':

            case 'dt': 

                     if ( $value != 'null' ) {

                        $result = strtotime( $value );

                        $value = ( $result === false ) ? $default : "'" . Date( 'Y-m-d H:i:s', $result) . "'";

                     }

                     break;

            case 'integer':

            case 'i' :  

                     $value = intval( $value );

                     break;

            case 'float':

            case 'f' :  

                     $value = floatval( $value );

                     break;

            case 'bool':

            case 'boolean':

            case 'b' :  // note, because of the way strpos works, you can not

                        // simply set $value based on the output; you MUST do

                        // as below; specifically check for false, then set the result

                        $value =  strpos( '0fn', strtolower(substr( $value, 0, 1 )) ) === false ? 0 : 1;

                        $value = substr( $falsetrue, $value, 0, 1 );

                        break;

         } // switch

         return $value;

      }

   } // class DBQuery

?>