byjg / anydataset

src/Database/BaseDBAccess.php

<?php

namespace ByJG\AnyDataset\Database;

use ByJG\AnyDataset\AnyDatasetContext;
use ByJG\AnyDataset\Exception\NotImplementedException;
use ByJG\AnyDataset\LogHandler;
use ByJG\AnyDataset\Repository\CachedDBDataset;
use ByJG\AnyDataset\Repository\DBDataset;
use ByJG\AnyDataset\Repository\IteratorInterface;
use ByJG\Cache\CacheEngineInterface;

abstract class BaseDBAccess
{

    /**
     * @var DBDataset
     */
    protected $_db = null;
    protected $_cachedDb = null;

    /**
     * Wrapper for SQLHelper
     *
     * @var SQLHelper
     */
    protected $_sqlhelper = null;

    /**
     * Base Class Constructor. Don't must be override.
     *
     */
    public function __construct()
    {
        // Nothing Here
    }

    /**
     * This method must be overrided and the return must be a valid DBDataset name.
     *
     * @return string
     */
    public abstract function getDataBaseName();

The abstract declaration must precede the visibility declaration

    /**
     * @return CacheEngineInterface
     * @throws NotImplementedException
     */
    public function getCacheEngine()
    {
        throw new NotImplementedException('You have to implement the cache engine in order to use the Cache');
    }

    /**
     * Create a instance of DBDataset to connect database
     * @param bool $cache
     * @return DBDataset
     * @throws NotImplementedException
     */
    protected function getDBDataset($cache = false)
    {
        if (is_null($this->_db)) {
            $this->_db = new DBDataset($this->getDataBaseName());
        }

        if ($cache === true) {

            if (is_null($this->_cachedDb)) {
                $this->_cachedDb = new CachedDBDataset($this->_db, $this->getCacheEngine());
            }

            return $this->_cachedDb;
        }

        return $this->_db;
    }

    /**
     * Execute a SQL and dont wait for a response.
     * @param string $sql
     * @param string $param
     * @param bool $getId
     * @return int|null
     */
    protected function executeSQL($sql, $param = null, $getId = false)
    {
        $dbfunction = $this->getDbFunctions();

        $debug = AnyDatasetContext::getInstance()->getDebug();
        $start = 0;
        if ($debug) {
            $log = LogHandler::getInstance();
            $log->debug("Class name: " . get_class($this));
            $log->debug("SQL: " . $sql);
            if (!is_null($param)) {
                $s = "";
                foreach ($param as $key => $value) {
                    if ($s != "") {
                        $s .= ", ";
                    }
                    $s .= "[$key]=$value";
                }
                $log->debug("Params: $s");
            }
            $start = microtime(true);
        }

        if ($getId) {
            $id = $dbfunction->executeAndGetInsertedId($this->getDBDataset(), $sql, $param);
        } else {
            $id = null;
            $this->getDBDataset()->execSQL($sql, $param);
        }

        if ($debug) {
            $end = microtime(true);
            $log->debug("Execution time: " . ($end - $start) . " seconds ");
        }

        return $id;
    }

    /**
     * Execulte SELECT SQL Query
     *
     * @param string $sql
     * @param array $param
     * @param int $ttl
     * @return IteratorInterface
     */
    protected function getIterator($sql, $param = null, $ttl = -1)
    {
        $db = $this->getDBDataset($ttl > 0);

        $debug = AnyDatasetContext::getInstance()->getDebug();
        $start = 0;
        if ($debug) {
            $log = LogHandler::getInstance();
            $log->debug("Class name: " . get_class($this));
            $log->debug("SQL: " . $sql);
            if (!is_null($param)) {
                $s = "";
                foreach ($param as $key => $value) {
                    if ($s != "") {
                        $s .= ", ";
                    }
                    $s .= "[$key]=$value";
                }
                $log->debug("Params: $s");
            }
            $start = microtime(true);
        }
        $it = $db->getIterator($sql, $param, $ttl);
        if ($debug) {
            $end = microtime(true);
            $log->debug("Execution Time: " . ($end - $start) . " segundos ");
        }
        return $it;
    }

