Pleets / dronephp

src/Db/Driver/AbstractDriver.php

<?php
/**
 * DronePHP (http://www.dronephp.com)
 *
 * @link      http://github.com/Pleets/DronePHP
 * @copyright Copyright (c) 2016-2018 Pleets. (http://www.pleets.org)
 * @license   http://www.dronephp.com/license
 * @author    Darío Rivera <fermius.us@gmail.com>
 */

namespace Drone\Db\Driver;

use Drone\Error\Errno;

/**
 * AbstractDriver Class
 *
 * This class defines standard behavior for database drivers
 */
abstract class AbstractDriver
{
    use \Drone\Error\ErrorTrait;

    /**
     * Database host
     *
     * @var string
     */
    protected $dbhost;

    /**
     * Database user
     *
     * @var string
     */
    protected $dbuser;

    /**
     * Database password
     *
     * @var string
     */
    protected $dbpass;

    /**
     * Database name
     *
     * @var string
     */
    protected $dbname;

    /**
     * Database charset
     *
     * @var string
     */
    protected $dbchar;

    /**
     * Database port
     *
     * @var integer
     */
    protected $dbport;

    /**
     * Driver name
     *
     * @var string
     */
    protected $driverName;

    /**
     * Connection identifier
     *
     * @var object|resource
     */
    protected $dbconn;

    /**
     * Rows returned on execute() method
     *
     * @var integer
     */
    protected $numRows;

    /**
     * Fields returned on execute() method
     *
     * @var integer
     */
    protected $numFields;

    /**
     * Rows affected returned on execute() method
     *
     * @var integer
     */
    protected $rowsAffected;

    /**
     * Statement handle
     *
     * @var resource|mixed
     */
    protected $result;

    /**
     * Data stored in select statements
     *
     * @var array
     */
    protected $arrayResult;

    /**
     * Defines if consecutive querys are part of a transaction
     *
     * @var boolean
     */
    protected $transac_mode = false;

    /**
     * Latest result of a transaction process
     *
     * The first time would be a result of a query(), execute() or parse() methods
     * On subsequent times it's a boolean resulting of the boolean operation AND with the latest result.
     *
     * @var boolean
     */
    protected $transac_result = null;

    /**
     * Autocommit behavior
     *
     * @var boolean
     */
    protected $autocommit = true;

    /**
     * Returns the dbhost attribute
     *
     * @return string
     */
    public function getDbhost()
    {
        return $this->dbhost;
    }

    /**
     * Returns the dbuser attribute
     *
     * @return string
     */
    public function getDbuser()
    {
        return $this->dbuser;
    }

    /**
     * Returns the dbname attribute
     *
     * @return string
     */
    public function getDbname()
    {
        return $this->dbname;
    }

    /**
     * Returns the dbchar attribute
     *
     * @return string
     */
    public function getDbchar()
    {
        return $this->dbchar;
    }

    /**
     * Returns the dbport attribute
     *
     * @return string
     */
    public function getDbport()
    {
        return $this->dbport;
    }

    /**
     * Returns the driverName attribute
     *
     * @return string
     */
    public function getDriverName()
    {
        return $this->driverName;
    }

    /**
     * Returns the numRows attribute
     *
     * @return integer
     */
    public function getNumRows()
    {
        return $this->numRows;
    }

    /**
     * Returns the numFields attribute
     *
     * @return integer
     */
    public function getNumFields()
    {
        return $this->numFields;
    }

    /**
     * Returns the rowsAffected attribute
     *
     * @return integer
     */
    public function getRowsAffected()
    {
        return $this->rowsAffected;
    }

    /**
     * Returns an array with all results of the last execute statement
     *
     * @return array
     */
    public function getArrayResult()
    {
        if (!empty($this->arrayResult)) {
            return $this->arrayResult;
        }

        return $this->toArray();
    }

    /**
     * Returns the autocommit attribute
     *
     * @return boolean
     */
    public function getAutoCommit()
    {
        return $this->autocommit;
    }

    /**
     * Sets dbhost attribute
     *
     * @param string $value
     *
     * @return null
     */
    public function setDbhost($value)
    {
        $this->dbhost = $value;
    }

    /**
     * Sets dbuser attribute
     *
     * @param string $value
     *
     * @return null
     */
    public function setDbuser($value)
    {
        $this->dbuser = $value;
    }

