andela-tolotin / Potato-ORM

src/Database/DatabaseHandler.php

Doc Comments +12 added lines, -3 removed lines

@@ -22,6 +22,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)
 	{
@@ -36,7 +37,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)
 	{
@@ -79,6 +81,10 @@ 
 	 * @params: $updateParams, $tableName, $associative1DArray
 	 * @return boolean true or false
 	 */
+
+	/**
+	 * @param string|false $tableName
+	 */
 	public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
 	{
 		$sql = "";
@@ -112,6 +118,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)
@@ -143,6 +150,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)
@@ -177,7 +185,7 @@ 
 
 	/**
 	 * This method returns sql query
-	 * @param $sql
+	 * @param string $sql
 	 * @return string
 	 */
 	public function prepareUpdateQuery($sql)
@@ -192,7 +200,7 @@ 
 	/**
 	 * @param array $params
 	 * @param $tableName
-	 * @param $dbConn
+	 * @param DatabaseConnection $dbConn
 	 * @return bool
 	 * @throws EmptyArrayException
 	 */
@@ -219,6 +227,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) {

Spacing +17 added lines, -17 removed lines

@@ -40,10 +40,10 @@ 
 	 */
 	public function create($associative1DArray, $tableName, $dbConn = Null)
 	{
-		$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");
+			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
 		}
 		if ($this->findAndWhere(['alias' => $associative1DArray['alias']], $this->model, $this->dbConnection)) {
 			throw NoRecordInsertionException::checkNoRecordAddedException("Insertion Error: Record already exist");
@@ -61,17 +61,17 @@ 
 	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;
 	}
 
 	/*
@@ -88,13 +88,13 @@ 
 
 		$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'".",";
 		}
 
@@ -106,7 +106,7 @@ 
 		$stmt = $dbConn->prepare($updateSql);
 		$boolResponse = $stmt->execute();
 
-		return $boolResponse ?  : false;
+		return $boolResponse ?: false;
 	}
 
 	/**
@@ -121,7 +121,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);
@@ -133,7 +133,7 @@ 
 		}
 		$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-		foreach($results as $result) {
+		foreach ($results as $result) {
 			array_push($tableData, $result);
 		}
 
@@ -153,7 +153,7 @@ 
 		$sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
 		$boolResponse = $dbConn->exec($sql);
 
-		return $boolResponse ? : false;
+		return $boolResponse ?: false;
 	}
 
 	/**
@@ -167,7 +167,7 @@ 
 		$unexpectedFields = [];
 
 		foreach ($userSetterArray as $key => $val) {
-			if (!in_array($key,$tableColumn)) {
+			if (!in_array($key, $tableColumn)) {
 
 				$unexpectedFields[] = $key;
 			}
@@ -182,9 +182,9 @@ 
 	 */
 	public function prepareUpdateQuery($sql)
 	{
-		$splittedQuery = explode(",",$sql);
+		$splittedQuery = explode(",", $sql);
 		array_pop($splittedQuery);
-		$mergeData = implode(",",$splittedQuery);
+		$mergeData = implode(",", $splittedQuery);
 
 		return $mergeData;
 	}
@@ -209,7 +209,7 @@ 
 			$statement = $dbConn->prepare($sql);
 			$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");
@@ -235,7 +235,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/NoRecordDeletionException.php

Indentation +4 added lines, -4 removed lines

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