chillerlan\Database\Drivers\PDO\PDODriverAbstract

Complexity

Total Complexity

27

Size/Duplication

Total Lines	256
Duplicated Lines	9.38 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getDSN()	0	15	3
B	connect()	0	27	4
A	disconnect()	0	5	1
A	getClientInfo()	0	3	1
A	getServerInfo()	0	3	1
A	escape()	0	3	1
B	bindParams()	0	16	5
A	insertID()	0	3	1
A	__getResult()	0	8	3
A	__raw()	0	3	1
A	__prepared()	0	11	2
A	__multi()	12	12	2
A	__multi_callback()	12	12	2

<?php
/**
 * Class PDODriverAbstract
 *
 * @filesource   PDODriverAbstract.php
 * @created      04.11.2015
 * @package      chillerlan\Database\Drivers\PDO
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2015 Smiley
 * @license      MIT
 */

namespace chillerlan\Database\Drivers\PDO;

use chillerlan\Database\DBException;
use chillerlan\Database\Drivers\{DBDriverAbstract, DBDriverInterface};
use PDO, PDOException, PDOStatement;

/**
 *
 * @see http://php.net/manual/pdo.constants.php
 */
abstract class PDODriverAbstract extends DBDriverAbstract{

	/**
	 * Holds the database resource object
	 *
	 * @var PDO
	 */
	protected $db;

	/**
	 * Some basic PDO options
	 *
	 * @see http://php.net/manual/pdo.getattribute.php PDO::getAttribute
	 *
	 * @var array
	 */
	protected $pdo_options = [
		PDO::ATTR_CASE              => PDO::CASE_NATURAL,
		PDO::ATTR_ERRMODE           => PDO::ERRMODE_EXCEPTION,
		PDO::ATTR_ORACLE_NULLS      => PDO::NULL_NATURAL,
		PDO::ATTR_STRINGIFY_FETCHES => false,
		PDO::ATTR_EMULATE_PREPARES  => false,
	];

	/**
	 * The PDO drivername which is being used in the DSN
	 *
	 * @var string
	 */
	protected $drivername;

	/**
	 * This array holds one or more key=>value pairs to set attribute values for the PDOStatement object that this
	 * method returns. You would most commonly use this to set the PDO::ATTR_CURSOR value to PDO::CURSOR_SCROLL to
	 * request a scrollable cursor.
	 *
	 * @var array
	 */
	protected $pdo_stmt_options = [];

	/**
	 * Returns a DSN string using the given options
	 *
	 * @link http://www.phpro.org/tutorials/Introduction-to-PHP-PDO.html#4.4
	 *
	 * @return string DSN
	 */
	protected function getDSN():string{
		$dsn = $this->drivername;

		if($this->options->socket){
			$dsn .= ':unix_socket='.$this->options->socket; // @codeCoverageIgnore
		}
		else{
			$dsn .= ':host='.$this->options->host;
			$dsn .= is_numeric($this->options->port) ? ';port='.$this->options->port : '';
		}

		$dsn .= ';dbname='.$this->options->database;

		return $dsn;
	}

	/**
	 * Establishes a database connection and returns the connection object
	 *
	 * @return \chillerlan\Database\Drivers\DBDriverInterface
	 * @throws \chillerlan\Database\DBException
	 */
	public function connect():DBDriverInterface{

		if($this->db instanceof PDO){
			return $this;
		}

		try{
			// @codeCoverageIgnoreStart
			if($this->options->use_ssl){
				$this->pdo_options += [
					PDO::MYSQL_ATTR_SSL_KEY    => $this->options->ssl_key,
					PDO::MYSQL_ATTR_SSL_CERT   => $this->options->ssl_cert,
					PDO::MYSQL_ATTR_SSL_CA     => $this->options->ssl_ca,
					PDO::MYSQL_ATTR_SSL_CAPATH => $this->options->ssl_capath,
					PDO::MYSQL_ATTR_SSL_CIPHER => $this->options->ssl_cipher,
				];
			}
			// @codeCoverageIgnoreEnd

			$this->db = new PDO($this->getDSN(), $this->options->username, $this->options->password, $this->pdo_options);

			return $this;
		}
		catch(\Exception $e){
			throw new DBException('db error: [PDODriver]: '.$e->getMessage());
		}
	}