    protected function getScalar($sql, $param = null)
    {
        $this->getDBDataset();

        $debug = AnyDatasetContext::getInstance()->getDebug();
        $start = 0;
        if ($debug) {
            $log = LogHandler::getInstance();
            $log->debug("Class name: " . get_class($this));
            $log->debug("SQL: " . $sql);
            if (!is_null($param)) {
                $s = "";
                foreach ($param as $key => $value) {
                    if ($s != "") {
                        $s .= ", ";
                    }
                    $s .= "[$key]=$value";
                }
                $log->debug("Params: $s");
            }
            $start = microtime(true);
        }
        $scalar = $this->_db->getScalar($sql, $param);
        if ($debug) {
            $end = microtime(true);
            $log->debug("Execution Time: " . ($end - $start) . " segundos ");
        }
        return $scalar;
    }

    /**
     * Get a SQLHelper object
     *
     * @return SQLHelper
     */
    public function getSQLHelper()
    {
        $this->getDBDataset();

        if (is_null($this->_sqlhelper)) {
            $this->_sqlhelper = new SQLHelper($this->_db);
        }

        return $this->_sqlhelper;
    }

    /**
     * Get an Interator from an ID. Ideal for get data from PK
     *
     * @param string $tablename
     * @param string $key
     * @param string $value
     * @return IteratorInterface
     */
    protected function getIteratorbyId($tablename, $key, $value)
    {
        $sql = "select * from $tablename where $key = [[$key]] ";
        $param = array();
        $param[$key] = $value;
        return $this->getIterator($sql, $param);
    }

    /**
     * Get an Array from an existing Iterator
     *
     * @param IteratorInterface $it
     * @param string $key
     * @param string $value
     * @param string $firstElement
     * @return array
     */
    public static function getArrayFromIterator(IteratorInterface $it, $key, $value, $firstElement = "-- Selecione --")
    {
        $retArray = array();
        if ($firstElement != "") {
            $retArray[""] = $firstElement;
        }
        while ($it->hasNext()) {
            $sr = $it->moveNext();
            $retArray[$sr->getField(strtolower($key))] = $sr->getField(strtolower($value));
        }
        return $retArray;
    }

    /**
     *
     * @param IteratorInterface $it
     * @param string $name
     * @param array $fields
     * @param bool $echoToBrowser
     * @return string
     */
    public static function saveToCSV($it, $name = "data.csv", $fields = null, $echoToBrowser = true)
    {
        if ($echoToBrowser) {
            ob_clean();

            header("Content-Type: text/csv;");
            header("Content-Disposition: attachment; filename=$name");
        }

        $first = true;
        $line = "";
        foreach ($it as $sr) {
            if ($first) {
                $first = false;

                if (is_null($fields)) {
                    $fields = $sr->getFieldNames();
                }

                $line .= '"' . implode('","', $fields) . '"' . "\n";
            }

            $raw = array();
            foreach ($fields as $field) {
                $raw[] = $sr->getField($field);
            }
            $line .= '"' . implode('","', array_values($raw)) . '"' . "\n";

            if ($echoToBrowser) {
                echo $line;
                $line = "";
            }
        }

        if (!$echoToBrowser) {
            return $line;
        }
        
        return null;
    }

    /**
     * Get a IDbFunctions class containing specific database operations
     * @return DBFunctionsInterface
     */
    public function getDbFunctions()
    {
        return $this->getDBDataset()->getDbFunctions();
    }

    public function beginTransaction()
    {
        $this->getDBDataset()->beginTransaction();
    }

    public function commitTransaction()
    {
        $this->getDBDataset()->commitTransaction();
    }

    public function rollbackTransaction()
    {
        $this->getDBDataset()->rollbackTransaction();
    }

    public function getObjectDbDataSet()
    {
        return $this->_db;
    }

    public function joinTransactionContext(BaseDBAccess $dal)
    {
        if (is_null($dal->getObjectDbDataSet())) {
            throw new \Exception('Transaction not initialized');
        }
        $this->_db = $dal->getObjectDbDataSet();
    }
}