andela-tolotin / Potato-ORM

src/Exceptions/NoRecordUpdateException.php

Indentation +4 added lines, -4 removed lines

@@ -10,8 +10,8 @@
 
 class NoRecordDeletionException extends Exception
 {
-    public static function create($message)
-    {
-        return new static($message);
-    }
+	public static function create($message)
+	{
+		return new static($message);
+	}
 }

src/Interface/BaseModelInterface.php

Indentation +32 added lines, -32 removed lines

@@ -8,39 +8,39 @@
 
 interface InterfaceBaseClass
 {
-    /**
-     * This method gets all the record from a particular table.
-     *
-     * @params void
-     *
-     * @return associative array
-     */
-    public static function getAll();
+	/**
+	 * This method gets all the record from a particular table.
+	 *
+	 * @params void
+	 *
+	 * @return associative array
+	 */
+	public static function getAll();
 
-    /**
-     * This method create or update record in a database table.
-     *
-     * @params void
-     *
-     * @return bool true or false;
-     */
-    public function save();
+	/**
+	 * This method create or update record in a database table.
+	 *
+	 * @params void
+	 *
+	 * @return bool true or false;
+	 */
+	public function save();
 
-    /**
-     * This method delete a row from the table by the row id.
-     *
-     * @params int $id
-     *
-     * @return bool true or false
-     */
-    public static function destroy($id);
+	/**
+	 * This method delete a row from the table by the row id.
+	 *
+	 * @params int $id
+	 *
+	 * @return bool true or false
+	 */
+	public static function destroy($id);
 
-    /**
-     * This method find a record by id.
-     *
-     * @params int $id
-     *
-     * @return object find
-     */
-    public static function find($id);
+	/**
+	 * This method find a record by id.
+	 *
+	 * @params int $id
+	 *
+	 * @return object find
+	 */
+	public static function find($id);
 }

src/Database/DatabaseConnection.php

Indentation +59 added lines, -59 removed lines

@@ -12,71 +12,71 @@
 
 class DatabaseConnection extends PDO
 {
-    private $databaseName;
-    private $databaseHost;
-    private $databaseDriver;
-    private $databaseUsername;
-    private $databasePassword;
+	private $databaseName;
+	private $databaseHost;
+	private $databaseDriver;
+	private $databaseUsername;
+	private $databasePassword;
 
-    public function __construct()
-    {
-        $this->loadEnv(); // load the environment variables
+	public function __construct()
+	{
+		$this->loadEnv(); // load the environment variables
 
-        $this->databaseName = getenv('databaseName');
-        $this->databaseHost = getenv('databaseHost');
-        $this->databaseDriver = getenv('databaseDriver');
-        $this->databaseUsername = getenv('databaseUsername');
-        $this->databasePassword = getenv('databasePassword');
+		$this->databaseName = getenv('databaseName');
+		$this->databaseHost = getenv('databaseHost');
+		$this->databaseDriver = getenv('databaseDriver');
+		$this->databaseUsername = getenv('databaseUsername');
+		$this->databasePassword = getenv('databasePassword');
 
-        try {
-            $options = [
-                PDO::ATTR_PERSISTENT => true,
-                PDO::ATTR_ERRMODE    => PDO::ERRMODE_EXCEPTION,
-            ];
+		try {
+			$options = [
+				PDO::ATTR_PERSISTENT => true,
+				PDO::ATTR_ERRMODE    => PDO::ERRMODE_EXCEPTION,
+			];
 
-            parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
-        } catch (PDOException $e) {
-            return $e->getMessage();
-        }
-    }
+			parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
+		} catch (PDOException $e) {
+			return $e->getMessage();
+		}
+	}
 
-     /**
-      * This method determines the driver to be used for appropriate database server.
-      *
-      * @params void
-      *
-      * @return string dsn
-      */
-     public function getDatabaseDriver()
-     {
-         $dsn = '';
+	 /**
+	  * This method determines the driver to be used for appropriate database server.
+	  *
+	  * @params void
+	  *
+	  * @return string dsn
+	  */
+	 public function getDatabaseDriver()
+	 {
+		 $dsn = '';
 
-         switch ($this->databaseDriver) {
-            case 'mysql':
-                $dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName; // Set DSN
-                break;
-            case 'sqlite':
-                $dsn = 'sqlite:host='.$this->databaseHost.';dbname='.$this->databaseName;
-                break;
-            case 'pgsql':
-                $dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='.$this->databaseName;
-                break;
-            default:
-                $dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
-                break;
-        }
+		 switch ($this->databaseDriver) {
+			case 'mysql':
+				$dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName; // Set DSN
+				break;
+			case 'sqlite':
+				$dsn = 'sqlite:host='.$this->databaseHost.';dbname='.$this->databaseName;
+				break;
+			case 'pgsql':
+				$dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='.$this->databaseName;
+				break;
+			default:
+				$dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
+				break;
+		}
 
-         return $dsn;
-     }
+		 return $dsn;
+	 }
 
-     /**
-      * Load Dotenv to grant getenv() access to environment variables in .env file.
-      */
-     public function loadEnv()
-     {
-         if (! getenv('APP_ENV')) {
-             $dotenv = new Dotenv(__DIR__.'/../../');
-             $dotenv->load();
-         }
-     }
+	 /**
+	  * Load Dotenv to grant getenv() access to environment variables in .env file.
+	  */
+	 public function loadEnv()
+	 {
+		 if (! getenv('APP_ENV')) {
+			 $dotenv = new Dotenv(__DIR__.'/../../');
+			 $dotenv->load();
+		 }
+	 }
 }