	/**
	 * Closes a database connection
	 *
	 * @return bool
	 */
	public function disconnect():bool{
		$this->db = null;

		return true;
	}

	/**
	 * Returns info about the used php client
	 *
	 * @return string php's database client string
	 */
	public function getClientInfo():string{
		return $this->db->getAttribute(PDO::ATTR_CLIENT_VERSION);
	}

	/**
	 * Returns info about the database server
	 *
	 * @return string database's serverinfo string
	 */
	public function getServerInfo():string{
		return $this->db->getAttribute(PDO::ATTR_SERVER_INFO);
	}

	/**
	 * @param $data
	 *
	 * @return string
	 */
	public function escape($data){
		return $this->db->quote($data);
	}

	/**
	 * @param \PDOStatement $stmt
	 * @param array         $values
	 *
	 * @return void
	 */
	protected function bindParams(PDOStatement &$stmt, array $values){
		$param_no = 1;

		foreach($values as $v){

			switch(gettype($v)){
				case 'boolean': $type = PDO::PARAM_BOOL; break;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

				case 'integer': $type = PDO::PARAM_INT;  break;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

				case 'NULL'   : $type = PDO::PARAM_NULL; break;

There must be no space before the colon in a CASE statement

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

				default:        $type = PDO::PARAM_STR;  break;

The default body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

			}

			$stmt->bindValue($param_no, $v, $type);
			$param_no++;
		}
	}

	/**
	 * Returns the last insert id (if present)
	 *
	 * @link http://php.net/manual/pdo.lastinsertid.php
	 * @return string
	 * @codeCoverageIgnore
	 */
	protected function insertID():string{
		return $this->db->lastInsertId();
	}

	/**
	 * @param             $stmt
	 * @param string|null $index
	 * @param bool        $assoc
	 *
	 * @return bool|\chillerlan\Database\DBResult
	 */
	protected function __getResult($stmt, string $index = null, bool $assoc = true){

		if(is_bool($stmt)){
			return $stmt; // @codeCoverageIgnore
		}

		return $this->getResult([$stmt, 'fetch'], [$assoc ? PDO::FETCH_ASSOC : PDO::FETCH_NUM], $index, $assoc);
	}

	/**
	 * @param string      $sql
	 * @param string|null $index
	 * @param bool        $assoc
	 *
	 * @return bool|\chillerlan\Database\DBResult
	 */
	protected function __raw(string $sql, string $index = null, bool $assoc = true){
		return $this->__getResult($this->db->query($sql), $index, $assoc);
	}

	/**
	 * @param string      $sql
	 * @param array       $values
	 * @param string|null $index
	 * @param bool        $assoc
	 *
	 * @return bool|\chillerlan\Database\DBResult
	 */
	protected function __prepared(string $sql, array $values = [], string $index = null, bool $assoc = true){
		$stmt = $this->db->prepare($sql, $this->pdo_stmt_options);

		if(!empty($values)){
			$this->bindParams($stmt, $values);
		}

		$stmt->execute();

		return $this->__getResult($stmt, $index, $assoc);
	}

	/**
	 * @param string $sql
	 * @param array  $values
	 *
	 * @return bool
	 */
	protected function __multi(string $sql, array $values){

This method seems to be duplicated in your project.

		$stmt = $this->db->prepare($sql, $this->pdo_stmt_options);

		foreach($values as $row){
			$this->bindParams($stmt, $row);
			$stmt->execute();
		}

		$stmt = null;

$stmt is not used, you could remove the assignment.

		return true;
	}

	/**
	 * @param string $sql
	 * @param array  $data
	 * @param        $callback
	 *
	 * @return bool
	 */
	protected function __multi_callback(string $sql, array $data, $callback){

This method seems to be duplicated in your project.

		$stmt = $this->db->prepare($sql, $this->pdo_stmt_options);

		foreach($data as $row){
			$this->bindParams($stmt, call_user_func_array($callback, [$row]));
			$stmt->execute();
		}

		$stmt = null;

$stmt is not used, you could remove the assignment.

		return true;
	}

}