andela-tolotin / Potato-ORM

src/Interface/InterfaceBaseClass.php

Indentation +6 added lines, -6 removed lines

@@ -10,12 +10,12 @@
 
 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

src/Database/DatabaseHandler.php

Doc Comments +7 added lines, -1 removed lines

@@ -21,6 +21,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)
      {
@@ -35,6 +36,7 @@ 
     /**
      * This method create a record and store it in a table row
      * @params associative array, string tablename
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function create($associative1DArray, $tableName, $dbConn = Null)
@@ -69,6 +71,7 @@ 
     /**
      * This method updates any table by supplying 3 parameter
      * @params: $updateParams, $tableName, $associative1DArray
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
@@ -101,6 +104,7 @@ 
   /**
    * This method retrieves record from a table
    * @params int id, string tableName
+   * @param string|false $tableName
    * @return array
    */
    public static function read($id, $tableName, $dbConn = Null)
@@ -131,6 +135,7 @@ 
   /**
    * This method deletes a record  from a table row
    * @params int id, string tableName
+   * @param string|false $tableName
    * @return boolean true or false
    */
   public static function delete($id, $tableName, $dbConn = Null)
@@ -163,7 +168,7 @@ 
   
   /**
    * This method returns sql query
-   * @param $sql
+   * @param string $sql
    * @return string
    */
   public function prepareUpdateQuery($sql)
@@ -204,6 +209,7 @@ 
    * This method returns column fields of a particular table
    * @param $table
    * @param $conn
+   * @param DatabaseConnection $dbConn
    * @return array
    */
  public function getColumnNames($table, $dbConn = Null) {

Unused Use Statements -2 removed lines

@@ -9,10 +9,8 @@
 namespace Laztopaz\potatoORM;
 
 use PDO;
-use Laztopaz\potatoORM\DatabaseHelper;
 use Laztopaz\potatoORM\TableFieldUndefinedException;
 use Laztopaz\potatoORM\EmptyArrayException;
-
 use Laztopaz\potatoORM\NoRecordDeletionException;
 use Laztopaz\potatoORM\NoRecordInsertionException;
 use Laztopaz\potatoORM\NoRecordUpdateException;

Indentation +137 added lines, -137 removed lines

@@ -18,98 +18,98 @@ 
 use Laztopaz\potatoORM\NoRecordUpdateException;
 
 class DatabaseHandler {
-    private $tableFields;
-    private $dbHelperInstance;
-    private $dbConnection;
-    private $model;
+	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 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 boolean true or false
-     */
-    public function create($associative1DArray, $tableName, $dbConn = Null) {
-    	$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
-    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
-    	if (count($unexpectedFields) > 0) {
-    	    throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields,"needs to be created as table field");
-    	}
-      unset($associative1DArray[0]);
-    	if (is_null($dbConn)) {
-    	    $dbConn = $this->dbConnection;
-    	}
-    	  return $this->insertRecord($dbConn, $tableName, $associative1DArray);
-    }
+	/**
+	 * This method create a record and store it in a table row
+	 * @params associative array, string tablename
+	 * @return boolean true or false
+	 */
+	public function create($associative1DArray, $tableName, $dbConn = Null) {
+		$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields,"needs to be created as table field");
+		}
+	  unset($associative1DArray[0]);
+		if (is_null($dbConn)) {
+			$dbConn = $this->dbConnection;
+		}
+		  return $this->insertRecord($dbConn, $tableName, $associative1DArray);
+	}
     
