DrMVC\Database\Drivers\Driver

Complexity

Total Complexity

10

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getCollection()	0	3	1
A	getDsn()	0	7	1
A	getConfig()	0	3	1
A	__construct()	0	7	2
A	disconnect()	0	4	1
A	setConfig()	0	4	1
A	getParam()	0	4	1
A	setCollection()	0	4	1
A	setInstance()	0	4	1

<?php

namespace DrMVC\Database\Drivers;

use DrMVC\Config\ConfigInterface;
use DrMVC\Database\Drivers\Interfaces\DriverInterface;

/**
 * Abstract class, in which implemented basic logic similar for all database drivers
 * @package DrMVC\Database\Drivers
 */
abstract class Driver implements DriverInterface
{
    /**
     * @var mixed
     */
    protected $_instance;

    /**
     * @var ConfigInterface
     */
    private $_config;

    /**
     * Name of collection
     * @var string
     */
    private $_collection;

    /**
     * Driver constructor.
     *
     * @param   ConfigInterface $config object with current configuration
     * @param   string $collection name of collection
     */
    public function __construct(ConfigInterface $config, string $collection = null)
    {
        $this->setConfig($config);

        // Set collection name if name is provided
        if (null !== $collection) {
            $this->setCollection($this->getParam('prefix') . $collection);
        }
    }

    /**
     * Initiate connection with database
     *
     * @return  DriverInterface
     */
    abstract public function connect(): DriverInterface;

    /**
     * Close database connection
     *
     * @return  DriverInterface
     */
    public function disconnect(): DriverInterface
    {
        $this->setInstance(null);
        return $this;
    }

    /**
     * Generate DSN by parameters in config
     *
     * @param $config
     * @return string
     */
    abstract protected function genDsn($config): string;

    /**
     * Generate DSN by data in config
     *
     * @return  string
     */
    public function getDsn(): string
    {
        // Get all parameters
        $config = $this->getConfig()->get();

        // Generate DSN by parameters in config
        return $this->genDsn($config);
    }

    /**
     * @param   string $collection
     * @return  DriverInterface
     */
    public function setCollection(string $collection): DriverInterface
    {
        $this->_collection = $collection;
        return $this;
    }

    /**
     * @return string
     */
    public function getCollection(): string
    {
        return $this->_collection;
    }

    /**
     * Save current config
     *
     * @param   ConfigInterface $config
     * @return  DriverInterface
     */
    public function setConfig(ConfigInterface $config): DriverInterface
    {
        $this->_config = $config;
        return $this;
    }

    /**
     * Return config object
     *
     * @return  ConfigInterface
     */
    public function getConfig(): ConfigInterface
    {
        return $this->_config;
    }

    /**
     * Get some parameter from config by keyname
     *
     * @param   string $param
     * @return  mixed
     */
    public function getParam(string $param)
    {
        $result = $this->getConfig()->get($param);
        return $result ?? null;
    }

    /**
     * Save connection with database via driver
     *
     * @param   mixed $instance
     * @return  DriverInterface
     */
    public function setInstance($instance): DriverInterface
    {
        $this->_instance = $instance;
        return $this;
    }

    /**
     * Get current connection
     *
     * @return  mixed
     */
    abstract public function getInstance();

}