    /**
     * Sets dbpass attribute
     *
     * @param string $value
     *
     * @return null
     */
    public function setDbpass($value)
    {
        $this->dbpass = $value;
    }

    /**
     * Sets dbname attribute
     *
     * @param string $value
     *
     * @return null
     */
    public function setDbname($value)
    {
        $this->dbname = $value;
    }

    /**
     * Sets dbchar attribute
     *
     * @param string $value
     *
     * @return null
     */
    public function setDbchar($value)
    {
        $this->dbchar = $value;
    }

    /**
     * Sets dbport attribute
     *
     * @param integer $value
     *
     * @return null
     */
    public function setDbport($value)
    {
        $this->dbport = $value;
    }

    /**
     * Sets autocommit behavior
     *
     * @param boolean $value
     *
     * @return null
     */
    public function autocommit($value)
    {
        if ($this->transac_mode) {
            throw new \LogicException("You cannot change autocommit behavior during a transaction");
        }

        $this->autocommit = $value;
    }

    /**
     * Driver Constructor
     *
     * All modifiable attributes (i.e. with setter method) can be passed as key
     *
     * @param array $options
     */
    public function __construct($options)
    {
        foreach ($options as $option => $value) {
            if (property_exists(__CLASS__, strtolower($option)) && method_exists($this, 'set'.$option)) {
                $this->{'set'.$option}($value);
            }
        }
    }

    /**
     * Returns true if there is a stablished connection
     *
     * @return boolean
     */
    public function isConnected()
    {
        return (is_resource($this->dbconn) || is_object($this->dbconn));
    }

    /**
     * Abstract connect
     *
     * @throws RuntimeException
     *
     * @return resource|object
     */
    abstract public function connect();

    /**
     * Abstract execute
     *
     * @param string $sql
     * @param array $params to bind
     *
     * @throws RuntimeException
     *
     * @return resource|object
     */
    abstract public function execute($sql, array $params = []);

    /**
     * Reconnects to the database
     *
     * @throws LogicException
     *
     * @return resource|object
     */
    public function reconnect()
    {
        if (!$this->isConnected()) {
            throw new \LogicException("Connection was not established");
        }

        $this->disconnect();

        return $this->connect();
    }

    /**
     * Commit definition
     *
     * @return boolean
     */
    abstract public function commit();

    /**
     * Rollback definition
     *
     * @return boolean
     */
    abstract public function rollback();

    /**
     * Closes the connection
     *
     * @throws LogicException
     *
     * @return boolean
     */
    public function disconnect()
    {
        if (!$this->isConnected()) {
            throw new \LogicException("Connection was not established");
        }
    }

    /**
     * Defines the start point of a transaction
     *
     * @throws LogicException if transaction was already started
     *
     * @return null
     */
    public function beginTransaction()
    {
        if (!$this->isConnected()) {
            $this->connect();
        }

        if ($this->transac_mode) {
            throw new \LogicException($this->standardErrors[Errno::DB_TRANSACTION_STARTED]);
        }

        $this->transac_mode = true;
    }

    /**
     * Defines the end point of a transaction
     *
     * @throws LogicException if transaction has not been started or it's empty
     *
     * @return null
     */
    public function endTransaction()
    {
        if (!$this->transac_mode) {
            throw new \LogicException($this->standardErrors[Errno::DB_TRANSACTION_NOT_STARTED]);
        }

        if (is_null($this->transac_result)) {

The condition is_null($this->transac_result) is always false.

            throw new \LogicException($this->standardErrors[Errno::DB_TRANSACTION_EMPTY]);
        }

        if ($this->transac_result) {
            $this->commit();
        } else {
            $this->rollback();
        }

        $this->result = $this->transac_result;

        $this->transac_result = null;
        $this->transac_mode = false;
    }

    /**
     * Abstract result set
     *
     * By default all Drivers must be implement toArray() function.
     * The toArray() method must take the latest result from an execute statement
     * and convert it to an array. To get this array getArrayResult() has been implemented.
     *
     * @throws LogicException if execute() was not executed before this
     *
     * @return array
     */
    abstract protected function toArray();

    /**
     * Excecutes multiple statements as transaction
     *
     * @param array $querys
     *
     * @return null
     */
    public function transaction(array $querys)
    {
        $this->beginTransaction();

        foreach ($querys as $sql) {
            $this->execute($sql);
        }

        $this->endTransaction();
    }
}