-    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;
-
-    	throw NoRecordInsertionException::checkNoRecordAddedException("Record not inserted successfully");
-    }
-
-    /**
-     * This method updates any table by supplying 3 parameter
-     * @params: $updateParams, $tableName, $associative1DArray
-     * @return boolean 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::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
+	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;
+
+		throw NoRecordInsertionException::checkNoRecordAddedException("Record not inserted successfully");
+	}
+
+	/**
+	 * This method updates any table by supplying 3 parameter
+	 * @params: $updateParams, $tableName, $associative1DArray
+	 * @return boolean 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::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
   
-    	if (count($unexpectedFields) > 0) {
-    		throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
-    	}
-    	foreach($associative1DArray as $field => $value) {
-    	    $sql .= "`$field` = '$value'".",";
-    	}
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
+		}
+		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";
-    	}
-    	$stmt = $dbConn->prepare($updateSql);
+		foreach ($updateParams as $key => $val) {
+			$updateSql .= " WHERE $key = $val";
+		}
+		$stmt = $dbConn->prepare($updateSql);
 
-    	$boolResponse = $stmt->execute();
+		$boolResponse = $stmt->execute();
 
-      if ($boolResponse) {
-         return true;
-      }
-      return false;
+	  if ($boolResponse) {
+		 return true;
+	  }
+	  return false;
 
-      throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully");
-    }
+	  throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully");
+	}
     
   /**
    * This method retrieves record from a table
@@ -121,22 +121,22 @@ 
    	$tableData = [];
    	
    	if (is_null($dbConn)) {
-   	    $dbConn = new DatabaseConnection();
+   		$dbConn = new DatabaseConnection();
    	}
    	$sql = $id  ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
    	
    	try {
-   	    $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();
    	} catch (PDOException $e) {
-   	    return  $e->getMessage();
+   		return  $e->getMessage();
    	}
    	$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
    	
    	foreach($results as $result) {
-   	    array_push($tableData, $result);
+   		array_push($tableData, $result);
    	}
    	return $tableData;
    }
@@ -148,20 +148,20 @@ 
    */
   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) {
+	  if ($boolResponse) {
 
-        return true;
-      }
+		return true;
+	  }
 
-      throw NoRecordDeletionException::checkNoRecordDeleteException("Record not deleted successfully");
+	  throw NoRecordDeletionException::checkNoRecordDeleteException("Record not deleted successfully");
   }
   
   /**
@@ -172,13 +172,13 @@ 
    */
   public static function checkIfMagicSetterContainsIsSameAsClassModel(array $tableColumn, array $userSetterArray)
   {
-      $unexpectedFields = [];
-      foreach ($userSetterArray as $key => $val) {
-          if (!in_array($key,$tableColumn)) {
-              $unexpectedFields[] = $key;
-          }
-      }
-      return $unexpectedFields;
+	  $unexpectedFields = [];
+	  foreach ($userSetterArray as $key => $val) {
+		  if (!in_array($key,$tableColumn)) {
+			  $unexpectedFields[] = $key;
+		  }
+	  }
+	  return $unexpectedFields;
   }
   
   /**
@@ -188,10 +188,10 @@ 
    */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(",",$sql);
-      array_pop($splittedQuery);
-      $mergeData = implode(",",$splittedQuery);
-      return $mergeData;
+	  $splittedQuery = explode(",",$sql);
+	  array_pop($splittedQuery);
+	  $mergeData = implode(",",$splittedQuery);
+	  return $mergeData;
   }
   
   /**
@@ -203,21 +203,21 @@ 
    */
   public function findAndWhere($params, $tableName, $dbConn = Null)
   {
-      if (is_null($dbConn)) {
-          $dbConn = $this->dbConnection;
-      }
-      if (is_array($params) && !empty($params)) {
-          $sql = "SELECT * FROM ".$tableName;
-          foreach ($params as $key => $val) {
-              $sql .= " WHERE `$key` = '$val'";
-          }
-          $statement = $dbConn->prepare($sql);
-          $statement->execute();
-          $returnedRowNumbers = $statement->rowCount();
+	  if (is_null($dbConn)) {
+		  $dbConn = $this->dbConnection;
+	  }
+	  if (is_array($params) && !empty($params)) {
+		  $sql = "SELECT * FROM ".$tableName;
+		  foreach ($params as $key => $val) {
+			  $sql .= " WHERE `$key` = '$val'";
+		  }
+		  $statement = $dbConn->prepare($sql);
+		  $statement->execute();
+		  $returnedRowNumbers = $statement->rowCount();
           
-          return $returnedRowNumbers  ? true : false;
-      }
-      throw EmptyArrayException::checkEmptyArrayException("Array Expected: parameter passed to this function is not an array");
+		  return $returnedRowNumbers  ? true : false;
+	  }
+	  throw EmptyArrayException::checkEmptyArrayException("Array Expected: parameter passed to this function is not an array");
   }
   
   /**
@@ -227,22 +227,22 @@ 
    * @return array
    */
  public function getColumnNames($table, $dbConn = Null) {
-     $tableFields = [];
+	 $tableFields = [];
      
-     if (is_null($dbConn)) {
-         $dbConn = $this->dbConnection;
-     }
-     $sql = "SHOW COLUMNS FROM ".$table;
+	 if (is_null($dbConn)) {
+		 $dbConn = $this->dbConnection;
+	 }
+	 $sql = "SHOW COLUMNS FROM ".$table;
      
-     $stmt = $dbConn->prepare($sql);
-     $stmt->bindValue(':table', $table, PDO::PARAM_STR);
-     $stmt->execute();
-     $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
+	 $stmt = $dbConn->prepare($sql);
+	 $stmt->bindValue(':table', $table, PDO::PARAM_STR);
+	 $stmt->execute();
+	 $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
      
-     foreach($results as $result) {
-         array_push($tableFields, $result['Field']);
-     }
-     return $tableFields;
+	 foreach($results as $result) {
+		 array_push($tableFields, $result['Field']);
+	 }
+	 return $tableFields;
  }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -42,9 +42,9 @@ 
      */
     public function create($associative1DArray, $tableName, $dbConn = Null) {
     	$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
-    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields, $associative1DArray);
     	if (count($unexpectedFields) > 0) {
-    	    throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields,"needs to be created as table field");
+    	    throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
     	}
       unset($associative1DArray[0]);
     	if (is_null($dbConn)) {
@@ -55,13 +55,13 @@ 
     
     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))."'";
     	}
     	$splittedTableValues = implode(',', $FormValues);
