Db::real_escape() - Code Metrics - Inspection of "removing the createDatabase function and moving th..." - detain/db_abstraction - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( e9c576...010f10 )

by Joe
created 2018-07-24 11:51 UTC
Db::real_escape() A

↳ Parent: Db
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0
<?php
/**
 * PDO SQL Related Functionality
 * @author Joe Huss <[email protected]>
 * @copyright 2018
 * @package MyAdmin
 * @category SQL
 */

namespace MyDb\Pdo;

use \MyDb\Generic;
use \MyDb\Db_Interface;

/**
 * Db
 *
 * @access public
 */
class Db extends Generic implements Db_Interface {
	/* public: connection parameters */
	public $driver = 'mysql';
	public $Rows = [];
	/* public: this is an api revision, not a CVS revision. */
	public $type = 'pdo';

	/**
	 * alias function of select_db, changes the database we are working with.
	 *
	 * @param string $database the name of the database to use
	 * @return void
	 */
	public function useDb($database) {
		$this->selectDb($database);
	}

	/**
	 * changes the database we are working with.
	 *
	 * @param string $database the name of the database to use
	 * @return void
	 */
	public function selectDb($database) {
		$dSN = "{$this->driver}:dbname={$database};host={$this->host}";
		if ($this->characterSet != '')
			$dSN .= ';charset='.$this->characterSet;
		$this->linkId = new \PDO($dSN, $this->user, $this->password);
	}

	/* public: connection management */

	/**
	 * Db::connect()
	 * @param string $database
	 * @param string $host
	 * @param string $user
	 * @param string $password
	 * @param string $driver
	 * @return bool|int|\PDO
	 */
	public function connect($database = '', $host = '', $user = '', $password = '', $driver = 'mysql') {
		/* Handle defaults */
		if ('' == $database)
			$database = $this->database;
		if ('' == $host)
			$host = $this->host;
		if ('' == $user)
			$user = $this->user;
		if ('' == $password)
			$password = $this->password;
		if ('' == $driver)
			$driver = $this->driver;
		/* establish connection, select database */
		$dSN = "$driver:dbname=$database;host=$host";
		if ($this->characterSet != '')
			$dSN .= ';charset='.$this->characterSet;
		if ($this->linkId === false) {

			try {
				$this->linkId = new \PDO($dSN, $user, $password);
			} catch (\PDOException $e) {
				$this->halt('Connection Failed '.$e->getMessage());
				return 0;
			}
		}
		return $this->linkId;
	}

	/* This only affects systems not using persistent connections */

	/**
	 * Db::disconnect()
	 * @return void
	 */
	public function disconnect() {
	}

	/**
	 * @param $string
	 * @return string
	 */
	public function real_escape($string) {
		return escapeshellarg($string);
	}

	/**
	 * @param $string
	 * @return string
	 */
	public function escape($string) {
		return escapeshellarg($string);
	}

	/* public: discard the query result */

	/**
	 * Db::free()
	 * @return void
	 */
	public function free() {
		//			@mysql_free_result($this->queryId);
		//			$this->queryId = 0;
	}

	/**
	 * Db::queryReturn()
	 *
	 * Sends an SQL query to the server like the normal query() command but iterates through
	 * any rows and returns the row or rows immediately or FALSE on error
	 *
	 * @param mixed $query SQL Query to be used
	 * @param string $line optionally pass __LINE__ calling the query for logging
	 * @param string $file optionally pass __FILE__ calling the query for logging
	 * @return mixed FALSE if no rows, if a single row it returns that, if multiple it returns an array of rows, associative responses only
	 */
	public function queryReturn($query, $line = '', $file = '') {
		$this->query($query, $line, $file);
		if ($this->num_rows() == 0) {
			return false;
		} elseif ($this->num_rows() == 1) {
			$this->next_record(MYSQL_ASSOC);
			$this->next_record(/** @scrutinizer ignore-deprecated */ MYSQL_ASSOC);
			return $this->Record;
		} else {
			$out = [];
			while ($this->next_record(MYSQL_ASSOC))
			while ($this->next_record(/** @scrutinizer ignore-deprecated */ MYSQL_ASSOC))
				$out[] = $this->Record;
			return $out;
		}
	}

	/**
	 * db:qr()
	 *
	 *  alias of queryReturn()
	 *
	 * @param mixed $query SQL Query to be used
	 * @param string $line optionally pass __LINE__ calling the query for logging
	 * @param string $file optionally pass __FILE__ calling the query for logging
	 * @return mixed FALSE if no rows, if a single row it returns that, if multiple it returns an array of rows, associative responses only
	 */
	public function qr($query, $line = '', $file = '') {
		return $this->queryReturn($query, $line, $file);
	}

	/**
	 * Db::query()
	 *
	 *  Sends an SQL query to the database
	 *
	 * @param mixed $queryString
	 * @param string $line
	 * @param string $file
	 * @return mixed 0 if no query or query id handler, safe to ignore this return
	 */
	public function query($queryString, $line = '', $file = '') {
		/* No empty queries, please, since PHP4 chokes on them. */
		/* The empty query string is passed on from the constructor,
		* when calling the class without a query, e.g. in situations
		* like these: '$db = new db_Subclass;'
		*/
		if ($queryString == '')
			return 0;
		if (!$this->connect()) {
			return 0;
			/* we already complained in connect() about that. */
		}
		// New query, discard previous result.
		if ($this->queryId !== false)

			$this->free();

		if ($this->Debug)
			printf("Debug: query = %s<br>\n", $queryString);
		if (isset($GLOBALS['log_queries']) && $GLOBALS['log_queries'] !== false)
			$this->log($queryString, $line, $file);

		$this->queryId = $this->linkId->prepare($queryString);
  $this->queryId = $this->linkId->prepare($queryString);
		$success = $this->queryId->execute();
		$this->Rows = $this->queryId->fetchAll();
		$this->log("PDO Query $queryString (S:$success) - ".count($this->Rows).' Rows', __LINE__, __FILE__);
		$this->Row = 0;
		if ($success === false) {
			$this->emailError($queryString, json_encode($this->queryId->errorInfo(), JSON_PRETTY_PRINT), $line, $file);
		}

		// Will return nada if it fails. That's fine.
		return $this->queryId;
	}

