DatabaseHandler::findAndWhere() - Code Metrics - Inspection of "Adjust line spacing" - andela-tolotin/Potato-ORM - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — test ( 3a08db...090bc9 )

by Temitope

created 2016-02-28 23:00 UTC

DatabaseHandler::findAndWhere() B

↳ Parent: DatabaseHandler

Complexity

Conditions	6
Paths	10

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	2

Metric	Value
c	7
b	0
f	2
dl	0
loc	18
rs	8.8571
cc	6
eloc	12
nc	10
nop	3

<?php

/**
 * @package  Laztopaz\potato-ORM
 * @author   Temitope Olotin <[email protected]>
 * @license  <https://opensource.org/license/MIT> MIT
 */

namespace Laztopaz\potatoORM;

use PDO;
use Laztopaz\potatoORM\DatabaseHelper;
use Laztopaz\potatoORM\TableFieldUndefinedException;
use Laztopaz\potatoORM\EmptyArrayException;

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 boolean true or false
	 */
	public function create($associative1DArray, $tableName, $dbConn = Null)
	{
		$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");
		}
//		if ($this->findAndWhere(['alias' => $associative1DArray['alias']], $this->model, $this->dbConnection)) {

//			throw NoRecordInsertionException::checkNoRecordAddedException("Insertion Error: Record already exist");
//		}
		unset($this->getColumnNames($this->model, $this->dbConnection)[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))."'";
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		}
		$splittedTableValues = implode(',', $FormValues);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		$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);

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

		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
	 */
	public static function read($id, $tableName, $dbConn = Null)
	{
		$tableData = [];

		if (is_null($dbConn)) {
			$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();
		} catch (PDOException $e) {

			return  $e->getMessage();
		}
		$results = $stmt->fetchAll(PDO::FETCH_ASSOC);

		foreach($results as $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
	 */
	public static function delete($id, $tableName, $dbConn = Null)
	{
		if (is_null($dbConn)) {
			$dbConn = new DatabaseConnection();
		}
		$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
	 */
	public static function checkIfMagicSetterContainsIsSameAsClassModel(array $tableColumn, array $userSetterArray)
	{
		$unexpectedFields = [];

		foreach ($userSetterArray as $key => $val) {
			if (!in_array($key,$tableColumn)) {

				$unexpectedFields[] = $key;
			}
		}
		return $unexpectedFields;
	}

	/**
	 * This method returns sql query
	 * @param $sql
	 * @return string
	 */
	public function prepareUpdateQuery($sql)
	{
		$splittedQuery = explode(",",$sql);
		array_pop($splittedQuery);
		$mergeData = implode(",",$splittedQuery);

		return $mergeData;
	}

	/**
	 * @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;
			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");
	}

	/**
	 * This method returns column fields of a particular table
	 * @param $table
	 * @param $conn
	 * @return array
	 */
	public function getColumnNames($table, $dbConn = Null) {

		$tableFields = [];

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

		foreach($results as $result) {
			array_push($tableFields, $result['Field']);
		}
			return $tableFields;
		}


}


1			<?php
2
3			/**
4			* @package Laztopaz\potato-ORM
5			* @author Temitope Olotin <[email protected]>
6			* @license <https://opensource.org/license/MIT> MIT
7			*/
8
9			namespace Laztopaz\potatoORM;
10
11			use PDO;
12			use Laztopaz\potatoORM\DatabaseHelper;
13			use Laztopaz\potatoORM\TableFieldUndefinedException;
14			use Laztopaz\potatoORM\EmptyArrayException;
15
16			class DatabaseHandler {
17
18			private $tableFields;
			0 ignored issues – show Unused Code introduced 2016-02-28 17:45 UTC by Report Bug Copy Issue Report The property `$tableFields` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
19			private $dbHelperInstance;
			0 ignored issues – show Unused Code introduced 2016-02-28 17:45 UTC by Report Bug Copy Issue Report The property `$dbHelperInstance` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20			private $dbConnection;
21			private $model;
22
23			/**
24			* This is a constructor; a default method that will be called automatically during class instantiation
25			*/
26			public function __construct($modelClassName, $dbConn = Null)
27			{
28			if (is_null($dbConn)) {
29			$this->dbConnection = new DatabaseConnection();
30			} else {
31			$this->dbConnection = $dbConn;
32			}
33			$this->model = $modelClassName;
34			}
35
36			/**
37			* This method create a record and store it in a table row
38			* @params associative array, string tablename
39			* @return boolean true or false
40			*/
41			public function create($associative1DArray, $tableName, $dbConn = Null)
42			{
43			$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
44
45			if (count($unexpectedFields) > 0) {
46			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
47			}
48			// if ($this->findAndWhere(['alias' => $associative1DArray['alias']], $this->model, $this->dbConnection)) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-28 23:02 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
49			// throw NoRecordInsertionException::checkNoRecordAddedException("Insertion Error: Record already exist");
50			// }
51			unset($this->getColumnNames($this->model, $this->dbConnection)[0]);
52
53			if (is_null($dbConn)) {
54			$dbConn = $this->dbConnection;
55			}
56
57			$this->insertRecord($dbConn, $tableName, $associative1DArray);
58			}
59
60
61			private function insertRecord($dbConn, $tableName, $associative1DArray) {
62
63			$insertQuery = 'INSERT INTO '.$tableName;
64			$TableValues = implode(',',array_keys($associative1DArray));
65			foreach ($associative1DArray as $field => $value) {
66
67			$FormValues[] = "'".trim(addslashes($value))."'";
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-02-26 19:31 UTC by Report Bug Copy Issue Report `$FormValues` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$FormValues = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
68			}
69			$splittedTableValues = implode(',', $FormValues);
			0 ignored issues – show Bug introduced 2016-02-26 19:31 UTC by Report Bug Copy Issue Report The variable `$FormValues` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
70			$insertQuery.= ' ('.$TableValues.')';
71			$insertQuery.= ' VALUES ('.$splittedTableValues.')';
72			$executeQuery = $dbConn->exec($insertQuery);
73
74			return $executeQuery ? : false;
75			}
76
77			/*
78			* This method updates any table by supplying 3 parameter
79			* @params: $updateParams, $tableName, $associative1DArray
80			* @return boolean true or false
81			*/
82			public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
83			{
84			$sql = "";
85			if (is_null($dbConn)) {
86			$dbConn = $this->dbConnection;
87			}
88
89			$updateSql = "UPDATE `$tableName` SET ";
90			unset($associative1DArray['id']);
91			$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
92
93			if (count($unexpectedFields) > 0) {
94			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
95			}
96
97			foreach($associative1DArray as $field => $value) {
98			$sql .= "`$field` = '$value'".",";
99			}
100
101			$updateSql .= $this->prepareUpdateQuery($sql);
102
103			foreach ($updateParams as $key => $val) {
104			$updateSql .= " WHERE $key = $val";
105			}
106			$stmt = $dbConn->prepare($updateSql);
107			$boolResponse = $stmt->execute();
108
109			return $boolResponse ? : false;
110			}
111
112			/**
113			* This method retrieves record from a table
114			* @params int id, string tableName
115			* @return array
116			*/
117			public static function read($id, $tableName, $dbConn = Null)
118			{
119			$tableData = [];
120
121			if (is_null($dbConn)) {
122			$dbConn = new DatabaseConnection();
123			}
124			$sql = $id ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
125
126			try {
127			$stmt = $dbConn->prepare($sql);
128			$stmt->bindValue(':table', $tableName);
129			$stmt->bindValue(':id', $id);
130			$stmt->execute();
131			} catch (PDOException $e) {
			0 ignored issues – show Bug introduced 2016-02-26 19:31 UTC by Report Bug Copy Issue Report The class `Laztopaz\potatoORM\PDOException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
132			return $e->getMessage();
133			}
134			$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
135
136			foreach($results as $result) {
137			array_push($tableData, $result);
138			}
139
140			return $tableData;
141			}
142
143			/**
144			* This method deletes a record from a table row
145			* @params int id, string tableName
146			* @return boolean true or false
147			*/
148			public static function delete($id, $tableName, $dbConn = Null)
149			{
150			if (is_null($dbConn)) {
151			$dbConn = new DatabaseConnection();
152			}
153			$sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
154			$boolResponse = $dbConn->exec($sql);
155
156			return $boolResponse ? : false;
157			}
158
159			/**
160			* This method checks if the magic setters array is the same as the table columns
161			* @param array $tableColumn
162			* @param array $userSetterArray
163			* @return array $unexpectedFields
164			*/
165			public static function checkIfMagicSetterContainsIsSameAsClassModel(array $tableColumn, array $userSetterArray)
166			{
167			$unexpectedFields = [];
168
169			foreach ($userSetterArray as $key => $val) {
170			if (!in_array($key,$tableColumn)) {
171
172			$unexpectedFields[] = $key;
173			}
174			}
175			return $unexpectedFields;
176			}
177
178			/**
179			* This method returns sql query
180			* @param $sql
181			* @return string
182			*/
183			public function prepareUpdateQuery($sql)
184			{
185			$splittedQuery = explode(",",$sql);
186			array_pop($splittedQuery);
187			$mergeData = implode(",",$splittedQuery);
188
189			return $mergeData;
190			}
191
192			/**
193			* @param array $params
194			* @param $tableName
195			* @param $dbConn
196			* @return bool
197			* @throws EmptyArrayException
198			*/
199			public function findAndWhere($params, $tableName, $dbConn)
200			{
201			if (is_null($dbConn)) {
202			$dbConn = $this->dbConnection;
203			}
204			if (is_array($params) && !empty($params)) {
205			$sql = "SELECT * FROM ".$tableName;
206			foreach ($params as $key => $val) {
207			$sql .= " WHERE `$key` = '$val'";
208			}
209			$statement = $dbConn->prepare($sql);
210			$statement->execute();
211			$returnedRowNumbers = $statement->rowCount();
212			return $returnedRowNumbers ? true : false;
213			}
214
215			throw EmptyArrayException::checkEmptyArrayException("Array Expected: parameter passed to this function is not an array");
216			}
217
218			/**
219			* This method returns column fields of a particular table
220			* @param $table
221			* @param $conn
222			* @return array
223			*/
224			public function getColumnNames($table, $dbConn = Null) {
225
226			$tableFields = [];
227
228			if (is_null($dbConn)) {
229			$dbConn = $this->dbConnection;
230			}
231			$sql = "SHOW COLUMNS FROM ".$table;
232
233			$stmt = $dbConn->prepare($sql);
234			$stmt->bindValue(':table', $table, PDO::PARAM_STR);
235			$stmt->execute();
236			$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
237
238			foreach($results as $result) {
239			array_push($tableFields, $result['Field']);
240			}
241			return $tableFields;
242			}
243
244
245			}
246

andela-tolotin / Potato-ORM

Push — test ( 3a08db...090bc9 )

DatabaseHandler::findAndWhere() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like