Database::prepareAndFetchAll() - Code Metrics - Inspection of "Add ManyToMany conditionParser" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bc25d3...0f9eb9 )

by Jean-Christophe

created 2018-06-15 22:39 UTC

Database::prepareAndFetchAll() A

↳ Parent: Database

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	8
nc	2
nop	2

<?php

namespace Ubiquity\db;

use Ubiquity\cache\database\DbCache;
use Ubiquity\exceptions\CacheException;
use Ubiquity\log\Logger;

/**
 * PDO Database class
 *
 * @author jc
 * @version 1.0.0.3
 * @package db
 *
 */
class Database {
	private $dbType;
	private $serverName;
	private $port;
	private $dbName;
	private $user;
	private $password;
	private $pdoObject;
	private $statements = [ ];
	private $cache;
	private $options;

	/**
	 * Constructor
	 *
	 * @param string $dbName
	 * @param string $serverName
	 * @param string $port
	 * @param string $user
	 * @param string $password
	 * @param array $options
	 * @param boolean|string $cache
	 */
	public function __construct($dbType, $dbName, $serverName = "localhost", $port = "3306", $user = "root", $password = "", $options = [], $cache = false) {
		$this->dbType = $dbType;
		$this->dbName = $dbName;
		$this->serverName = $serverName;
		$this->port = $port;
		$this->user = $user;
		$this->password = $password;
		if (isset ( $options ["quote"] ))
			SqlUtils::$quote = $options ["quote"];
		$this->options = $options;
		if ($cache !== false) {
			if (\is_callable ( $cache )) {
				$this->cache = $cache ();
			} else {
				if (\class_exists ( $cache )) {
					$this->cache = new $cache ();
				} else {
					throw new CacheException ( $cache . " is not a valid value for database cache" );
				}
			}
		}
	}

	/**
	 * Creates the PDO instance and realize a safe connection
	 * @return boolean true if connection is established
	 */
	public function connect() {
		try{
			$this->_connect();
			return true;
		}catch (\PDOException $e){
			return false;
		}
	}
	
	public function _connect(){
		$this->options[\PDO::ATTR_ERRMODE]=\PDO::ERRMODE_EXCEPTION;
		$this->pdoObject = new \PDO ( $this->getDSN(), $this->user, $this->password, $this->options );
	}
	
	public function getDSN(){
		return $this->dbType . ':dbname=' . $this->dbName . ';host=' . $this->serverName . ';charset=UTF8;port=' . $this->port;
	}

	/**
	 * Executes an SQL statement, returning a result set as a PDOStatement object
	 *
	 * @param string $sql
	 * @return \PDOStatement
	 */
	public function query($sql) {
		return $this->pdoObject->query ( $sql );
	}

	/**
	 *
	 * @param string $tableName
	 * @param string $condition
	 * @param array|string $fields
	 * @param array $parameters
	 * @param boolean|null $useCache
	 * @return array
	 */
	public function prepareAndExecute($tableName, $condition, $fields, $parameters=null,$useCache = NULL) {
		$cache = (DbCache::$active && $useCache !== false) || (! DbCache::$active && $useCache === true);
		$result = false;
		if ($cache) {
			$result = $this->cache->fetch ( $tableName, $condition );
		}
		if ($result === false) {
			$fields = SqlUtils::getFieldList ( $fields, $tableName );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$result=$this->prepareAndFetchAll("SELECT {$fields} FROM " . $tableName . $condition,$parameters);
			if ($cache) {
				$this->cache->store ( $tableName, $condition, $result );
			}
		}
		return $result;
	}
	
	public function prepareAndFetchAll($sql,$parameters=null){
		$result=false;
		$statement=$this->getStatement($sql);
		if($statement->execute ($parameters)){
			Logger::info("Database", $sql,"prepareAndFetchAll");
			$result = $statement->fetchAll ();
		}
		$statement->closeCursor ();
		return $result;
	}

	/**
	 *
	 * @param string $sql
	 * @return \PDOStatement
	 */
	private function getStatement($sql) {
		if (! isset ( $this->statements [$sql] )) {
			$this->statements [$sql] = $this->pdoObject->prepare ( $sql );
			$this->statements [$sql]->setFetchMode ( \PDO::FETCH_ASSOC );
		}
		return $this->statements [$sql];
	}

	/**
	 * Execute an SQL statement and return the number of affected rows (INSERT, UPDATE or DELETE)
	 *
	 * @param string $sql
	 * @return int the number of rows that were modified or deleted by the SQL statement you issued
	 */
	public function execute($sql) {
		return $this->pdoObject->exec ( $sql );
	}

	public function getServerName() {
		return $this->serverName;
	}

	public function setServerName($serverName) {
		$this->serverName = $serverName;
	}

	/**
	 * Prepares a statement for execution and returns a statement object
	 *
	 * @param String $sql
	 * @return \PDOStatement
	 */
	public function prepareStatement($sql) {
		return $this->pdoObject->prepare ( $sql );
	}

