DatalayerTrait::setLogSQL() - Code Metrics - Inspection of "correcao" - brunobmorais/php-database - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( 8cd2b3...6b394b )

by BRUNO
created 2023-11-19 13:21 UTC
DatalayerTrait::setLogSQL() B

↳ Parent: DatalayerTrait
Complexity

Conditions	10
Paths	2
Size

Total Lines	30
Code Lines	21
Duplication

Lines	0
Ratio	0 %
Importance

Changes	4
Bugs	0	Features	0
Metric	Value
cc	10
eloc	21
c	4
b	0
f	0
nc	2
nop	2
dl	0
loc	30
rs	7.6666
How to fix Complexity

<?php
namespace BMorais\Database;

/**
 * CLASS TRAIT DATALAYER
 * This class of execution methods in the database
 *
 * @author Bruno Morais <[email protected]>
 * @copyright MIT, bmorais.com
 * @package bmorais\database
 * @subpackage class
 * @access private
 */
use PDO;
use PDOException;
use PDOStatement;
use stdClass;

trait DatalayerTrait
{
    /** @var PDO|null
     * @deprecated
     * */
    protected $instance = null;

    /** @var string
     *  @deprecated
     */
    protected string $fields;

    /** @var PDOStatement|null
     *   @deprecated */
    protected $prepare = null;

    /** @var string
     *  @deprecated
     */
    protected $database = CONFIG_DATA_LAYER["dbname"];

    /** @var string
     *  @deprecated
     */
    protected $classModel;

    /** @var string
     * @deprecated
     */
    protected $tableName;

    /** @var string */
    private $tableAlias;

    /** @var array
     * @deprecated
     */
    protected $resultArray = array();

    /** @var string */
    private $logSQL;

    /** @var PDOException */
    private $error;

    /** @var string */
    private string $query = "";

    /** @var array */
    private array $params = [];


    /** @return PDO|false */
    private function getInstance()
    {
        try {
            if (strpos($_SERVER['SERVER_NAME'], mb_strtolower(CONFIG_DATA_LAYER["homologation"])) && !strpos($this->getDatabase(), ucfirst(CONFIG_DATA_LAYER["homologation"]))) {
                $database = $this->getDatabase().ucfirst(CONFIG_DATA_LAYER["homologation"] ?? "");
                $this->setDatabase($database);
            }

            if (empty($this->getInstance())) {
                $instance = new PDO(
                    CONFIG_DATA_LAYER['driver'] . ':host=' . CONFIG_DATA_LAYER['host'] . ';dbname=' . $this->getDatabase() . ';port=' . CONFIG_DATA_LAYER['port'],
                    CONFIG_DATA_LAYER['username'],
                    CONFIG_DATA_LAYER['passwd'],
                    CONFIG_DATA_LAYER['options']
                );
                $this->setInstance($instance);
            }

            return $this->getInstance();
        } catch (PDOException $e) {
            $this->setError($e);
        }

    }

    /**
     * @param ?PDO $pdo
     * @return Crud
     *
     */
    protected function setInstance(?PDO $pdo): self
    {
        $this->instance = $pdo;
        /** @scrutinizer ignore-deprecated */ $this->instance = $pdo;
        return $this;
    }

    /**
     * @param string $database
     * @return $this
     */
    protected function setDatabase(string $database): self
    {
        $this->database = $database;
        /** @scrutinizer ignore-deprecated */ $this->database = $database;
        $this->setInstance(null);
        return $this;
    }

    /**
     * @return string
     */
    protected function getDatabase(): string
    {
        return $this->database ?? "";
        return /** @scrutinizer ignore-deprecated */ $this->database ?? "";
    }

    /**
     * @param string $fields
     * @return Crud
     */
    protected function setFields(string $fields): self
    {
        $this->fields = $fields;
        /** @scrutinizer ignore-deprecated */ $this->fields = $fields;
        return $this;
    }

    /**
     * @return string
     */
    protected function getFields():string
    {
        return $this->fields;
        return /** @scrutinizer ignore-deprecated */ $this->fields;
    }

    /**
        * @param string $tableName
        * @param string $tableAlias
        * @return CrudBuilder|Crud|DatalayerTrait
     */
    protected function setTable(string $tableName, string $tableAlias = ""): self
    {
        if (!empty($tableAlias))
            $this->tableAlias = $tableAlias;
        $this->tableName = $tableName;
        /** @scrutinizer ignore-deprecated */ $this->tableName = $tableName;
        return $this;
    }

    /**
     * @return string
     */
    protected function getTable(): string
    {
        return $this->tableName ?? "";
        return /** @scrutinizer ignore-deprecated */ $this->tableName ?? "";
    }

    protected function getTableAlias(): string
    {
        return $this->tableAlias ?? "";
    }

    /**
     * @param string $classModel
     * @return Crud
     */
    protected function setClassModel(string $classModel): self
    {
        $this->classModel = $classModel;
        /** @scrutinizer ignore-deprecated */ $this->classModel = $classModel;
        return $this;
    }

    protected function getClassModel(): string
    {
        return $this->classModel;
        return /** @scrutinizer ignore-deprecated */ $this->classModel;
    }

