WebSVN – php_users – Diff – /trunk/UsersDataSourceMySQLi.class.php

  * class.
+ *
  * To build a data access class for Users, the following 5 methods must
  * exist.
  * getPassword(username)
- * getRecord(username)
  * getAllUsers()
  * getARecord
  * update
+ *
  * Additionally, where appropriate, the following function is useful
+ *
  * @version 0.9.0 (beta)
  * @copyright 2021 Daily Data, Inc.
+ *
  */
+require_once( 'UsersDataSource.class.php' );
-class usersDataSource {
+class usersDataSourceMySQLi extends usersDataSource {
    /**
     * @var string[] $configuration Contains the configuration for the class
+    *
     * May be modified by the calling program. Must be replicated in userDataSource class
             'fields' => array(
                'login'  => array(
                      'dbColumn'  =>  'login',       // login name column name
                      'type'      => 'varchar',
                      'size'      => 64,
-                     'required'  => true
+                     'required'  => true,
+                     'unique'    => true
                      ),
                'pass'   => array(
                      'dbColumn'  => 'password',    // password column name
                      'type'   => 'varchar',
                      'size'      => 128,
        * If $dbLoginInfo is not null, will override $dbConnection, make
        * a new connection and use that.
+       *
        * If $dbDef is set, will be merged with $configuration
+       *
-       * @param mysqli $dbConnection Existing mysqli database connection
+       * @param mysqli $dbConnection Existing mysqli database connection or array with login information
        * @param string[] $dbDef Array to be merged with $configuration
-       * @param string[] $dbLoginInfo Array containing username, hostname, etc.. to make mysqli connection_aborted
+       *
        * @return null
+       *
        */
-      public function __construct( $dbConnection = null, $dbDef = array(), $dbLoginInfo = array() ) {
+      public function __construct( $connection, $customFields = array() ) {
+         parent::__construct( $customFields );
+         if ( is_array( $connection ) ) { // they sent us some login values
-         $this->dbConnection = $dbConnection;
+            $this->setDBConnection( $connection );
-         if ( $dbDef ) {
+         } elseif ( get_class( $connection ) == 'mysqli' ) {
-            $this->configuration = array_merge_recursive( $this->configuration, $dbDef );
+            $this->dbConnection = $connection;
-         }
+         } else {
-         if ( $dbLoginInfo ) {
-            $this->setDBConnection( $dbLoginInfo );
+            throw new Exception( 'Can not open database using; must give open mysqli class or array of login information' );
+         }
+      }
       /**
        * Make string safe for MySQL
       public function getPassword( $username ) {
          return $this->getARecord( array('login' => $username,'enabled' => 1), array('pass' => 1 ) );
+      }
       /**
+       * retrieves the userID from the table
+       *
+       * @param string $username
+       * @return integer user id
+       */
+      public function getUserID( $username ) {
+         $record = $this->getARecord( array( 'login' => $username ), array('id' => 1 ) );
+         return $record['id'];
+      }
+      /**
        * Make the database connection
+       *
        * @param string[] $parameters Parameters for makeing the connection
        * @return mysqli|false
        */
                   $fieldDef = $record['dbColumn'];
                   $fieldDef .= ' ' . $record['type'];
                   if ( isset( $record['size'] ) ) {
                      $fieldDef .= '(' . $record['size'] . ')';
+                  }
+                  if ( isset( $record['unique'] ) ) {
+                     $fieldDef .= ' unique ';
+                  }
                   if ( isset( $record['required'] ) ) {
                      $fieldDef .= $record['required'] ? ' not null ' : '';
+                  }
                   if ( isset( $record['default'] ) ) {
                      $fieldDef .= sprintf( " default '%s'", $record['default'] );
                   );
             $this->doSQL( $query );
+         }
+      }
+      /**
+       * Gets the actual database column name from the configuration file
+       *
+       * Since we use a lot of indirection, this is a handy function which
+       * allows us to replace something like
+       * $this->configuration['tables']['users']['fields']['name']['dbColumn']
+       * with
+       * $this->tableColumnName( 'users', 'name' )
+       *
+       * If called with only one parameter (the table), will return the
+       * actual database table name
+       *
+       * @param string $table Name of Table
+       * @param string $field Name of field in $table
+       * @param boolean $fullTableColumn If set to true, will return table.column format
+       *
+       * @return string The actual name of the dbColumn in the table
+       */
-      protected function tableColumnName ( $table, $field ) {
+      protected function tableColumnName ( $table, $field = '', $fullTableColumn = false ) {
+         if ( ! $field ) { // just return the table name
+            $return = $this->configuration['tables'][$table]['table'];
+         } elseif ( $field == 'id' ) { // looking for the index
+            $return = $this->configuration['tables'][$table]['id'];
+         } else { // return the column name
-         return $this->configuration['tables'][$table]['fields'][$field]['dbColumn'];
+            $return = $this->configuration['tables'][$table]['fields'][$field]['dbColumn'];
+         }
+         if ( $fullTableColumn && $field ) {
+            $return = $this->configuration['tables'][$table]['table'] . '.' . $return;
+         }
+         return $return;
+      }
       /**
        * Tests that the database connection works and the table is built
+       *
        * @return boolean True if table exists (does not verify columns)
        */
       public function test() {
-         $result = $this->doSQL( sprintf( "show tables like '%s'", $this->configuration['tables']['users']['table'] ) );
+         $query = sprintf( "show tables like '%s'", $this->tableColumnName ( 'users' ) );
+         $result = $this->doSQL( $query );
          return $result !== false && $result->num_rows;
       } // test
       /**
        * updates row in database with $newData
                foreach ( $this->configuration['tables']['users']['fields'] as $key => $record ) {
                   if ( isset( $newData[$key] ) ) {
                      $fields[] = $record['dbColumn'] . " = $newData[$key]";
                   } // if
+               }
-               $query = 'update ' . $this->configuration['tables']['users']['table'] . ' set ' .
+               $query = 'update ' . $this->tableColumnName ( 'users' ) . ' set ' .
                   implode( ',', $fields ) .
-                  ' where ' . $this->configuration['tables']['users']['id'] . ' = ' .
+                  ' where ' . $this->tableColumnName ( 'users', 'id' ) . ' = ' .
                   $this->escapeString( $newData['id'] );
             } else { // we are doing an insert
                $columns = array();
                $values = array();
                foreach ( $this->configuration['tables']['users']['fields'] as $key => $record ) {
                   if ( isset( $newData[$key] ) ) {
                      $columns[] = $record['dbColumn'];
                      $values[] = $newData[$key];
                   } // if
+               }
-               $query = 'insert into ' . $this->configuration['tables']['users']['table'] .
+               $query = 'insert into ' . $this->tableColumnName ( 'users' ) .
                   '(' . implode( ',', $columns ) . ') values (' .
                   implode( ',', $values ) . ')';
+            }
-            return $this->doSQL( $query, 'update' );
+            return $this->doSQL( $query );
+         }
       } // update
       /**
        * retrieves all users from the database

Subversion Repositories php_users

(root)/trunk/UsersDataSourceMySQLi.class.php – Rev 18 → 21