	/**
	 * Sets $value to $parameter
	 *
	 * @param \PDOStatement $statement
	 * @param String $parameter
	 * @param mixed $value
	 * @return boolean
	 */
	public function bindValueFromStatement(\PDOStatement $statement, $parameter, $value) {
		return $statement->bindValue ( ":" . $parameter, $value );
	}

	/**
	 * Returns the last insert id
	 *
	 * @return integer
	 */
	public function lastInserId() {
		return $this->pdoObject->lastInsertId ();
	}

	public function getTablesName() {
		$sql = 'SHOW TABLES';
		$query = $this->pdoObject->query ( $sql );
		return $query->fetchAll ( \PDO::FETCH_COLUMN );
	}

	/**
	 * Returns the number of records in $tableName that respects the condition passed as a parameter
	 *
	 * @param string $tableName
	 * @param string $condition
	 *        	Partie suivant le WHERE d'une instruction SQL
	 */
	public function count($tableName, $condition = '') {
		if ($condition != '')
			$condition = " WHERE " . $condition;
		return $this->query ( "SELECT COUNT(*) FROM " . $tableName . $condition )->fetchColumn ();
	}
	
	public function queryColumn($query){
		return $this->query ( $query )->fetchColumn ();
	}
	
	public function fetchAll($query){
		return $this->query ( $query )->fetchAll ( \PDO::FETCH_COLUMN );
	}
	
	public function isConnected() {
		return ($this->pdoObject !== null && $this->pdoObject instanceof \PDO && $this->ping());
	}

	public function setDbType($dbType) {
		$this->dbType = $dbType;
		return $this;
	}
	
	public function ping() {
		return (1 === intval($this->pdoObject->query('SELECT 1')->fetchColumn(0)));
	}

	public function getPort() {
		return $this->port;
	}

	public function getDbName() {
		return $this->dbName;
	}

	public function getUser() {
		return $this->user;
	}

	public function getPdoObject() {
		return $this->pdoObject;
	}
	
	public static function getAvailableDrivers(){
		return \PDO::getAvailableDrivers();
	}
}