Spacing +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
       */
      public function loadEnv()
      {
-         if (! getenv('APP_ENV')) {
+         if (!getenv('APP_ENV')) {
              $dotenv = new Dotenv(__DIR__.'/../../');
              $dotenv->load();
          }

src/Database/DatabaseHelper.php

Indentation +23 added lines, -23 removed lines

@@ -8,32 +8,32 @@
 
 class DatabaseHelper
 {
-    public $dbConn;
+	public $dbConn;
 
-    /**
-     * This is a constructor; a default method  that will be called automatically during class instantiation.
-     */
-    public function __construct($dbConnect)
-    {
-        $this->dbConn = $dbConnect;
-    }
+	/**
+	 * This is a constructor; a default method  that will be called automatically during class instantiation.
+	 */
+	public function __construct($dbConnect)
+	{
+		$this->dbConn = $dbConnect;
+	}
 
-    /**
-     * This method creates a particular table.
-     *
-     * @param tableName
-     * $return boolean true or false
-     */
-    public function createTable($tableName, $conn = null)
-    {
-        if (is_null($conn)) {
-            $conn = $this->dbConn;
-        }
+	/**
+	 * This method creates a particular table.
+	 *
+	 * @param tableName
+	 * $return boolean true or false
+	 */
+	public function createTable($tableName, $conn = null)
+	{
+		if (is_null($conn)) {
+			$conn = $this->dbConn;
+		}
 
-        $sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'(';
-        $sql .= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
+		$sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'(';
+		$sql .= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
 
-        return $conn->exec($sql);
+		return $conn->exec($sql);
         
-    }
+	}
 }

src/Database/DatabaseHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -17,6 +17,7 @@ 
 
     /**
      * This is a constructor; a default method  that will be called automatically during class instantiation.
+     * @param string|false $modelClassName
      */
     public function __construct($modelClassName, $dbConn = null)
     {
@@ -33,6 +34,7 @@ 
      * This method create a record and store it in a table row.
      *
      * @params associative array, string tablename
+     * @param string|false $tableName
      *
      * @return bool true or false
      */
@@ -92,6 +94,7 @@ 
      * This method updates any table by supplying 3 parameter.
      *
      * @params: $updateParams, $tableName, $associative1DArray
+     * @param string|false $tableName
      *
      * @return bool true or false
      */
@@ -138,6 +141,7 @@ 
     * This method retrieves record from a table.
     *
     * @params int id, string tableName
+    * @param string|false $tableName
     *
     * @return array
     */
@@ -169,6 +173,7 @@ 
    * This method deletes a record  from a table row.
    *
    * @params int id, string tableName
+   * @param string|false $tableName
    *
    * @return bool true or false
    */
@@ -213,7 +218,7 @@ 
   /**
    * This method returns sql query.
    *
-   * @param $sql
+   * @param string $sql
    *
    * @return string
    */

Spacing +1 added lines, -1 removed lines

@@ -202,7 +202,7 @@
       $unexpectedFields = [];
 
       foreach ($userSetterArray as $key => $val) {
-          if (! in_array($key, $tableColumn)) {
+          if (!in_array($key, $tableColumn)) {
               $unexpectedFields[] = $key;
           }
       }

Indentation +160 added lines, -160 removed lines

@@ -10,128 +10,128 @@ 
 
 class DatabaseHandler
 {
-    private $tableFields;
-    private $dbHelperInstance;
-    private $dbConnection;
-    private $model;
-
-    /**
-     * This is a constructor; a default method  that will be called automatically during class instantiation.
-     */
-    public function __construct($modelClassName, $dbConn = null)
-    {
-        if (is_null($dbConn)) {
-            $this->dbConnection = new DatabaseConnection();
-        } else {
-            $this->dbConnection = $dbConn;
-        }
-
-        $this->model = $modelClassName;
-    }
-
-    /**
-     * This method create a record and store it in a table row.
-     *
-     * @params associative array, string tablename
-     *
-     * @return bool true or false
-     */
-    public function create($associative1DArray, $tableName, $dbConn = Null)
-    {
-        if (is_null($dbConn)) {
-            $dbConn = $this->dbConnection;
-        }
-
-        $tableFields = $this->getColumnNames($this->model, $dbConn);
-
-        $unexpectedFields = self::filterClassAttributes($tableFields, $associative1DArray);
-
-        if (count($unexpectedFields) > 0) {
-            throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
-        }
-
-        unset($associative1DArray[0]);
-
-        return $this->insertRecord($dbConn, $tableName, $associative1DArray);
+	private $tableFields;
+	private $dbHelperInstance;
+	private $dbConnection;
+	private $model;
+
+	/**
+	 * This is a constructor; a default method  that will be called automatically during class instantiation.
+	 */
+	public function __construct($modelClassName, $dbConn = null)
+	{
+		if (is_null($dbConn)) {
+			$this->dbConnection = new DatabaseConnection();
+		} else {
+			$this->dbConnection = $dbConn;
+		}
+
+		$this->model = $modelClassName;
+	}
+
+	/**
+	 * This method create a record and store it in a table row.
+	 *
+	 * @params associative array, string tablename
+	 *
+	 * @return bool true or false
+	 */
+	public function create($associative1DArray, $tableName, $dbConn = Null)
+	{
+		if (is_null($dbConn)) {
+			$dbConn = $this->dbConnection;
+		}
+
+		$tableFields = $this->getColumnNames($this->model, $dbConn);
+
+		$unexpectedFields = self::filterClassAttributes($tableFields, $associative1DArray);
+
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
+		}
+
+		unset($associative1DArray[0]);
+
+		return $this->insertRecord($dbConn, $tableName, $associative1DArray);
 
         
-    }
+	}
 
-    /**
-     * This method runs the insertion query.
-     *
-     * @param  $dbConn
-     * @param  $tableName
-     * @param  $associative1DArray
-     *
-     * @return bool true
-     */
-    private function insertRecord($dbConn, $tableName, $associative1DArray)
-    {
-        $insertQuery = 'INSERT INTO '.$tableName;
+	/**
+	 * This method runs the insertion query.
+	 *
+	 * @param  $dbConn
+	 * @param  $tableName
+	 * @param  $associative1DArray
+	 *
+	 * @return bool true
+	 */
+	private function insertRecord($dbConn, $tableName, $associative1DArray)
+	{
+		$insertQuery = 'INSERT INTO '.$tableName;
 
-        $TableValues = implode(',', array_keys($associative1DArray));
+		$TableValues = implode(',', array_keys($associative1DArray));
 
-        foreach ($associative1DArray as $field => $value) {
-            $FormValues[] = "'".trim(addslashes($value))."'";
-        }
+		foreach ($associative1DArray as $field => $value) {
+			$FormValues[] = "'".trim(addslashes($value))."'";
+		}
 
-        $splittedTableValues = implode(',', $FormValues);
+		$splittedTableValues = implode(',', $FormValues);
 
-        $insertQuery .= ' ('.$TableValues.')';
-        $insertQuery .= ' VALUES ('.$splittedTableValues.')';
+		$insertQuery .= ' ('.$TableValues.')';
+		$insertQuery .= ' VALUES ('.$splittedTableValues.')';
 
-        $executeQuery = $dbConn->exec($insertQuery);
+		$executeQuery = $dbConn->exec($insertQuery);
 
-        return $executeQuery;
+		return $executeQuery;
         
-    }
+	}
 
-    /**
-     * This method updates any table by supplying 3 parameter.
-     *
-     * @params: $updateParams, $tableName, $associative1DArray
-     *
-     * @return bool true or false
-     */
-    public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = null)
-    {
-        $sql = '';
+	/**
+	 * This method updates any table by supplying 3 parameter.
+	 *
+	 * @params: $updateParams, $tableName, $associative1DArray
+	 *
+	 * @return bool true or false
+	 */
+	public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = null)
+	{
+		$sql = '';
 
-        if (is_null($dbConn)) {
-            $dbConn = $this->dbConnection;
-        }
+		if (is_null($dbConn)) {
+			$dbConn = $this->dbConnection;
+		}
 
-        $updateSql = "UPDATE `$tableName` SET ";
+		$updateSql = "UPDATE `$tableName` SET ";
 
-        unset($associative1DArray['id']);
+		unset($associative1DArray['id']);
 
-        $unexpectedFields = self::filterClassAttributes($this->getColumnNames($this->model, $dbConn), $associative1DArray);
+		$unexpectedFields = self::filterClassAttributes($this->getColumnNames($this->model, $dbConn), $associative1DArray);
 
-        if (count($unexpectedFields) > 0) {
-            throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
-        }
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
+		}
 
-        foreach ($associative1DArray as $field => $value) {
-            $sql .= "`$field` = '$value'".',';
-        }
+		foreach ($associative1DArray as $field => $value) {
+			$sql .= "`$field` = '$value'".',';
+		}
 
-        $updateSql .= $this->prepareUpdateQuery($sql);
+		$updateSql .= $this->prepareUpdateQuery($sql);
 
-        foreach ($updateParams as $key => $val) {
-            $updateSql .= " WHERE $key = $val";
-        }
+		foreach ($updateParams as $key => $val) {
+			$updateSql .= " WHERE $key = $val";
+		}
 
-        $stmt = $dbConn->prepare($updateSql);
+		$stmt = $dbConn->prepare($updateSql);
 
-        $boolResponse = $stmt->execute();
+		$boolResponse = $stmt->execute();
 
-        if ($boolResponse) {
-            return true;
-        }
+		if ($boolResponse) {
+			return true;
+		}
 
-        return false;
-    }
+		return false;
+	}
 
    /**
     * This method retrieves record from a table.
@@ -142,26 +142,26 @@ 
     */
    public static function read($id, $tableName, $dbConn = null)
    {
-       $tableData = [];
+	   $tableData = [];
 
-       if (is_null($dbConn)) {
-           $dbConn = new DatabaseConnection();
-       }
+	   if (is_null($dbConn)) {
+		   $dbConn = new DatabaseConnection();
+	   }
 
-       $sql = $id ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
+	   $sql = $id ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
 
-       $stmt = $dbConn->prepare($sql);
-       $stmt->bindValue(':table', $tableName);
-       $stmt->bindValue(':id', $id);
-       $stmt->execute();
+	   $stmt = $dbConn->prepare($sql);
+	   $stmt->bindValue(':table', $tableName);
+	   $stmt->bindValue(':id', $id);
+	   $stmt->execute();
 
-       $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
+	   $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-       foreach ($results as $result) {
-           array_push($tableData, $result);
-       }
+	   foreach ($results as $result) {
+		   array_push($tableData, $result);
+	   }
 
-       return $tableData;
+	   return $tableData;
    }
 
   /**
@@ -173,19 +173,19 @@ 
    */
   public static function delete($id, $tableName, $dbConn = null)
   {
-      if (is_null($dbConn)) {
-          $dbConn = new DatabaseConnection();
-      }
+	  if (is_null($dbConn)) {
+		  $dbConn = new DatabaseConnection();
+	  }
 
-      $sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
+	  $sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
 
-      $boolResponse = $dbConn->exec($sql);
+	  $boolResponse = $dbConn->exec($sql);
 
-      if ($boolResponse) {
-          return true;
-      }
+	  if ($boolResponse) {
+		  return true;
+	  }
 
-      throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
+	  throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
   }
 
   /**
@@ -198,15 +198,15 @@ 
    */
   public static function filterClassAttributes(array $tableColumn, array $userSetterArray)
   {
-      $unexpectedFields = [];
+	  $unexpectedFields = [];
 
-      foreach ($userSetterArray as $key => $val) {
-          if (! in_array($key, $tableColumn)) {
-              $unexpectedFields[] = $key;
-          }
-      }
+	  foreach ($userSetterArray as $key => $val) {
+		  if (! in_array($key, $tableColumn)) {
+			  $unexpectedFields[] = $key;
+		  }
+	  }
 
-      return $unexpectedFields;
+	  return $unexpectedFields;
   }
 
   /**
@@ -218,13 +218,13 @@ 
    */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(',', $sql);
+	  $splittedQuery = explode(',', $sql);
 
-      array_pop($splittedQuery);
+	  array_pop($splittedQuery);
 
-      $mergeData = implode(',', $splittedQuery);
+	  $mergeData = implode(',', $splittedQuery);
 
-      return $mergeData;
+	  return $mergeData;
   }
 
   /**
@@ -238,26 +238,26 @@ 
    */
   public function findAndWhere($params, $tableName, $dbConn = null)
   {
-      if (is_null($dbConn)) {
-          $dbConn = $this->dbConnection;
-      }
+	  if (is_null($dbConn)) {
+		  $dbConn = $this->dbConnection;
+	  }
 
-      if (is_array($params) && !empty($params)) {
-          $sql = 'SELECT * FROM '.$tableName;
+	  if (is_array($params) && !empty($params)) {
+		  $sql = 'SELECT * FROM '.$tableName;
 
-          foreach ($params as $key => $val) {
-              $sql .= " WHERE `$key` = '$val'";
-          }
+		  foreach ($params as $key => $val) {
+			  $sql .= " WHERE `$key` = '$val'";
+		  }
 
-          $statement = $dbConn->prepare($sql);
-          $statement->execute();
+		  $statement = $dbConn->prepare($sql);
+		  $statement->execute();
 
-          $returnedRowNumbers = $statement->rowCount();
+		  $returnedRowNumbers = $statement->rowCount();
 
-          return $returnedRowNumbers ? true : false;
-      }
+		  return $returnedRowNumbers ? true : false;
+	  }
 
-      throw EmptyArrayException::create('Array Expected: parameter passed to this function is not an array');
+	  throw EmptyArrayException::create('Array Expected: parameter passed to this function is not an array');
   }
 
   /**
@@ -270,24 +270,24 @@ 
    */
   public function getColumnNames($table, $dbConn = null)
   {
-      $tableFields = [];
+	  $tableFields = [];
 
-      if (is_null($dbConn)) {
-          $dbConn = $this->dbConnection;
-      }
+	  if (is_null($dbConn)) {
+		  $dbConn = $this->dbConnection;
+	  }
 
-      $sql = 'SHOW COLUMNS FROM '.$table;
+	  $sql = 'SHOW COLUMNS FROM '.$table;
 
-      $stmt = $dbConn->prepare($sql);
-      $stmt->bindValue(':table', $table, PDO::PARAM_STR);
-      $stmt->execute();
+	  $stmt = $dbConn->prepare($sql);
+	  $stmt->bindValue(':table', $table, PDO::PARAM_STR);
+	  $stmt->execute();
 
-      $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
+	  $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-      foreach ($results as $result) {
-          array_push($tableFields, $result['Field']);
-      }
+	  foreach ($results as $result) {
+		  array_push($tableFields, $result['Field']);
+	  }
 
-      return $tableFields;
+	  return $tableFields;
   }
 }