AgelxNash\Modx\Evo\Database\Drivers\MySqliDriver

Complexity

Total Complexity

53

Size/Duplication

Total Lines	345
Duplicated Lines	0 %

Test Coverage

Coverage

93.04%

Importance

Changes

0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	connect()	0	24	6
A	escape()	0	3	1
B	getRow()	0	22	5
A	query()	0	13	2
A	disconnect()	0	9	2
A	getAffectedRows()	0	3	1
A	isConnected()	0	3	1
A	getVersion()	0	3	1
A	setCharset()	0	9	3
A	getConfig()	0	3	1
A	selectDb()	0	3	1
A	getConnect()	0	7	2
A	getInsertId()	0	3	1
A	isResult()	0	3	1
A	getTableMetaData()	0	12	3
A	dataSeek()	0	3	2
A	getLastError()	0	3	1
A	numFields()	0	3	2
A	getRecordCount()	0	3	2
A	fieldName()	0	5	3
A	getColumnNames()	0	12	3
A	getColumn()	0	13	4
A	getValue()	0	10	3
A	getLastErrorNo()	0	3	1

<?php namespace AgelxNash\Modx\Evo\Database\Drivers;

use AgelxNash\Modx\Evo\Database\Interfaces\DriverInterface;
use AgelxNash\Modx\Evo\Database\Exceptions;
use mysqli;
use mysqli_result;
use mysqli_sql_exception;
use mysqli_driver;
use ReflectionClass;

class MySqliDriver implements DriverInterface
{
    /**
     * @var mysqli
     */
    protected $conn;

    /**
     * @var array
     */
    protected $config;

    /**
     * {@inheritDoc}
     */
    public function __construct(array $config = [])
    {
        $driver = new mysqli_driver();
        $driver->report_mode = MYSQLI_REPORT_STRICT | MYSQLI_REPORT_ERROR;

        $this->config = $config;
    }

    /**
     * @return array
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * @return mixed
     * @throws Exceptions\Exception
     */
    public function getConnect()
    {
        if (! $this->isConnected()) {
            return $this->connect();
        }

        return $this->conn;
    }

    /**
     * @return mysqli
     * @throws Exceptions\Exception
     */
    public function connect()
    {
        try {
            $this->conn = new mysqli(
                $this->config['host'],
                $this->config['username'],
                $this->config['password'],
                $this->config['database']
            );

            if ($this->isConnected() && $this->getConnect()->connect_error) {
                throw new Exceptions\ConnectException($this->conn->connect_error);
            }

            if (! $this->isConnected()) {
                throw new Exceptions\ConnectException(
                    $this->getLastError() ?: 'Failed to create the database connection!'
                );
            }
        } catch (mysqli_sql_exception $exception) {
            throw new Exceptions\ConnectException($exception->getMessage(), $exception->getCode());
        }

        return $this->conn;
    }

    /**
     * {@inheritDoc}
     */
    public function disconnect()
    {
        if ($this->isConnected()) {
            $this->conn->close();
        }

        $this->conn = null;

        return $this;
    }

    /**
     * @return bool
     */
    public function isConnected()
    {
        return ($this->conn instanceof mysqli);
    }

    /**
     * @param $data
     * @return mixed
     * @throws Exceptions\Exception
     */
    public function escape($data)
    {
        return $this->getConnect()->escape_string($data);
    }

    /**
     * @return mixed
     * @throws Exceptions\Exception
     */
    public function getInsertId()
    {
        return $this->getConnect()->insert_id;
    }

    /**
     * @return int
     * @throws Exceptions\Exception
     */
    public function getAffectedRows()
    {
        return $this->getConnect()->affected_rows;
    }

    /**
     * @return string
     * @throws Exceptions\Exception
     */
    public function getVersion()
    {
        return $this->getConnect()->server_info;
    }

    /**
     * @param mysqli_result $result
     * @return int
     */
    public function getRecordCount($result)
    {
        return $this->isResult($result) ? $result->num_rows : 0;
    }