    /**
     * @param string $classModel
     * @return Crud
     */
    protected function setPrepare(PDOStatement $prepare): self
    {
        $this->prepare = $prepare;
        /** @scrutinizer ignore-deprecated */ $this->prepare = $prepare;
        return $this;
    }

    protected function getPrepare(): PDOStatement
    {
        return $this->prepare;
        return /** @scrutinizer ignore-deprecated */ $this->prepare;
    }

    /**
        * @param string $query
        * @param array|null $params
        * @return PDOStatement|void
     */
    protected function executeSQL(string $query, ?array $params = null)
    {
        try {
            $this->setPrepare($this->getInstance()->prepare($query));
            $this->setLogSQL($query, $params);
            $this->getPrepare()->execute($params);
            return $this->getPrepare();
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @return int|false
     */
    protected function count(PDOStatement $prepare = null): ?int
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            return $prepare->rowCount();
        } catch (PDOException $e) {
            $this->setError($e);}
    }

    /**
     * @param $prepare
     * @return array|false
     */
    protected function fetchArrayAssoc(PDOStatement $prepare = null): ?array
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $dados = $prepare->fetchAll(PDO::FETCH_ASSOC);
            $this->resultArray = $dados;
            /** @scrutinizer ignore-deprecated */ $this->resultArray = $dados;
            return $dados;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @return array|false
     */
    protected function fetchArrayObj(PDOStatement $prepare = null): ?array
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $dados = $prepare->fetchAll(PDO::FETCH_OBJ);
            $this->resultArray = $dados;
            /** @scrutinizer ignore-deprecated */ $this->resultArray = $dados;
            return $dados;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @param String|null $class
     * @return array|false
     */
    protected function fetchArrayClass(PDOStatement $prepare = null, string $class = null): ?array
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $class = empty($class) ? $this->classModel : $class;
            $class = empty($class) ? /** @scrutinizer ignore-deprecated */ $this->classModel : $class;
            $dados = $prepare->fetchAll(PDO::FETCH_CLASS | PDO::FETCH_PROPS_LATE, CONFIG_DATA_LAYER["directory_models"] . $class);
            $this->resultArray = $dados;
            /** @scrutinizer ignore-deprecated */ $this->resultArray = $dados;
            return $dados;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @return array|false
     */
    protected function fetchOneAssoc(PDOStatement $prepare = null): ?array
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $dados = $prepare->fetch(PDO::FETCH_ASSOC);
            return $dados;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @return stdClass|false
     */
    protected function fetchOneObj(PDOStatement $prepare = null): ?stdClass
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $dados = $prepare->fetch(PDO::FETCH_OBJ);
            return $dados;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $prepare
     * @param String|null $class
     * @return array|false
     */
    protected function fetchOneClass(PDOStatement $prepare = null, string $class = null): ?object
    {
        try {
            $prepare = empty($prepare) ? $this->getPrepare() : $prepare;
            $class = empty($class) ? $this->classModel : $class;
            $class = empty($class) ? /** @scrutinizer ignore-deprecated */ $this->classModel : $class;
            return $prepare->fetchObject(CONFIG_DATA_LAYER["directory_models"] . $class);
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @return bool
     */
    protected function beginTrasaction(): ?bool
    {
        try {
            $this->getInstance()->beginTransaction();
            return true;
        } catch (PDOException $e) {
            $this->setError($e);
        }

    }

    /**
     * @return bool|null
     */
    protected function commitTransaction(): ?bool
    {
        try {
            $this->getInstance()->commit();
            return true;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @return bool|null
     *
     */
    protected function rollBackTransaction(): ?bool
    {

        try {
            $this->getInstance()->rollBack();
            return true;
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     *  @return string|null
     *  */
    private function lastId(): ?string
    {
        try {
            return $this->getInstance()->lastInsertId();
        } catch (PDOException $e) {
            $this->setError($e);
        }
    }

    /**
     * @param $sql_string
     * @param array|null $params
     * @return void
     */
    private function setLogSQL($sql_string, ?array $params = null)
    {
        if (!empty($params)) {
            $indexed = $params == array_values($params);
            foreach ($params as $k => $v) {
                if (is_object($v)) {
                    if ($v instanceof \DateTime) {
                        $v = $v->format('Y-m-d H:i:s');
                    } else {
                        continue;
                    }
                } elseif (is_string($v)) {
                    $v = "'$v'";
                } elseif ($v === null) {
                    $v = 'NULL';
                } elseif (is_array($v)) {
                    $v = implode(',', $v);
                }

                if ($indexed) {
                    $sql_string = preg_replace('/\?/', $v, $sql_string, 1);
                } else {
                    if ($k[0] != ':') {
                        $k = ':' . $k;
                    } //add leading colon if it was left out
                    $sql_string = str_replace($k, $v, $sql_string);
                }
            }
        }
        $this->logSQL = $sql_string;
    }

    /**
     * @param PDOException $e
     * @return void
     */
    private function setError(PDOException $e)
    {
        $this->error = $e;
        throw new PDOException("{$e->getMessage()}<br/><b>SQL:</b> {$this->getSQL()}");
        throw new PDOException("{$e->getMessage()}<br/><b>SQL:</b> {$this->/** @scrutinizer ignore-call */ getSQL()}");

    }
}

brunobmorais / php-database

Push — main ( 8cd2b3...6b394b )

DatalayerTrait::setLogSQL() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like
