maikees / moc-orm

lib/Model.php

<?php

namespace MocOrm\Model;

use MocOrm\Connection\ConnectionManager;
use MocOrm\Support\Log;

abstract class Model extends Query implements \JsonSerializable
{
    /**
     * @var Model $_instance Save current instance
     */
    private static $_instance;

    /**
     * @var \MocOrm\Connection\Connection $Connection Save connection instance
     */
    private $Connection;

    /**
     *  @var array|boolean $_data Save data on object
     */
    private $_data = [];

    /**
     *  @var array|boolean $_newData Set attributes for update
     */
    private $_newData = [];

    /**
     *  @var \Closure $triggerAfter Actived trigger after
     */
    private $triggerAfter = null;

    /**
     *  @var \Closure $triggerBefore Actived trigger after
     */
    private $triggerBefore = null;

    /**
     *  @var array $_current_custom_query_values Save the value to custom query
     */
    protected $_current_custom_query_values = [];

    private $Result;

    protected static $table_name;
    protected static $primary_key;

    /**
     * Model constructor.
     * set connection in var and set this instance in var for interator
     * @param array|null $array
     * @throws \Exception
     */
    public function __construct($array = null)
    {
        $methods = get_class_methods(get_called_class());

        try {
            $this->Connection = ConnectionManager::initialize()->current();
            self::$_instance = $this;

            $this->cleanNewData();

            if (in_array('onLoad', $methods)) {
                $this->/** @scrutinizer ignore-call */onLoad();
            }

            if (!is_null($array)) {
                if (!is_array($array)) throw new \InvalidArgumentException('Accept only array from object');

The condition is_array($array) is always true.

                $this->_data = $array;
                $this->_newData = $array;
            }

            $this->Result = new Result();

            if($this->Result && !$this->Result->getResults()) {
                $clone = clone $this;
                $this->Result->setResults($clone);
            }
        } catch (\Exception $e) {
            throw $e;
        }
    }