    /**
     * {@inheritDoc}
     */
    public function setCharset($charset, $collation, $method = null)
    {
        if ($method === null) {
            $method = $this->config['method'];
        }
        if ($this->query($method . ' ' . $charset . ' COLLATE ' . $collation) === true) {
            return $this->getConnect()->set_charset($charset);
        }
        return false;
    }

    /**
     * @param $result
     * @return bool
     */
    public function isResult($result)
    {
        return $result instanceof mysqli_result;
    }

    /**
     * @param mysqli_result $result
     * @return int
     */
    public function numFields($result)
    {
        return $this->isResult($result) ? $result->field_count : 0;
    }

    /**
     * @param mysqli_result $result
     * @param int $col
     * @return string|null
     */
    public function fieldName($result, $col = 0)
    {
        $field = $this->isResult($result) ? $result->fetch_field_direct($col) : [];

        return isset($field->name) ? $field->name : null;
    }

    /**
     * @param string $name
     * @return bool
     * @throws Exceptions\Exception
     */
    public function selectDb($name)
    {
        return $this->getConnect()->select_db($name);
    }

    /**
     * @param mysqli_result $result
     * @param string $mode
     * @return array|mixed|object|\stdClass
     * @throws Exceptions\Exception
     */
    public function getRow($result, $mode = 'assoc')
    {
        switch ($mode) {
            case 'assoc':
                $out = $result->fetch_assoc();
                break;
            case 'num':
                $out = $result->fetch_row();
                break;
            case 'object':
                $out = $result->fetch_object();
                break;
            case 'both':
                $out = $result->fetch_array(MYSQLI_BOTH);
                break;
            default:
                throw new Exceptions\UnknownFetchTypeException(
                    "Unknown get type ($mode) specified for fetchRow - must be empty, 'assoc', 'num' or 'both'."
                );
        }

        return $out;
    }

    /**
     * @param string $query
     * @return mixed
     * @throws Exceptions\Exception
     */
    public function query($query)
    {
        try {
            $result = $this->getConnect()->query($query);
        } catch (mysqli_sql_exception $exception) {
            $reflect = new ReflectionClass($exception);
            $property = $reflect->getProperty('sqlstate');
            $property->setAccessible(true);
            throw (new Exceptions\QueryException($exception->getMessage(), $property->getValue($exception)))
                ->setQuery($query);
        }

        return $result;
    }

    /**
     * @param string $name
     * @param $result
     * @return array
     * @throws Exceptions\Exception
     */
    public function getColumn($name, $result)
    {
        $col = [];

        if ($this->isResult($result)) {
            while ($row = $this->getRow($result)) {
                if (array_key_exists($name, $row)) {

It seems like $row can also be of type object and stdClass; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

                    $col[] = $row[$name];
                }
            }
        }

        return $col;
    }

    /**
     * @param $result
     * @return array
     */
    public function getColumnNames($result)
    {
        $names = [];

        if ($this->isResult($result)) {
            $limit = $this->numFields($result);
            for ($i = 0; $i < $limit; $i++) {
                $names[] = $this->fieldName($result, $i);
            }
        }

        return $names;
    }

    /**
     * @param $result
     * @return bool|mixed
     * @throws Exceptions\Exception
     */
    public function getValue($result)
    {
        $out = false;

        if ($this->isResult($result)) {
            $result = $this->getRow($result, 'num');
            $out = isset($result[0]) ? $result[0] : false;
        }

        return $out;
    }

    /**
     * @param $result
     * @return array|mixed
     * @throws Exceptions\Exception
     */
    public function getTableMetaData($result)
    {
        $out = [];

        if ($this->isResult($result)) {
            while ($row = $this->getRow($result)) {
                $fieldName = $row['Field'];
                $out[$fieldName] = $row;
            }
        }

        return $out;
    }

    /**
     * @return string|null
     * @throws Exceptions\Exception
     */
    public function getLastError()
    {
        return $this->getConnect()->error;
    }

    /**
     * @return string|null
     * @throws Exceptions\Exception
     */
    public function getLastErrorNo()
    {
        return (string)$this->getConnect()->sqlstate;
    }

    /**
     * {@inheritDoc}
     */
    public function dataSeek(&$result, $position)
    {
        return $this->isResult($result) ? $result->data_seek($position) : false;
    }
}