Database::ping() - Code Metrics - Inspection of "Add config checking" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eb0184...954492 )

by Jean-Christophe

created 2018-04-15 15:38 UTC

Database::ping() A

↳ Parent: Database

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Ubiquity\db;

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

/**
 * 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
	 */
	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 boolean|null $useCache
	 * @return array
	 */
	public function prepareAndExecute($tableName, $condition, $fields, $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);
			$statement = $this->getStatement ( "SELECT {$fields} FROM " . $tableName . $condition );
			$statement->execute ();
			$result = $statement->fetchAll ();
			$statement->closeCursor ();
			if ($cache) {
				$this->cache->store ( $tableName, $condition, $result );
			}
		}
		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 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
8			/**
9			* PDO Database class
10			*
11			* @author jc
12			* @version 1.0.0.3
13			* @package db
14			*
15			*/
16			class Database {
17			private $dbType;
18			private $serverName;
19			private $port;
20			private $dbName;
21			private $user;
22			private $password;
23			private $pdoObject;
24			private $statements = [ ];
25			private $cache;
26			private $options;
27
28			/**
29			* Constructor
30			*
31			* @param string $dbName
32			* @param string $serverName
33			* @param string $port
34			* @param string $user
35			* @param string $password
36			* @param array $options
37			* @param boolean\|string $cache
38			*/
39			public function __construct($dbType, $dbName, $serverName = "localhost", $port = "3306", $user = "root", $password = "", $options = [], $cache = false) {
40			$this->dbType = $dbType;
41			$this->dbName = $dbName;
42			$this->serverName = $serverName;
43			$this->port = $port;
44			$this->user = $user;
45			$this->password = $password;
46			if (isset ( $options ["quote"] ))
47			SqlUtils::$quote = $options ["quote"];
48			$this->options = $options;
49			if ($cache !== false) {
50			if (\is_callable ( $cache )) {
51			$this->cache = $cache ();
52			} else {
53			if (\class_exists ( $cache )) {
54			$this->cache = new $cache ();
55			} else {
56			throw new CacheException ( $cache . " is not a valid value for database cache" );
57			}
58			}
59			}
60			}
61
62			/**
63			* Creates the PDO instance
64			*/
65			public function connect() {
66			$this->options[\PDO::ATTR_ERRMODE]=\PDO::ERRMODE_EXCEPTION;
67			$this->pdoObject = new \PDO ( $this->getDSN(), $this->user, $this->password, $this->options );
68			}
69
70			public function getDSN(){
71			return $this->dbType . ':dbname=' . $this->dbName . ';host=' . $this->serverName . ';charset=UTF8;port=' . $this->port;
72			}
73
74			/**
75			* Executes an SQL statement, returning a result set as a PDOStatement object
76			*
77			* @param string $sql
78			* @return \PDOStatement
79			*/
80			public function query($sql) {
81			return $this->pdoObject->query ( $sql );
82			}
83
84			/**
85			*
86			* @param string $tableName
87			* @param string $condition
88			* @param array\|string $fields
89			* @param boolean\|null $useCache
90			* @return array
91			*/
92			public function prepareAndExecute($tableName, $condition, $fields, $useCache = NULL) {
93			$cache = (DbCache::$active && $useCache !== false) \|\| (! DbCache::$active && $useCache === true);
94			$result = false;
95			if ($cache) {
96			$result = $this->cache->fetch ( $tableName, $condition );
97			}
98			if ($result === false) {
99			$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...
100			$statement = $this->getStatement ( "SELECT {$fields} FROM " . $tableName . $condition );
101			$statement->execute ();
102			$result = $statement->fetchAll ();
103			$statement->closeCursor ();
104			if ($cache) {
105			$this->cache->store ( $tableName, $condition, $result );
106			}
107			}
108			return $result;
109			}
110
111			/**
112			*
113			* @param string $sql
114			* @return \PDOStatement
115			*/
116			private function getStatement($sql) {
117			if (! isset ( $this->statements [$sql] )) {
118			$this->statements [$sql] = $this->pdoObject->prepare ( $sql );
119			$this->statements [$sql]->setFetchMode ( \PDO::FETCH_ASSOC );
120			}
121			return $this->statements [$sql];
122			}
123
124			/**
125			* Execute an SQL statement and return the number of affected rows (INSERT, UPDATE or DELETE)
126			*
127			* @param string $sql
128			* @return int the number of rows that were modified or deleted by the SQL statement you issued
129			*/
130			public function execute($sql) {
131			return $this->pdoObject->exec ( $sql );
132			}
133
134			public function getServerName() {
135			return $this->serverName;
136			}
137
138			public function setServerName($serverName) {
139			$this->serverName = $serverName;
140			}
141
142			/**
143			* Prepares a statement for execution and returns a statement object
144			*
145			* @param String $sql
146			* @return \PDOStatement
147			*/
148			public function prepareStatement($sql) {
149			return $this->pdoObject->prepare ( $sql );
150			}
151
152			/**
153			* Sets $value to $parameter
154			*
155			* @param \PDOStatement $statement
156			* @param String $parameter
157			* @param mixed $value
158			* @return boolean
159			*/
160			public function bindValueFromStatement(\PDOStatement $statement, $parameter, $value) {
161			return $statement->bindValue ( ":" . $parameter, $value );
162			}
163
164			/**
165			* Returns the last insert id
166			*
167			* @return integer
168			*/
169			public function lastInserId() {
170			return $this->pdoObject->lastInsertId ();
171			}
172
173			public function getTablesName() {
174			$sql = 'SHOW TABLES';
175			$query = $this->pdoObject->query ( $sql );
176			return $query->fetchAll ( \PDO::FETCH_COLUMN );
177			}
178
179			/**
180			* Returns the number of records in $tableName that respects the condition passed as a parameter
181			*
182			* @param string $tableName
183			* @param string $condition
184			* Partie suivant le WHERE d'une instruction SQL
185			*/
186			public function count($tableName, $condition = '') {
187			if ($condition != '')
188			$condition = " WHERE " . $condition;
189			return $this->query ( "SELECT COUNT(*) FROM " . $tableName . $condition )->fetchColumn ();
190			}
191
192			public function isConnected() {
193			return ($this->pdoObject !== null && $this->pdoObject instanceof \PDO && $this->ping());
194			}
195
196			public function setDbType($dbType) {
197			$this->dbType = $dbType;
198			return $this;
199			}
200
201			public function ping() {
202			return (1 === intval($this->pdoObject->query('SELECT 1')->fetchColumn(0)));
203			}
204
205			public function getPort() {
206			return $this->port;
207			}
208
209			public function getDbName() {
210			return $this->dbName;
211			}
212
213			public function getUser() {
214			return $this->user;
215			}
216
217			public function getPdoObject() {
218			return $this->pdoObject;
219			}
220
221			public static function getAvailableDrivers(){
222			return \PDO::getAvailableDrivers();
223			}
224			}
225

phpMv / ubiquity

Push — master ( eb0184...954492 )

Database::ping() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like