    /**
     * Using if call isset on attributes
     * @param $name
     * @return bool
     */
    public function __isset($name)
    {
        return key_exists($name, $this->_data);

It seems like $this->_data can also be of type boolean; however, parameter $search of key_exists() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * Get value on array data
     * @param String $name
     * @return \MocOrm\Model\Error|mixed
     */
    public function __get($name)
    {
        if (strtolower($name) == 'errors') return Error::instance();

        if (!key_exists($name, $this->_data)) throw new \Exception("The attribute $name not found.");

It seems like $this->_data can also be of type boolean; however, parameter $search of key_exists() does only seem to accept array, maybe add an additional type check?

        return $this->_data[$name];
    }

    /**
     * This set values in attribute data and newData
     * @param $name
     * @param $value
     */
    public function __set($name, $value)
    {
        $this->_newData[$name] = $value;
        $this->_data[$name] = $value;
    }

    /**
     * @return array|boolean Save for info in debug only attributes in _data
     */
    public function __debugInfo()
    {
        return $this->_data;
    }

    /**
     * @param $name
     */
    public function __unset($name)
    {
        unset($this->_data[$name]);
        unset($this->_newData[$name]);
    }

    public function __clone()
    {
        unset($this->_data[static::$primary_key]);
        $this->_newData = $this->_data;
    }

    /**
     * Insert the new data in database not static mode.
     * @param array $attributes Parameters, this is a mirror on database.
     * @return bool|Model False if not save in databse, and this instance if save.
     * @throws \Exception If the parameters isn't one array.
     */
    public function save()
    {
        try {
            $this->verifyConnection();
        } catch (\Exception $e) {
            throw $e;
        }

        $update = false;

        $key = static::$primary_key;
        $_tableName = static::$table_name;

        $repeat = substr(str_repeat(' ?, ', count($this->_newData)), 0, -2);

It seems like $this->_newData can also be of type boolean; however, parameter $var of count() does only seem to accept Countable|array, maybe add an additional type check?

        /**
         * Edit case have primary key value
         */
        if (!empty($this->_data[$key])) {
            $logger = [
              'function' => 'Update',
              'next' => $this->_data,
              'prev' => $this->Result->getResults()
            ];

            $this->saveLogger($logger);
            $this->Result->setResults(clone $this);

            $sql = 'UPDATE ' . $_tableName . ' SET ';

            if (count($this->_newData) <= 0) {
                Error::create('Don\'t have alter data.', 1, 'InvalidArgumentException');
                return false;
            }

            $sql .= implode(" = ?, ", array_keys($this->_newData)) . ' = ?';

It seems like $this->_newData can also be of type boolean; however, parameter $input of array_keys() does only seem to accept array, maybe add an additional type check?

            $sql .= " WHERE $key = ? ";

            $this->_newData[] = $this->{$key};

            $update = true;
        } else {
            $logger = [
                'function' => 'Save',
                'next' => $this->_data,
            ];

            $this->saveLogger($logger);

            /**
             * Insert case don't have primary key
             */
            $sql = 'INSERT INTO ' . $_tableName;
            $sql .= ' (' . implode(', ', array_keys($this->_data)) . ') ';
            $sql .= " VALUES ";
            $sql .= " ($repeat); ";
        }

        if (is_callable($this->triggerBefore)) ($this->triggerBefore)();

        $start = microtime(true);
        $insert = $this->Connection->getConnection()->prepare($sql);
        $this->burnError($insert);

        $this->_newData = array_map(function ($data) {
            if (is_bool($data) and $data === false) $data = 0;

            return $data;
        }, $this->_newData);

It seems like $this->_newData can also be of type boolean; however, parameter $arr1 of array_map() does only seem to accept array, maybe add an additional type check?

        $insert->execute(array_values($this->_newData));
        $end = microtime(true);
        $this->burnError($insert);

        $this->Connection->setPerformedQuery($insert->queryString, round(($end - $start), 5));

        if (is_callable($this->triggerAfter)) ($this->triggerAfter)();

        if ($update) {
            $this->burnError($insert);

            $this->cleanNewData();
            return true;
        }

        $this->_data[$key] = $this->Connection->getConnection()->lastInsertId();

        if ($insert->rowCount() == 0) {
            throw new \Exception($insert->errorInfo()[2], $insert->errorInfo()[1]);
        }

        return true;
    }

    private function saveLogger($params) {
        $class = get_called_class();

        if (
            $this->Connection->getAppLogger() and
            $class != 'MocOrm\Support\Log'
        ) {

            $log = (new Log)
                ->setNext(@$params['next'])
                ->setName($class)
                ->setFunction($params['function'])
                ->setPrev(@$params['prev']);

            $log->save();
        }
    }


    private function burnError($statment)
    {
        if (!is_null($statment->errorInfo()[1])) throw new \Exception($statment->errorInfo()[2], $statment->errorInfo()[1]);
    }

    /**
     * Delete the register
     * @return bool
     */
    public function delete()
    {
        try {
            $this->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        if (!isset(static::$primary_key)) throw new \Exception('Primary key don\'t set');

        if (!is_numeric($this->{static::$primary_key})) throw new \Exception('Primary key value don\'t is valid');

        $sql = ' DELETE FROM ' . static::$table_name;
        $sql .= ' WHERE ' . static::$primary_key . ' = ? ';

        $instance = self::$_instance;

        if (is_callable($this->triggerBefore)) ($this->triggerBefore)();;

        $start = microtime(true);

        $insert = $instance->Connection->getConnection()->prepare($sql);
        $insert->execute([$this->{static::$primary_key}]);

        $end = microtime(true);

        $instance->Connection->setPerformedQuery($insert->queryString, round(($end - $start), 5));

        if (is_callable($this->triggerAfter)) ($this->triggerAfter)();

        if ($insert->rowCount() > 0) {
            $logger = [
                'function' => 'Delete',
                'prev' => $this->_data,
            ];

            $this->saveLogger($logger);

            return true;
        }
        else{ return false; };
    }

    /**
     * JsonSerializable Interface.
     */
    public function jsonSerialize()
    {
        return $this->_data;
    }

    /**
     * Get all data on database needed table name in Model
     * @throws \Exception Don't set table name in model.
     * @return Model|array|boolean all data in format Object
     */
    public static function all()
    {
        self::instance();

        if (!isset(static::$table_name)) throw new \Exception('Don\'t set table name in model.');

        $currentTable = static::$table_name;

        $instance = self::$_instance;

        try {
            self::$_instance->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        $sql = "SELECT * FROM $currentTable ";

        return $instance->query($sql);

The expression return $instance->query($sql) also could return the type integer which is incompatible with the documented return type boolean|array|MocOrm\Model\Model.

    }

    /**
     * Execute one procedure
     * @param string $procedureName Name of the procedure
     * @param array $param Parameters needed in procedure
     * @return mixed Result on procedure
     * @throws \Exception Case procedureName don't is string or param not is array
     */
    public static function procedure($procedureName, $param = [])
    {
        self::instance();

        if (!is_string($procedureName)) throw new \Exception("Procedure name is invalid.");

The condition is_string($procedureName) is always true.

        if (!is_array($param)) throw new \Exception("Tipo de parâmetros inválidos.");

The condition is_array($param) is always true.

        $currentTable = static::$table_name;

        $instance = self::$_instance;

        try {
            self::$_instance->verifyConnection();
        } catch (\Exception $e) {
            Throw new \Exception($e->getMessage());
        }

        $repeat = substr(str_repeat(' ?, ', count($param)), 0, -2);

        $drivers = $instance->Connection->getDriver();

        switch ($drivers) {
            case 'mysql':
                $sql = "call $currentTable ($repeat)";
                break;
            case 'pgsql':
                $sql = "select $procedureName($repeat)";
                break;
            default:
                throw new \Exception('Don\'t exists implementation on this driver.');
                break;
        }

        $start = microtime(true);
        $consulta = $instance->Connection->getConnection()->prepare($sql);
        $consulta->execute($param);
        $objetos = $consulta->fetchAll(\PDO::FETCH_CLASS, get_class($instance));
        $end = microtime(true);

        $instance->Connection->setPerformedQuery($sql, round(($end - $start), 5));

        return $instance->_data = $objetos;
    }

    /**
     * Insert the new data in database static mode.
     * @param array $attributes Parameters, this is a mirror on database.
     * @return bool|Model False if not save in databse, and this instance if save.
     * @throws \Exception If the parameters isn't one array.
     */
    public static function create($attributes = [])
    {
        self::instance();

        $instance = self::$_instance;

        $instance->_data = $attributes;
        $instance->_newData = $attributes;

        return $instance->save();
    }

    /**
     * Find the data on primary key
     * @param Array|Integer $parameters Value on primary key
     * @return mixed Data or false
     * @throws \Exception if Parameter is invalid
     */
    public static function find($parameters = null)
    {
        self::instance();

        $instance = self::$_instance;

        try {
            $instance->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        if (!is_array($parameters) and !is_numeric($parameters)) throw new \Exception('Invalid parameter type on model ' . get_called_class() . '.');

        $instance->_current_custom_query[] = 'SELECT * FROM ' . static::$table_name . ' ';

        switch ($parameters) {
            case is_numeric($parameters):
                if (!isset(static::$primary_key)) throw new \Exception("Invalid parameter type.");

                $instance->_current_custom_query_values[] = $parameters;
                $instance->_current_custom_query[] = ' WHERE ' . static::$primary_key . ' = ?';

                break;
            case is_array($parameters):
                break;
            default:
                throw new \Exception('Invalid parameter type.');
                break;
        }

        $done = $instance->done();

        if(count($done) > 0) {
            $done = $done[0];

            $clone = clone $done;

            $done->Result->setResults($clone);

            return $done;
        }else {
            return null;
        }
    }

    /**
     * Init the get data dynamic, the last method to use this is done() for execute
     * @param String $colunm This is all colunm from select
     * @return Model|boolean A model if success and false if don't have success
     * @throws \Exception If colunm isn't String
     */
    final public static function select($colunm = '*')
    {
        self::instance();

        try {
            self::$_instance->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        if (!is_string($colunm)) throw new \Exception("Invalid parameter type.");

The condition is_string($colunm) is always true.

        self::$_instance->_current_custom_query[] = "SELECT $colunm FROM " . static::$table_name . ' ';

        if (!isset(static::$primary_key)) throw new \Exception("Invalid parameter type.");

        return self::$_instance;
    }

    /**
     * Get current connection name
     * @return string
     */
    protected function getCurrentConnectionName()
    {
        return $this->Connection->getCurrentConnectionString();
    }

    /**
     * Define the current connection on name
     * @param String $connectionName This is connection name
     * @return Model This from other implementations
     */
    protected function setConnection($connectionName)
    {
        try {
            $this->Connection->setConnection($connectionName);

The call to MocOrm\Connection\Connection::setConnection() has too many arguments starting with $connectionName.

            return $this;
        } catch (\Exception $e) {
            throw new $e;
        }
    }

    /**
     * Execute the query
     * @param String $query The query for execute
     * @return Array|Model|boolean|integer $objects Results on query executed
     */
    protected function query($query, $param = [])
    {
        $this->_data = [];

        $select = trim($query);
        $select = strtolower($select);

        $match = preg_match('/^select|return|^with\srecursive/', $select);

        try {
            $this->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        if (!is_array($param)) throw new \Exception('Tipo de parâmetro inválido.');

        $start = microtime(true);

        $consulta = $this->Connection->getConnection()->prepare($query);
        $this->burnError($consulta);

        $consulta->execute($param);
        $this->burnError($consulta);

        if (!$consulta) {
            $this->_data = false;
            return $this;
        }

        $end = microtime(true);

        if ($match) {
            $this->_data = $objetos = $consulta->fetchAll(\PDO::FETCH_CLASS, get_called_class());
        } else {
            $objetos = $consulta->rowCount();
        }

        $this->Connection->setPerformedQuery($query, round(($end - $start), 5));

        $this->burnError($consulta);

        return $objetos;
    }

    /**
     * Execute the query on static method
     * @param String $query The query for execute
     * @return array $objects Results on query executed
     */
    public static function sql($query, $param = [])
    {
        self::instance();

        try {
            self::$_instance->verifyConnection();
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        }

        if (!is_array($param)) throw new \Exception('Invalid parameter type.');

        self::$_instance->_current_custom_query_values = $param;

        $objetos = self::$_instance->query($query, self::$_instance->_current_custom_query_values);

        self::$_instance->_current_custom_query_values = [];

        self::$_instance->cleanNewData();

        return $objetos;

The expression return $objetos also could return the type integer|MocOrm\Model\Model which is incompatible with the documented return type array.

    }

    /**
     * Get the last execute query from ORM
     * @return string on last query
     */
    final protected function getLastQuery()
    {
        return $this->Connection->getLastPerformedQuery();
    }

    /**
     * Get all execute query from ORM
     * @return Array all query executed
     */
    final protected function getAllPerfomedQuery()
    {
        return $this->Connection->getPerformedQuery();
    }

    /**
     * Execute an closure after insert, update or delete.
     * @param $closure
     * @throws \Exception If colunm isn't a closure
     * @return $this
     */
    final protected function setTriggerAfter($closure = null)
    {
        if (!is_callable($closure)) throw new \Exception('The parameter don\'t is an closure.');

        $this->triggerAfter = $closure;

        return $this;
    }

    /**
     * Execute an closure before insert, update or delete.
     * @param $closure
     * @throws \Exception If colunm isn't a closure
     * @return $this
     */
    final protected function setTriggerBefore($closure = null)
    {
        if (!is_callable($closure)) throw new \Exception('The parameter don\'t is an closure.');

        $this->triggerBefore = $closure;

        return $this;
    }

    /**
     * Change schema on postgres
     * @param String $schema schema name
     * @return $this
     */
    final protected function changeSchema($schema)
    {
        if (!is_string($schema)) throw new \Exception('The parameter don\'t is an String.');

The condition is_string($schema) is always true.

        $this->Connection->changeSchema($schema);
        return $this;
    }

    /**
     * Clean data
     * @return $this
     */
    final protected function cleanNewData()
    {
        $this->_newData = [];
        return $this;
    }

    protected function getData()
    {
        return $this->_data;
    }

    /**
     * Auxiliar method for current instance is set
     * @return $this current class
     */
    final private static function instance()
    {
        $calledClass = get_called_class();

        self::$_instance = new $calledClass();

        return self::$_instance;
    }

    /**
     * @throws \Exception if connection doesn't exists.
     */
    final private function verifyConnection()
    {
        if (is_null($this->Connection->getCurrentConnectionString())) throw new \Exception('Not set connection.');

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

    }

    /**
     * @param String $tableName
     * @return $this
     */
    protected function setTableName($tableName)
    {
        self::$table_name = $tableName;

        return $this;
    }

    /**
     * @param string $primaryKey
     * @return $this
     */
    protected function setPrimaryKey($primaryKey = 'id')
    {
        self::$primary_key = $primaryKey;

        return $this;
    }
}