1			<?php
2
3			namespace Ubiquity\db;
4
5			use Ubiquity\cache\database\DbCache;
6			use Ubiquity\exceptions\CacheException;
7			use Ubiquity\log\Logger;
8
9			/**
10			* PDO Database class
11			*
12			* @author jc
13			* @version 1.0.0.3
14			* @package db
15			*
16			*/
17			class Database {
18			private $dbType;
19			private $serverName;
20			private $port;
21			private $dbName;
22			private $user;
23			private $password;
24			private $pdoObject;
25			private $statements = [ ];
26			private $cache;
27			private $options;
28
29			/**
30			* Constructor
31			*
32			* @param string $dbName
33			* @param string $serverName
34			* @param string $port
35			* @param string $user
36			* @param string $password
37			* @param array $options
38			* @param boolean\|string $cache
39			*/
40			public function __construct($dbType, $dbName, $serverName = "localhost", $port = "3306", $user = "root", $password = "", $options = [], $cache = false) {
41			$this->dbType = $dbType;
42			$this->dbName = $dbName;
43			$this->serverName = $serverName;
44			$this->port = $port;
45			$this->user = $user;
46			$this->password = $password;
47			if (isset ( $options ["quote"] ))
48			SqlUtils::$quote = $options ["quote"];
49			$this->options = $options;
50			if ($cache !== false) {
51			if (\is_callable ( $cache )) {
52			$this->cache = $cache ();
53			} else {
54			if (\class_exists ( $cache )) {
55			$this->cache = new $cache ();
56			} else {
57			throw new CacheException ( $cache . " is not a valid value for database cache" );
58			}
59			}
60			}
61			}
62
63			/**
64			* Creates the PDO instance and realize a safe connection
65			* @return boolean true if connection is established
66			*/
67			public function connect() {
68			try{
69			$this->_connect();
70			return true;
71			}catch (\PDOException $e){
72			return false;
73			}
74			}
75
76			public function _connect(){
77			$this->options[\PDO::ATTR_ERRMODE]=\PDO::ERRMODE_EXCEPTION;
78			$this->pdoObject = new \PDO ( $this->getDSN(), $this->user, $this->password, $this->options );
79			}
80
81			public function getDSN(){
82			return $this->dbType . ':dbname=' . $this->dbName . ';host=' . $this->serverName . ';charset=UTF8;port=' . $this->port;
83			}
84
85			/**
86			* Executes an SQL statement, returning a result set as a PDOStatement object
87			*
88			* @param string $sql
89			* @return \PDOStatement
90			*/
91			public function query($sql) {
92			return $this->pdoObject->query ( $sql );
93			}
94
95			/**
96			*
97			* @param string $tableName
98			* @param string $condition
99			* @param array\|string $fields
100			* @param array $parameters
101			* @param boolean\|null $useCache
102			* @return array
103			*/
104			public function prepareAndExecute($tableName, $condition, $fields, $parameters=null,$useCache = NULL) {
105			$cache = (DbCache::$active && $useCache !== false) \|\| (! DbCache::$active && $useCache === true);
106			$result = false;
107			if ($cache) {
108			$result = $this->cache->fetch ( $tableName, $condition );
109			}
110			if ($result === false) {
111			$fields = SqlUtils::getFieldList ( $fields, $tableName );
			0 ignored issues – show Documentation introduced 2018-03-12 19:37 UTC by Report Bug Copy Issue Report `$tableName` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112			$result=$this->prepareAndFetchAll("SELECT {$fields} FROM " . $tableName . $condition,$parameters);
113			if ($cache) {
114			$this->cache->store ( $tableName, $condition, $result );
115			}
116			}
117			return $result;
118			}
119
120			public function prepareAndFetchAll($sql,$parameters=null){
121			$result=false;
122			$statement=$this->getStatement($sql);
123			if($statement->execute ($parameters)){
124			Logger::info("Database", $sql,"prepareAndFetchAll");
125			$result = $statement->fetchAll ();
126			}
127			$statement->closeCursor ();
128			return $result;
129			}
130
131			/**
132			*
133			* @param string $sql
134			* @return \PDOStatement
135			*/
136			private function getStatement($sql) {
137			if (! isset ( $this->statements [$sql] )) {
138			$this->statements [$sql] = $this->pdoObject->prepare ( $sql );
139			$this->statements [$sql]->setFetchMode ( \PDO::FETCH_ASSOC );
140			}
141			return $this->statements [$sql];
142			}
143
144			/**
145			* Execute an SQL statement and return the number of affected rows (INSERT, UPDATE or DELETE)
146			*
147			* @param string $sql
148			* @return int the number of rows that were modified or deleted by the SQL statement you issued
149			*/
150			public function execute($sql) {
151			return $this->pdoObject->exec ( $sql );
152			}
153
154			public function getServerName() {
155			return $this->serverName;
156			}
157
158			public function setServerName($serverName) {
159			$this->serverName = $serverName;
160			}
161
162			/**
163			* Prepares a statement for execution and returns a statement object
164			*
165			* @param String $sql
166			* @return \PDOStatement
167			*/
168			public function prepareStatement($sql) {
169			return $this->pdoObject->prepare ( $sql );
170			}
171
172			/**
173			* Sets $value to $parameter
174			*
175			* @param \PDOStatement $statement
176			* @param String $parameter
177			* @param mixed $value
178			* @return boolean
179			*/
180			public function bindValueFromStatement(\PDOStatement $statement, $parameter, $value) {
181			return $statement->bindValue ( ":" . $parameter, $value );
182			}
183
184			/**
185			* Returns the last insert id
186			*
187			* @return integer
188			*/
189			public function lastInserId() {
190			return $this->pdoObject->lastInsertId ();
191			}
192
193			public function getTablesName() {
194			$sql = 'SHOW TABLES';
195			$query = $this->pdoObject->query ( $sql );
196			return $query->fetchAll ( \PDO::FETCH_COLUMN );
197			}
198
199			/**
200			* Returns the number of records in $tableName that respects the condition passed as a parameter
201			*
202			* @param string $tableName
203			* @param string $condition
204			* Partie suivant le WHERE d'une instruction SQL
205			*/
206			public function count($tableName, $condition = '') {
207			if ($condition != '')
208			$condition = " WHERE " . $condition;
209			return $this->query ( "SELECT COUNT(*) FROM " . $tableName . $condition )->fetchColumn ();
210			}
211
212			public function queryColumn($query){
213			return $this->query ( $query )->fetchColumn ();
214			}
215
216			public function fetchAll($query){
217			return $this->query ( $query )->fetchAll ( \PDO::FETCH_COLUMN );
218			}
219
220			public function isConnected() {
221			return ($this->pdoObject !== null && $this->pdoObject instanceof \PDO && $this->ping());
222			}
223
224			public function setDbType($dbType) {
225			$this->dbType = $dbType;
226			return $this;
227			}
228
229			public function ping() {
230			return (1 === intval($this->pdoObject->query('SELECT 1')->fetchColumn(0)));
231			}
232
233			public function getPort() {
234			return $this->port;
235			}
236
237			public function getDbName() {
238			return $this->dbName;
239			}
240
241			public function getUser() {
242			return $this->user;
243			}
244
245			public function getPdoObject() {
246			return $this->pdoObject;
247			}
248
249			public static function getAvailableDrivers(){
250			return \PDO::getAvailableDrivers();
251			}
252			}
253

phpMv / ubiquity

Push — master ( bc25d3...0f9eb9 )

Database::prepareAndFetchAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like