andela-tolotin / Potato-ORM

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
    */

Indentation +177 added lines, -177 removed lines

@@ -10,129 +10,129 @@ 
 
 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)
-    {
-        $tableFields = $this->getColumnNames($this->model, $this->dbConnection);
-
-        $unexpectedFields = self::filterClassAttributes($tableFields, $associative1DArray);
-
-        if (count($unexpectedFields) > 0) {
-            throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
-        }
-
-        unset($associative1DArray[0]);
-
-        if (is_null($dbConn)) {
-            $dbConn = $this->dbConnection;
-        }
-
-        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;
-
-        $TableValues = implode(',', array_keys($associative1DArray));
-
-        foreach ($associative1DArray as $field => $value) {
-            $FormValues[] = "'".trim(addslashes($value))."'";
-        }
-
-        $splittedTableValues = implode(',', $FormValues);
-
-        $insertQuery .= ' ('.$TableValues.')';
-        $insertQuery .= ' VALUES ('.$splittedTableValues.')';
-
-        $executeQuery = $dbConn->exec($insertQuery);
-
-        if ($executeQuery) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * 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;
-        }
-
-        $updateSql = "UPDATE `$tableName` SET ";
-
-        unset($associative1DArray['id']);
-
-        $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');
-        }
+	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)
+	{
+		$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
+
+		$unexpectedFields = self::filterClassAttributes($tableFields, $associative1DArray);
+
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::create($unexpectedFields, 'needs to be created as a table field');
+		}
+
+		unset($associative1DArray[0]);
+
+		if (is_null($dbConn)) {
+			$dbConn = $this->dbConnection;
+		}
+
+		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;
+
+		$TableValues = implode(',', array_keys($associative1DArray));
+
+		foreach ($associative1DArray as $field => $value) {
+			$FormValues[] = "'".trim(addslashes($value))."'";
+		}
+
+		$splittedTableValues = implode(',', $FormValues);
+
+		$insertQuery .= ' ('.$TableValues.')';
+		$insertQuery .= ' VALUES ('.$splittedTableValues.')';
+
+		$executeQuery = $dbConn->exec($insertQuery);
+
+		if ($executeQuery) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * 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;
+		}
+
+		$updateSql = "UPDATE `$tableName` SET ";
+
+		unset($associative1DArray['id']);
+
+		$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');
+		}
 
