Ubiquity\db\providers\pdo\PDOWrapper

Complexity

Total Complexity

55

Size/Duplication

Total Lines	247
Duplicated Lines	0 %

Test Coverage

Coverage

69.84%

Importance

Changes	1
Bugs	0	Features	0

40 Methods

Rating	Name	Duplication	Size	Complexity
A	lastInsertId()	0	2	1
A	getDriverMetaDatas()	0	10	3
A	fetchAllColumn()	0	7	2
A	__construct()	0	3	1
A	inTransaction()	0	2	1
A	statementRowCount()	0	2	1
A	getTablesName()	0	2	1
A	query()	0	2	1
A	queryColumn()	0	2	1
A	executeStatement()	0	2	1
A	execute()	0	2	1
A	queryAll()	0	2	1
A	fetchOne()	0	8	2
A	prepareStatement()	0	2	1
A	getDSN()	0	6	2
A	getStatement()	0	4	1
A	fetchAll()	0	8	2
A	bindValueFromStatement()	0	2	1
A	fetchColumn()	0	5	2
A	connect()	0	7	2
A	getAvailableDrivers()	0	2	1
A	getPrimaryKeys()	0	2	1
A	savePoint()	0	2	1
A	getRowNum()	0	2	1
A	_optPrepareAndExecute()	0	12	3
A	commit()	0	5	2
A	getFieldsInfos()	0	2	1
A	releasePoint()	0	2	1
A	rollbackPoint()	0	2	1
A	_optExecuteAndFetch()	0	11	3
A	beginTransaction()	0	2	1
A	quoteValue()	0	2	1
A	rollBack()	0	5	2
A	toStringOperator()	0	2	1
A	ping()	0	2	2
A	nestable()	0	2	1
A	groupConcat()	0	2	1
A	getForeignKeys()	0	2	1
A	migrateOperation()	0	2	1
A	setIsolationLevel()	0	2	1

<?php

namespace Ubiquity\db\providers\pdo;

use Ubiquity\db\providers\AbstractDbWrapper;
use Ubiquity\exceptions\DBException;

/**
 * Ubiquity\db\providers$PDOWrapper
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.0.7
 * @property \PDO $dbInstance
 *
 */
class PDOWrapper extends AbstractDbWrapper {
	protected static $savepointsDrivers = [ 'pgsql' => true,'mysql' => true,'sqlite' => true ];
	private static $quotes = [ 'mysql' => '`','sqlite' => '"','pgsql' => '"' ];
	protected $driversMetasClasses = [ 'mysql' => '\\Ubiquity\\db\\providers\\pdo\\drivers\\MysqlDriverMetas','pgsql' => '\\Ubiquity\\db\\providers\\pdo\\drivers\\PgsqlDriverMetas','sqlite' => '\\Ubiquity\\db\\providers\\pdo\\drivers\\SqliteDriverMetas' ];
	protected $transactionLevel = 0;
	protected $dbType;
	protected $driverMetaDatas;

	/**
	 *
	 * @throws DBException
	 * @return \Ubiquity\db\providers\pdo\drivers\AbstractDriverMetaDatas
	 */
	protected function getDriverMetaDatas() {
		if (! isset ( $this->driverMetaDatas )) {
			if (isset ( $this->driversMetasClasses [$this->dbType] )) {
				$metaClass = $this->driversMetasClasses [$this->dbType];
				$this->driverMetaDatas = new $metaClass ( $this->dbInstance );
			} else {
				throw new DBException ( "{$this->dbType} driver is not yet implemented!" );
			}
		}
		return $this->driverMetaDatas;
	}

	public function __construct($dbType = 'mysql') {
		$this->quote = self::$quotes [$dbType] ?? '';
		$this->dbType = $dbType;
	}

	public function fetchAllColumn($statement, array $values = null, string $column = null) {
		$result = false;
		if ($statement->execute ( $values )) {
			$result = $statement->fetchAll ( \PDO::FETCH_COLUMN, $column );
		}
		$statement->closeCursor ();
		return $result;
	}

	public function lastInsertId($name = null) {
		return $this->dbInstance->lastInsertId ( $name );
	}

	public function fetchAll($statement, array $values = null, $mode = null) {
		if ($statement->execute ( $values )) {
			$result = $statement->fetchAll ( $mode ?? \PDO::FETCH_ASSOC);
			$statement->closeCursor ();
			return $result;
		}

		return false;
	}

	public function fetchOne($statement, array $values = null, $mode = null) {
		if ($statement->execute ( $values )) {
			$result = $statement->fetch ( $mode ?? \PDO::FETCH_ASSOC);
			$statement->closeCursor ();
			return $result;
		}

		return false;
	}

	public static function getAvailableDrivers() {
		return \PDO::getAvailableDrivers ();
	}

	public function prepareStatement(string $sql) {
		return $this->dbInstance->prepare ( $sql );
	}

	public function fetchColumn($statement, array $values = null, int $columnNumber = null) {
		if ($statement->execute ( $values )) {
			return $statement->fetchColumn ( $columnNumber );
		}
		return false;
	}

	public function getStatement($sql) {
		$st = $this->dbInstance->prepare ( $sql );
		$st->setFetchMode ( \PDO::FETCH_ASSOC );
		return $st;
	}

	public function execute($sql) {
		return $this->dbInstance->exec ( $sql );
	}

