andela-tolotin / Potato-ORM

src/Database/DatabaseHandler.php

Doc Comments +11 added lines, -2 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,7 +36,8 @@ 
     /**
       * This method create a record and store it in a table row
       * @params associative array, string tablename
-      * @return boolean true or false
+      * @param string|false $tableName
+      * @return boolean|null true or false
       */
     public function create($associative1DArray, $tableName, $dbConn = Null)
     {
@@ -72,6 +74,10 @@ 
      * @params: $updateParams, $tableName, $associative1DArray
      * @return boolean true or false
      */
+
+    /**
+     * @param string|false $tableName
+     */
     public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
     {
     	$sql = "";
@@ -102,6 +108,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)
@@ -132,6 +139,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)
@@ -164,7 +172,7 @@ 
   
   /**
     * This method returns sql query
-    * @param $sql
+    * @param string $sql
     * @return string
     */
   public function prepareUpdateQuery($sql)
@@ -206,6 +214,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) {

Indentation +149 added lines, -149 removed lines

@@ -14,217 +14,217 @@
 use Laztopaz\potatoORM\EmptyArrayException;
 
 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);
+	/**
+	 * 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::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
-    	}
-    	unset($tableFields[0]);
-    	if (is_null($dbConn)) {
-    	    $dbConn = $this->dbConnection;
-    	}
-    	$this->insertRecord($dbConn, $tableName, $associative1DArray);
-    }
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
+		}
+		unset($tableFields[0]);
+		if (is_null($dbConn)) {
+			$dbConn = $this->dbConnection;
+		}
+		$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);
-    	return $executeQuery ? : false;
+	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);
+		return $executeQuery ? : false;
     	
 	}
 
-    /*
+	/*
      * 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);
+	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::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
-    	}
-    	foreach($associative1DArray as $field => $value) {
-    	    $sql .= "`$field` = '$value'".",";
-    	}
+		if (count($unexpectedFields) > 0) {
+			throw TableFieldUndefinedException::fieldsNotDefinedException($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);
-    	$boolResponse = $stmt->execute();
-    	return $boolResponse ?  : false;
-    }
+		foreach ($updateParams as $key => $val) {
+			$updateSql .= " WHERE $key = $val";
+		}
+		$stmt = $dbConn->prepare($updateSql);
+		$boolResponse = $stmt->execute();
+		return $boolResponse ?  : false;
+	}
     
   /**
-    * This method retrieves record from a table
-    * @params int id, string tableName
-    * @return array
-    */
+   * This method retrieves record from a table
+   * @params int id, string tableName
+   * @return array
+   */
    public static function read($id, $tableName, $dbConn = Null)
    {
    	$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;
    }
    
    /**
-     * This method deletes a record  from a table row
-     * @params int id, string tableName
-     * @return boolean true or false
-     */
+    * This method deletes a record  from a table row
+    * @params int id, string tableName
+    * @return boolean true or false
+    */
   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;
-      $boolResponse = $dbConn->exec($sql);
-      return $boolResponse ? : false;
+	  $sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
+	  $boolResponse = $dbConn->exec($sql);
+	  return $boolResponse ? : false;
   }
   
   /**
-    * This method checks if the magic setters array is the same as the table columns
-    * @param array $tableColumn
-    * @param array $userSetterArray
-    * @return array $unexpectedFields
-    */
+   * This method checks if the magic setters array is the same as the table columns
+   * @param array $tableColumn
+   * @param array $userSetterArray
+   * @return array $unexpectedFields
+   */
   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;
   }
   
   /**
-    * This method returns sql query
-    * @param $sql
-    * @return string
-    */
+   * This method returns sql query
+   * @param $sql
+   * @return string
+   */
   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;
   }
   
   /**
-    * @param array $params
-    * @param $tableName
-    * @param $dbConn
-    * @return bool
-    * @throws EmptyArrayException
-    */
+   * @param array $params
+   * @param $tableName
+   * @param $dbConn
+   * @return bool
+   * @throws EmptyArrayException
+   */
   public function findAndWhere($params, $tableName, $dbConn)
   {
-      if (is_null($dbConn)) {
-          $dbConn = $this->dbConnection;
-      }
-      if (is_array($params) && !empty($params)) {
-          $sql = "SELECT * FROM ".$tableName;
+	  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();
+		  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");
   }
   
   /**
-    * This method returns column fields of a particular table
-    * @param $table
-    * @param $conn
-    * @return array
-    */
+   * This method returns column fields of a particular table
+   * @param $table
+   * @param $conn
+   * @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 +17 added lines, -17 removed lines

@@ -41,9 +41,9 @@ 
     {
     	$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
     	
-    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields, $associative1DArray);
     	if (count($unexpectedFields) > 0) {
-    	    throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
+    	    throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
     	}
     	unset($tableFields[0]);
     	if (is_null($dbConn)) {
@@ -55,15 +55,15 @@ 
     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);
-    	return $executeQuery ? : false;
+    	return $executeQuery ?: false;
     	
 	}
 
@@ -80,12 +80,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::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
     	}
-    	foreach($associative1DArray as $field => $value) {
+    	foreach ($associative1DArray as $field => $value) {
     	    $sql .= "`$field` = '$value'".",";
     	}
     	
@@ -96,7 +96,7 @@ 
     	}
     	$stmt = $dbConn->prepare($updateSql);
     	$boolResponse = $stmt->execute();
-    	return $boolResponse ?  : false;
+    	return $boolResponse ?: false;
     }
     
   /**
@@ -111,7 +111,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);
@@ -123,7 +123,7 @@ 
    	}
    	$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
    	
-   	foreach($results as $result) {
+   	foreach ($results as $result) {
    	    array_push($tableData, $result);
    	}
    	return $tableData;
@@ -142,7 +142,7 @@ 
       
       $sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
       $boolResponse = $dbConn->exec($sql);
-      return $boolResponse ? : false;
+      return $boolResponse ?: false;
   }
   
   /**
@@ -155,7 +155,7 @@ 
   {
       $unexpectedFields = [];
       foreach ($userSetterArray as $key => $val) {
-          if (!in_array($key,$tableColumn)) {
+          if (!in_array($key, $tableColumn)) {
               $unexpectedFields[] = $key;
           }
       }
@@ -169,9 +169,9 @@ 
     */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(",",$sql);
+      $splittedQuery = explode(",", $sql);
       array_pop($splittedQuery);
-      $mergeData = implode(",",$splittedQuery);
+      $mergeData = implode(",", $splittedQuery);
       return $mergeData;
   }
   
@@ -197,7 +197,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");
   }
@@ -221,7 +221,7 @@ 
      $stmt->execute();
      $results = $stmt->fetchAll(PDO::FETCH_ASSOC);
      
-     foreach($results as $result) {
+     foreach ($results as $result) {
          array_push($tableFields, $result['Field']);
      }
      return $tableFields;