Terah\FluentPdoModel\Drivers\AbstractPdo

Complexity

Total Complexity

24

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getLogger()	0	4	1
B	setConfig()	0	19	5
A	getConfig()	0	4	2
A	getAllConfig()	0	4	1
A	logQueries()	0	4	3
A	getTransactionDepth()	0	4	1
A	beginTransaction()	0	10	2
A	commit()	0	11	3
A	rollback()	0	11	2
A	setLimit()	0	16	3
A	supportsColumnMeta()	0	4	1
	getFieldComment()	0	1	?
	getTables()	0	1	?
	getColumns()	0	1	?
	getForeignKeys()	0	1	?
	getTableCounts()	0	1	?

<?php declare(strict_types=1);
/**
 * @package Terah\FluentPdoModel
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */

namespace Terah\FluentPdoModel\Drivers;

use Psr\Log\LoggerInterface;
use \PDO;
use function Terah\Assert\Assert;
use Psr\Log\LoggerAwareTrait;
use Terah\FluentPdoModel\Column;
use Terah\FluentPdoModel\ForeignKey;
use Terah\RedisCache\RedisCacheTrait;
/**
 * Class AbstractPdo
 *
 * @package Terah\FluentPdoModel\Drivers
 * @author  Terry Cullen - terry@terah.com.au
 */
abstract class AbstractPdo extends PDO implements DriverInterface
{
    use RedisCacheTrait;
    use LoggerAwareTrait;

    /** @var array  */
    protected $_config              = [];

    /** @var int  */
    protected $_transactionCount    = 0;

    /** @var bool  */
    protected $_supportsColumnMeta  = false;

    /**
     * @return LoggerInterface
     */
    public function getLogger() : LoggerInterface
    {
        return $this->logger;
    }

    /**
     * @param array  $config
     * @param string $dsn
     * @return AbstractPdo
     */
    public function setConfig(array $config=[], string $dsn='') : AbstractPdo
    {
        if ( $dsn )
        {
            $driver                 = strpos($dsn, ':') !== false ? substr($dsn, 0, strpos($dsn, ':')) : $dsn;
            $driver                 = ucfirst(strtolower($driver));
            $dsn                    = preg_replace("/^{$driver}:/i", '', $dsn);
            $parts                  = explode(';', $dsn);
            foreach ( $parts as $conf )
            {
                $conf                   = explode('=', $conf);
                $config[$conf[0]]       = isset($conf[1]) ? $conf[1] : true;
            }
            $config['driver']       = $driver;
        }
        $this->_config          = $config;

        return $this;
    }

    /**
     * @param string $key
     * @return mixed
     */
    public function getConfig(string $key)
    {
        return isset($this->_config[$key]) ? $this->_config[$key] : null;
    }

    /**
     * @return array
     */
    public function getAllConfig() : array
    {
        return $this->_config;
    }

    /**
     * @return bool
     */
    public function logQueries() : bool
    {
        return !empty( $this->_config['log_queries'] ) && $this->_config['log_queries'] ? true : false;
    }

    /**
     * @return int
     */
    public function getTransactionDepth() : int
    {
        return $this->_transactionCount;
    }

    /**
     * @return bool
     */
    public function beginTransaction() : bool
    {
        $this->_transactionCount++;
        if ( $this->_transactionCount === 1 )
        {
            return parent::beginTransaction();
        }

        return true;
    }

    /**
     * @return bool
     */
    public function commit() : bool
    {
        $this->_transactionCount--;
        $this->_transactionCount = $this->_transactionCount < 0 ? 0 : $this->_transactionCount;
        if ( $this->_transactionCount === 0 )
        {
            return parent::commit();
        }

        return true;
    }

    /**
     * @return bool
     */
    public function rollback() : bool
    {
        if ( $this->_transactionCount > 0 )
        {
            $this->_transactionCount = 0;

            return parent::rollBack();
        }

        return true;
    }

    /**
     * @param string $query
     * @param integer $limit
     * @param integer $offset
     * @return string
     */
    public function setLimit(string $query, int $limit=0, int $offset=0) : string
    {
        Assert($query)->string()->notEmpty();
        Assert($limit)->unsignedInt();
        Assert($offset)->unsignedInt();
        if ( $limit )
        {
            $query .= " LIMIT {$limit}";
        }
        if ( $offset )
        {
            $query .= " OFFSET {$offset}";
        }

        return $query;
    }

    /**
     * @return bool
     */
    public function supportsColumnMeta() : bool
    {
        return $this->_supportsColumnMeta;
    }

    /**
     * @param string $table
     * @param string $column
     * @return string
     */
    abstract public function getFieldComment(string $table, string $column) : string;

    /**
     * @param bool $include_views
     * @return array
     */
    abstract public function getTables(bool $include_views=false) : array;

    /**
     * @param bool $include_views
     * @param string $table
     * @return Column[][]
     */
    abstract public function getColumns(bool $include_views=false, string $table='') : array;

    /**
     * @param string $table
     * @return ForeignKey[][]
     */
    abstract public function getForeignKeys(string $table='') : array;


    /**
     * @param bool $include_views
     * @param string $table
     * @return array
     */
    abstract public function getTableCounts(bool $include_views=false, string $table='') : array;
}