-        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.
@@ -143,26 +143,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;
    }
 
   /**
@@ -174,19 +174,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');
   }
 
   /**
@@ -199,15 +199,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;
   }
 
   /**
@@ -219,13 +219,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;
   }
 
   /**
@@ -239,26 +239,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');
   }
 
   /**
@@ -271,24 +271,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;
   }
 }

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;
           }
       }

src/Model/BaseModel.php

Indentation +181 added lines, -181 removed lines

@@ -8,169 +8,169 @@ 
 
 class BaseModel implements BaseModelInterface
 {
-    // Inject the inflector trait
-    use Inflector;
-
-    // Private variable that contains instance of database
-    protected $databaseModel;
-
-    // Class variable holding class name pluralized
-    protected $tableName;
-
-    // Properties will later contain key, value pairs from the magic setter, getter methods
-    protected $properties = [];
-
-    public function __construct()
-    {
-        $this->tableName = $this->getClassName();
-
-        $this->databaseModel = new DatabaseHandler($this->tableName);
-
-        $this->properties['id'] = 0;
-    }
-
-    /**
-     * The magic getter method.
-     *
-     * @params key
-     *
-     * @return array key
-     */
-    public function __get($key)
-    {
-        $this->properties[$key];
-    }
-
-    /**
-     * The magic setter method.
-     *
-     * @params property, key
-     *
-     * @return array associative array properties
-     */
-    public function __set($property, $value)
-    {
-        $this->properties[$property] = $value;
-    }
-
-    /**
-     * This method gets all the record from a particular table.
-     *
-     * @params void
-     *
-     * @throws NoRecordFoundException
-     *
-     * @return associative array
-     */
-    public static function getAll()
-    {
-        $allData = DatabaseHandler::read($id = false, self::getClassName());
-
-        if (count($allData) > 0) {
-            return $allData;
-        }
-
-        throw NoRecordFoundException::create('There is no record to display');
-    }
-
-    /**
-     * This method create or update record in a database table.
-     *
-     * @params void
-     *
-     * @throws EmptyArrayException
-     * @throws NoRecordInsertionException
-     * @throws NoRecordUpdateException
-     *
-     * @return bool true or false;
-     */
-    public function save($dbConn = Null)
-    {
-        if (is_null($dbConn)) {
-            $dbConn = new DatabaseConnection();
-        }
-
-        $boolCommit = false;
-
-        if ($this->properties['id']) {
-
-            $allData = DatabaseHandler::read($this->properties['id'], self::getClassName(), $dbConn);
-
-            if ($this->checkIfRecordIsEmpty($allData)) {
-                $boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties, $dbConn);
-
-                if ($boolCommit) {
-                    return true;
-                }
-
-                throw NoRecordUpdateException::create('Record not updated successfully');
-            }
-
-            throw EmptyArrayException::create("Value passed didn't match any record");
-        }
-
-        $boolCommit = $this->databaseModel->create($this->properties, $this->tableName, $dbConn);
-
-        if ($boolCommit) {
-            return true;
-        }
-
-        throw NoRecordInsertionException::create('Record not created successfully');
-    }
-
-    /**
-     * This method find a record by id.
-     *
-     * @params int id
-     *
-     * @throws NoArgumentPassedToFunctionException
-     *
-     * @return object
-     */
-    public static function find($id)
-    {
-        $num_args = (int) func_num_args(); // get number of arguments passed to this function
-        if ($num_args == 0 || $num_args > 1) {
-            throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
-        }
-
-        if ($id == '') {
-            throw NullArgumentPassedToFunctionException::create('This function expect a value');
-        }
-
-        $staticFindInstance = new static();
-        $staticFindInstance->id = $id == '' ? false : $id;
-
-        return $staticFindInstance;
-    }
-
-    /**
-     * This method delete a row from the table by the row id.
-     *
-     * @params int id
-     *
-     * @throws NoRecordDeletionException;
-     *
-     * @return bool true or false
-     */
-    public static function destroy($id)
-    {
-        $boolDeleted = false;
-
-        $num_args = (int) func_num_args(); // get number of arguments passed to this function
-
-        if ($num_args == 0 || $num_args > 1) {
-            throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
-        }
-
-        $boolDeleted = DatabaseHandler::delete($id, self::getClassName());
-
-        if ($boolDeleted) {
-            return true;
-        }
-
-        throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
-    }
+	// Inject the inflector trait
+	use Inflector;
+
+	// Private variable that contains instance of database
+	protected $databaseModel;
+
+	// Class variable holding class name pluralized
+	protected $tableName;
+
+	// Properties will later contain key, value pairs from the magic setter, getter methods
+	protected $properties = [];
+
+	public function __construct()
+	{
+		$this->tableName = $this->getClassName();
+
+		$this->databaseModel = new DatabaseHandler($this->tableName);
+
+		$this->properties['id'] = 0;
+	}
+
+	/**
+	 * The magic getter method.
+	 *
+	 * @params key
+	 *
+	 * @return array key
+	 */
+	public function __get($key)
+	{
+		$this->properties[$key];
+	}
+
+	/**
+	 * The magic setter method.
+	 *
+	 * @params property, key
+	 *
+	 * @return array associative array properties
+	 */
+	public function __set($property, $value)
+	{
+		$this->properties[$property] = $value;
+	}
+
+	/**
+	 * This method gets all the record from a particular table.
+	 *
+	 * @params void
+	 *
+	 * @throws NoRecordFoundException
+	 *
+	 * @return associative array
+	 */
+	public static function getAll()
+	{
+		$allData = DatabaseHandler::read($id = false, self::getClassName());
+
+		if (count($allData) > 0) {
+			return $allData;
+		}
+
+		throw NoRecordFoundException::create('There is no record to display');
+	}
+
+	/**
+	 * This method create or update record in a database table.
+	 *
+	 * @params void
+	 *
+	 * @throws EmptyArrayException
+	 * @throws NoRecordInsertionException
+	 * @throws NoRecordUpdateException
+	 *
+	 * @return bool true or false;
+	 */
+	public function save($dbConn = Null)
+	{
+		if (is_null($dbConn)) {
+			$dbConn = new DatabaseConnection();
+		}
+
+		$boolCommit = false;
+
+		if ($this->properties['id']) {
+
+			$allData = DatabaseHandler::read($this->properties['id'], self::getClassName(), $dbConn);
+
+			if ($this->checkIfRecordIsEmpty($allData)) {
+				$boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties, $dbConn);
+
+				if ($boolCommit) {
+					return true;
+				}
+
+				throw NoRecordUpdateException::create('Record not updated successfully');
+			}
+
+			throw EmptyArrayException::create("Value passed didn't match any record");
+		}
+
+		$boolCommit = $this->databaseModel->create($this->properties, $this->tableName, $dbConn);
+
+		if ($boolCommit) {
+			return true;
+		}
+
+		throw NoRecordInsertionException::create('Record not created successfully');
+	}
+
+	/**
+	 * This method find a record by id.
+	 *
+	 * @params int id
+	 *
+	 * @throws NoArgumentPassedToFunctionException
+	 *
+	 * @return object
+	 */
+	public static function find($id)
+	{
+		$num_args = (int) func_num_args(); // get number of arguments passed to this function
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
+		}
+
+		if ($id == '') {
+			throw NullArgumentPassedToFunctionException::create('This function expect a value');
+		}
+
+		$staticFindInstance = new static();
+		$staticFindInstance->id = $id == '' ? false : $id;
+
+		return $staticFindInstance;
+	}
+
+	/**
+	 * This method delete a row from the table by the row id.
+	 *
+	 * @params int id
+	 *
+	 * @throws NoRecordDeletionException;
+	 *
+	 * @return bool true or false
+	 */
+	public static function destroy($id)
+	{
+		$boolDeleted = false;
+
+		$num_args = (int) func_num_args(); // get number of arguments passed to this function
+
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
+		}
+
+		$boolDeleted = DatabaseHandler::delete($id, self::getClassName());
+
+		if ($boolDeleted) {
+			return true;
+		}
+
+		throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
+	}
 
    /**
     * This method return the current class name
@@ -180,26 +180,26 @@ 
     */
    public static function getClassName()
    {
-       $tableName = preg_split('/(?=[A-Z])/', get_called_class());
+	   $tableName = preg_split('/(?=[A-Z])/', get_called_class());
 
-       $className = end($tableName);
+	   $className = end($tableName);
 
-       return self::pluralize(strtolower($className));
+	   return self::pluralize(strtolower($className));
    }
 
-    /**
-     * This method check if the argument passed to this function is an array.
-     *
-     * @param $arrayOfRecord
-     *
-     * @return bool
-     */
-    public function checkIfRecordIsEmpty($arrayOfRecord)
-    {
-        if (count($arrayOfRecord) > 0) {
-            return true;
-        }
-
-        return false;
-    }
+	/**
+	 * This method check if the argument passed to this function is an array.
+	 *
+	 * @param $arrayOfRecord
+	 *
+	 * @return bool
+	 */
+	public function checkIfRecordIsEmpty($arrayOfRecord)
+	{
+		if (count($arrayOfRecord) > 0) {
+			return true;
+		}
+
+		return false;
+	}
 }