	public function connect(string $dbType, $dbName, $serverName, string $port, string $user, string $password, array $options) {
		$options [\PDO::ATTR_ERRMODE] = \PDO::ERRMODE_EXCEPTION;
		if (isset ( $options ['quote'] )) {
			$this->quote = $options ['quote'];
			unset ( $options ['quote'] );
		}
		$this->dbInstance = new \PDO ( $this->getDSN ( $serverName, $port, $dbName, $dbType ), $user, $password, $options );
	}

	public function getDSN(string $serverName, string $port, string $dbName, string $dbType = 'mysql') {
		$charsetString = [ 'mysql' => 'charset=UTF8','pgsql' => 'options=\'--client_encoding=UTF8\'','sqlite' => '' ] [$dbType] ?? 'charset=UTF8';
		if ($dbType === 'sqlite') {
			return "sqlite:{$dbName}";
		}
		return $dbType . ":dbname={$dbName};host={$serverName};{$charsetString};port=" . $port;
	}

	public function bindValueFromStatement($statement, $parameter, $value) {
		return $statement->bindValue ( ":" . $parameter, $value );
	}

	public function query(string $sql) {
		return $this->dbInstance->query ( $sql );
	}

	public function queryAll(string $sql, int $fetchStyle = null) {
		return $this->dbInstance->query ( $sql )->fetchAll ( $fetchStyle );
	}

	public function queryColumn(string $sql, int $columnNumber = null) {
		return $this->dbInstance->query ( $sql )->fetchColumn ( $columnNumber );
	}

	public function executeStatement($statement, array $values = null) {
		return $statement->execute ( $values );
	}

	public function getTablesName() {
		return $this->getDriverMetaDatas ()->getTablesName ();
	}

	public function statementRowCount($statement) {
		return $statement->rowCount ();
	}

	public function inTransaction() {
		return $this->dbInstance->inTransaction ();
	}

	public function commit() {
		if($this->dbInstance->inTransaction()) {
			return $this->dbInstance->commit();
		}
		return false;
	}

	public function rollBack() {
		if($this->dbInstance->inTransaction()) {
			return $this->dbInstance->rollBack ();
		}
		return false;
	}

	public function beginTransaction() {
		return $this->dbInstance->beginTransaction ();
	}

	public function savePoint($level) {
		$this->dbInstance->exec ( 'SAVEPOINT LEVEL' . $level );
	}

	public function releasePoint($level) {
		$this->dbInstance->exec ( 'RELEASE SAVEPOINT LEVEL' . $level );
	}

	public function rollbackPoint($level) {
		$this->dbInstance->exec ( 'ROLLBACK TO SAVEPOINT LEVEL' . $level );
	}

	public function nestable() {
		return isset ( self::$savepointsDrivers [$this->dbType] );
	}

	public function ping() {
		return ($this->dbInstance != null) && (1 === \intval ( $this->queryColumn ( 'SELECT 1', 0 ) ));
	}

	public function getPrimaryKeys($tableName) {
		return $this->getDriverMetaDatas ()->getPrimaryKeys ( $tableName );
	}

	public function getForeignKeys($tableName, $pkName, $dbName = null) {
		return $this->getDriverMetaDatas ()->getForeignKeys ( $tableName, $pkName, $dbName );
	}

	public function getFieldsInfos($tableName) {
		return $this->getDriverMetaDatas ()->getFieldsInfos ( $tableName );
	}

	public function _optPrepareAndExecute($sql, array $values = null, $one = false) {
		$statement = $this->_getStatement ( $sql );
		$result = false;
		if ($statement->execute ( $values )) {
			if ($one) {
				$result = $statement->fetch ( \PDO::FETCH_ASSOC );
			} else {
				$result = $statement->fetchAll ( \PDO::FETCH_ASSOC );
			}
		}
		$statement->closeCursor ();
		return $result;
	}

	public function _optExecuteAndFetch($statement, array $values = null, $one = false) {
		if ($statement->execute ( $values )) {
			if ($one) {
				$row = $statement->fetch ( \PDO::FETCH_ASSOC );
			} else {
				$row = $statement->fetchAll ( \PDO::FETCH_ASSOC );
			}
			$statement->closeCursor ();
			return $row;
		}
		return false;
	}

	public function quoteValue($value, $type = 2) {
		return $this->dbInstance->quote ( $value, $type );
	}

	public function getRowNum(string $tableName, string $pkName, string $condition): int {
		return $this->getDriverMetaDatas ()->getRowNum ( $tableName, $pkName, $condition );
	}

	public function groupConcat(string $fields, string $separator): string {
		return $this->getDriverMetaDatas ()->groupConcat ( $fields, $separator );
	}

	public function toStringOperator() {
		return $this->getDriverMetaDatas ()->toStringOperator ();
	}

	/**
	 * Returns the SQL string for a migration operation.
	 * @param string $operation
	 * @return string
	 */
	public function migrateOperation(string $operation):?string{
		return $this->getDriverMetaDatas()->migrateOperation($operation)??parent::migrateOperation($operation);
	}

	/**
	 * Sets the isolation level for transactions.
	 * @param $isolationLevel
	 * @return mixed|void
	 * @throws DBException
	 */
	public function setIsolationLevel($isolationLevel) {
		return $this->getDriverMetaDatas()->setIsolationLevel($isolationLevel);
	}
}