	/* public: walk result set */

	/**
	 * Db::next_record()
	 * @param mixed $resultType
	 * @return bool
	 */
	public function next_record($resultType = MYSQL_ASSOC) {
	public function next_record($resultType = /** @scrutinizer ignore-deprecated */ MYSQL_ASSOC) {
		// PDO result types so far seem to be +1
		++$resultType;
		if (!$this->queryId) {
			$this->halt('next_record called with no query pending.');
			return 0;
		}

		++$this->Row;
		$this->Record = $this->Rows[$this->Row];

		$stat = is_array($this->Record);
		if (!$stat && $this->autoFree)
			$this->free();
		return $stat;
	}

	/* public: position in result set */

	/**
	 * Db::seek()
	 * @param integer $pos
	 * @return int
	 */
	public function seek($pos = 0) {
		if (isset($this->Rows[$pos])) {
			$this->Row = $pos;
		} else {
			$this->halt("seek($pos) failed: result has ".count($this->Rows).' rows');
			/* half assed attempt to save the day,
			* but do not consider this documented or even
			* desirable behaviour.
			*/
			return 0;
		}
		return 1;
	}

	/**
	 * Initiates a transaction
	 * @return bool
	 */
	public function transactionBegin() {
		return $this->linkId->beginTransaction();
	}

	/**
	 * Commits a transaction
	 * @return bool
	 */
	public function transactionCommit() {
		return $this->linkId->commit();
	}

	/**
	 * Rolls back a transaction
	 * @return bool
	 */
	public function transactionAbort() {
		return $this->linkId->rollBack();
	}

	/**
	 * Db::getLastInsertId()
	 * @param mixed $table
	 * @param mixed $field
	 * @return int
	 */
	public function getLastInsertId($table, $field) {
		if (!isset($table) || $table == '' || !isset($field) || $field == '')
			return -1;
		return $this->linkId->lastInsertId();
	}

	/* public: table locking */

	/**
	 * Db::lock()
	 * @param mixed  $table
	 * @param string $mode
	 * @return void
	 */
	public function lock($table, $mode = 'write') {
	public function lock($table, /** @scrutinizer ignore-unused */ $mode = 'write') {
		/*			$this->connect();

		* $query = "lock tables ";
		* if (is_array($table))
		* {
		* while (list($key,$value)=each($table))
		* {
		* if ($key == "read" && $key!=0)
		* {
		* $query .= "$value read, ";
		* }
		* else
		* {
		* $query .= "$value $mode, ";
		* }
		* }
		* $query = mb_substr($query,0,-2);
		* }
		* else
		* {
		* $query .= "$table $mode";
		* }
		* $res = @mysql_query($query, $this->linkId);
		* if (!$res)
		* {
		* $this->halt("lock($table, $mode) failed.");
		* return 0;
		* }
		* return $res;
		*/
	}

	/**
	 * Db::unlock()
	 * @return void
	 */
	public function unlock() {
		/*			$this->connect();

		* $res = @mysql_query("unlock tables");
		* if (!$res)
		* {
		* $this->halt("unlock() failed.");
		* return 0;
		* }
		* return $res;
		*/
	}

	/* public: evaluate the result (size, width) */

	/**
	 * Db::affectedRows()
	 *
	 * @return mixed
	 */
	public function affectedRows() {
		return @$this->queryId->rowCount();
		return @$this->queryId->/** @scrutinizer ignore-call */ rowCount();
	}

	/**
	 * Db::num_rows()
	 * @return int
	 */
	public function num_rows() {
		return count($this->Rows);
	}

	/**
	 * Db::num_fields()
	 * @return int
	 */
	public function num_fields() {
		$keys = array_keys($this->Rows);
		return count($this->Rows[$keys[0]]);
	}

	/**
	 * @param mixed $msg
	 * @param string $line
	 * @param string $file
	 * @return mixed|void
	 */
	public function haltmsg($msg, $line = '', $file = '') {
		$this->log("Database error: $msg", $line, $file, 'error');
		if ($this->Errno != '0' || $this->Error != '()')
			$this->log('PDO MySQL Error: '.json_encode($this->linkId->errorInfo()), $line, $file, 'error');
		$this->logBackTrace($msg, $line, $file);
	}

	/**
	 * Db::tableNames()
	 *
	 * @return array
	 */
	public function tableNames() {
		$return = [];
		$this->query('SHOW TABLES');
		foreach ($this->Rows as $i => $info) {
			$return[$i]['table_name'] = $info[0];
			$return[$i]['tablespace_name'] = $this->database;
			$return[$i]['database'] = $this->database;
		}
		return $return;
	}
}

detain / db_abstraction

Push — master ( e9c576...010f10 )

Db::real_escape() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
