Database.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\db;
 
use Ubiquity\exceptions\CacheException;
use Ubiquity\db\traits\DatabaseOperationsTrait;
use Ubiquity\exceptions\DBException;
use Ubiquity\db\traits\DatabaseTransactionsTrait;
use Ubiquity\controllers\Startup;
use Ubiquity\db\traits\DatabaseMetadatas;
use Ubiquity\cache\database\DbCache;
 
class Database  extends  DatabaseOperationsTrait,DatabaseTransactionsTrait,DatabaseMetadatas  {
    
    public static $wrappers = [ 'pdo' => \Ubiquity\db\providers\pdo\PDOWrapper::class,'tarantool' => '\Ubiquity\db\providers\tarantool\TarantoolWrapper','mysqli' => '\Ubiquity\db\providers\mysqli\MysqliWrapper','swoole' => '\Ubiquity\db\providers\swoole\SwooleWrapper' ];
    private $dbType;
    private $serverName;
    private $port;
    private $dbName;
    private $user;
    private $password;
    private $cache;
    private $options;
    public $quote;
 
    protected $wrapperObject;
 
    public function __construct($dbWrapperClass, $dbType, $dbName, $serverName = "127.0.0.1", $port = "3306", $user = "root", $password = "", $options = [ ], $cache = false, $pool = null) {
        $this->setDbWrapperClass ( $dbWrapperClass, $dbType );
        $this->dbName = $dbName;
        $this->serverName = $serverName;
        $this->port = $port;
        $this->user = $user;
        $this->password = $password;
        $this->options = $options;
        if ($cache !== false) {
            if ($cache instanceof \Closure) {
                $this->cache = $cache ();
            } else {
                if (\class_exists ( $cache )) {
                    $this->cache = new $cache ();
                } else {
                    throw new CacheException ( $cache . " is not a valid value for database cache" );
                }
            }
        }
        if ($pool && (\method_exists ( $this->wrapperObject, 'pool' ))) {
            $this->wrapperObject->setPool ( $pool );
        }
    }
 
    private function setDbWrapperClass($dbWrapperClass, $dbType) {
        $this->wrapperObject = new $dbWrapperClass ( $this->dbType = $dbType );
    }
 
    public function connect() {
        try {
            $this->_connect ();
            $this->quote = $this->wrapperObject->quote;
            return true;
        } catch ( \Exception $e ) {
            throw new DBException ( $e->getMessage (), $e->getCode (), $e->getPrevious () );
        }
    }
 
    public function getDSN() {
        return $this->wrapperObject->getDSN ( $this->serverName, $this->port, $this->dbName, $this->dbType );
    }
 
    public function getServerName() {
        return $this->serverName;
    }
 
    public function setServerName($serverName) {
        $this->serverName = $serverName;
    }
 
    public function setDbType($dbType) {
        $this->dbType = $dbType;
        return $this;
    }
 
    public function getPort() {
        return $this->port;
    }
 
    public function getDbName() {
        return $this->dbName;
    }
 
    public function getUser() {
        return $this->user;
    }
 
    public static function getAvailableDrivers($dbWrapperClass = \Ubiquity\db\providers\pdo\PDOWrapper::class) {
        return \call_user_func ( $dbWrapperClass . '::getAvailableDrivers' );
    }
 
    public function getDbType() {
        return $this->dbType;
    }
 
    public function getPassword() {
        return $this->password;
    }
 
    public function getOptions() {
        return $this->options;
    }
 
    public function setPort($port) {
        $this->port = $port;
    }
 
    public function setDbName($dbName) {
        $this->dbName = $dbName;
    }
 
    public function setUser($user) {
        $this->user = $user;
    }
 
    public function setPassword($password) {
        $this->password = $password;
    }
 
    public function setOptions($options) {
        $this->options = $options;
    }
 
    public function close() {
        $this->wrapperObject->close ();
    }
 
    public static function start(string $offset = null, ?array $config = null): ?self {
        $config ??= Startup::$config;
        $db = $offset ? ($config ['database'] [$offset] ?? ($config ['database'] ?? [ ])) : ($config ['database'] ?? [ ]);
        if ($db ['dbName'] !== '') {
            $database = new Database ( $db ['wrapper'] ?? \Ubiquity\db\providers\pdo\PDOWrapper::class, $db ['type'], $db ['dbName'], $db ['serverName'] ?? '127.0.0.1', $db ['port'] ?? 3306, $db ['user'] ?? 'root', $db ['password'] ?? '', $db ['options'] ?? [ ], $db ['cache'] ?? false);
            $database->connect ();
            return $database;
        }
        return null;
    }
 
    public function quoteValue($value, $type = 2) {
        return $this->wrapperObject->quoteValue ( ( string ) $value, $type );
    }
 
    public function getUpdateFieldsKeyAndValues($keyAndValues, $fields) {
        $ret = array ();
        foreach ( $fields as $field ) {
            $ret [] = $this->quote . $field . $this->quote . ' = ' . $this->quoteValue ( $keyAndValues [$field] );
        }
        return \implode ( ',', $ret );
    }
 
    public function getInsertValues($keyAndValues) {
        $ret = array ();
        foreach ( $keyAndValues as $value ) {
            $ret [] = $this->quoteValue ( $value );
        }
        return \implode ( ',', $ret );
    }
 
    public function getCondition(array $keyValues, $separator = ' AND ') {
        $retArray = array ();
        foreach ( $keyValues as $key => $value ) {
            $retArray [] = $this->quote . $key . $this->quote . " = " . $this->quoteValue ( $value );
        }
        return \implode ( $separator, $retArray );
    }
 
    public function pool() {
        return $this->wrapperObject->pool ();
    }
 
    public function freePool($db) {
        $this->wrapperObject->freePool ( $db );
    }
 
    public function setPool($pool) {
        $this->wrapperObject->setPool ( $pool );
    }
 
    public static function getAvailableWrappers() {
        $wrappers = [ ];
        foreach ( self::$wrappers as $k => $wrapper ) {
            if (\class_exists ( $wrapper, true )) {
                $wrappers [$k] = $wrapper;
            }
        }
        return $wrappers;
    }
 
    public function getSpecificSQL($key, ?array $params = null) {
        switch ($key) {
            case 'groupconcat' :
                return $this->wrapperObject->groupConcat ( $params [0], $params [1] ?? ',');
            case 'tostring' :
                return $this->wrapperObject->toStringOperator ();
        }
    }
 
    public function setCacheInstance(DbCache $cache) {
        $this->cache = $cache;
    }
 
    public function getCacheInstance() {
        return $this->cache;
    }
}