-    	$insertQuery.= ' ('.$TableValues.')';
-    	$insertQuery.= ' VALUES ('.$splittedTableValues.')';
+    	$insertQuery .= ' ('.$TableValues.')';
+    	$insertQuery .= ' VALUES ('.$splittedTableValues.')';
     	$executeQuery = $dbConn->exec($insertQuery);
 
       if ($executeQuery) {
@@ -85,12 +85,12 @@ 
     	}
     	$updateSql = "UPDATE `$tableName` SET ";
     	unset($associative1DArray['id']);
-    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
+    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection), $associative1DArray);
   
     	if (count($unexpectedFields) > 0) {
     		throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
     	}
-    	foreach($associative1DArray as $field => $value) {
+    	foreach ($associative1DArray as $field => $value) {
     	    $sql .= "`$field` = '$value'".",";
     	}
     	
@@ -123,7 +123,7 @@ 
    	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;
    	
    	try {
    	    $stmt = $dbConn->prepare($sql);
@@ -135,7 +135,7 @@ 
    	}
    	$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
    	
-   	foreach($results as $result) {
+   	foreach ($results as $result) {
    	    array_push($tableData, $result);
    	}
    	return $tableData;
@@ -174,7 +174,7 @@ 
   {
       $unexpectedFields = [];
       foreach ($userSetterArray as $key => $val) {
-          if (!in_array($key,$tableColumn)) {
+          if (!in_array($key, $tableColumn)) {
               $unexpectedFields[] = $key;
           }
       }
@@ -188,9 +188,9 @@ 
    */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(",",$sql);
+      $splittedQuery = explode(",", $sql);
       array_pop($splittedQuery);
-      $mergeData = implode(",",$splittedQuery);
+      $mergeData = implode(",", $splittedQuery);
       return $mergeData;
   }
   
@@ -215,7 +215,7 @@ 
           $statement->execute();
           $returnedRowNumbers = $statement->rowCount();
           
-          return $returnedRowNumbers  ? true : false;
+          return $returnedRowNumbers ? true : false;
       }
       throw EmptyArrayException::checkEmptyArrayException("Array Expected: parameter passed to this function is not an array");
   }
@@ -239,7 +239,7 @@ 
      $stmt->execute();
      $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
      
-     foreach($results as $result) {
+     foreach ($results as $result) {
          array_push($tableFields, $result['Field']);
      }
      return $tableFields;

src/Exceptions/TableFieldUndefinedException.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	public static function reportUnknownTableField($unExpectedFields, $message)
 	{
-		$fields = implode(", ",$unExpectedFields);
+		$fields = implode(", ", $unExpectedFields);
 
 		//var_dump($fields);
 

src/Exceptions/NoRecordDeletionException.php

Indentation +4 added lines, -4 removed lines

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