Dolphin\Mapper\Dolphin

Complexity

Total Complexity

56

Size/Duplication

Total Lines	477
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	1

30 Methods

Rating	Name	Duplication	Size	Complexity
A	find()	0	5	1
A	whereNotNull()	0	5	1
A	having()	0	5	1
A	leftJoin()	0	5	1
A	limit()	0	5	1
B	buildQuery()	0	68	9
A	selectRaw()	0	7	1
A	offset()	0	5	1
A	query()	0	19	5
A	insert()	0	4	1
A	orderBy()	0	5	1
A	rightJoin()	0	5	1
A	delete()	0	22	2
A	getFields()	0	11	4
A	whereIn()	0	5	1
A	whereNull()	0	5	1
A	prepare()	0	34	4
A	get()	0	3	1
A	count()	0	7	1
A	select()	0	7	1
A	update()	0	31	3
A	groupBy()	0	5	1
A	reset()	0	19	1
A	truncate()	0	12	2
A	whereNotIn()	0	5	1
A	first()	0	9	2
A	findOrFail()	0	11	2
A	join()	0	5	1
A	where()	0	12	3
A	crossJoin()	0	5	1

<?php
/**
 * The Query builder API.
 *
 * @author RN Kushwaha <rn.kushwaha022@gmail.com>
 * @since v0.0.1 <Date: 12th April, 2019>
 */

namespace Dolphin\Mapper;

use Dolphin\Connections\Connection;
use Dolphin\Builders\QueryBuilder;
use Dolphin\Builders\WhereQueryBuilder;
use Dolphin\Builders\JoinQueryBuilder;
use Dolphin\Builders\InsertQueryBuilder;
use Dolphin\Parsers\WhereQueryParser;
use Dolphin\Utils\Utils;
use \Exception;

/**
 * This class provides some nice features to interact with the Database
 * Elegant Query builder
 * Method Chaining
 * Prepared Statement using named parameter like status = :status
 * Raw Query Option
 * Join Clause
 * Where Clause
 * WhereRaw Clause
 * orWhere Clause [TODO]
 * WhereIn Clause
 * WhereNotIn Clause
 * WhereNull Clause
 * WhereNotNull Clause
 * GroupBy Clause
 * Having Clause
 * OrderBy Clause.
 *
 * Aggregations like
 * Count()
 * Max() [TODO]
 * Min() [TODO]
 * First()
 * Last() [TODO]
 * Avg() [TODO]
 * fetchColumn [TODO]
 * union() [TODO]
 * delete()
 * update()
 * insert()
 * truncate()
 * havingRaw() [TODO]
 * exists() [TODO]
 */
class Dolphin
{
    protected $fields = array();
    public $table;
    public $className;
    protected $groupBy;
    protected $orderBy;
    protected $having;
    protected $join = array();
    protected $leftJoin = array();
    protected $rightJoin = array();
    protected $crossJoin = array();
    protected $where = array();
    protected $whereIn = array();
    protected $whereNotIn = array();
    protected $whereNull = array();
    protected $whereNotNull = array();
    protected $limit;
    protected $offset;
    protected $results;

    private function getFields(array $args, bool $quote = true){
        $fldAr = array();
        $qb = new QueryBuilder();

        foreach ($args as $arg) {
            foreach (explode(',', $arg) as $ar) {
                $fldAr[] = ($quote === true) ? $qb->quote(trim($ar)) : trim($ar);
            }
        }

        return $fldAr;
    }

    public function select()
    {
        $args = func_get_args();
        $fldAr = $this->getFields($args, true);
        $this->fields = array_merge($this->fields, $fldAr);

        return $this;
    }

    public function selectRaw()
    {
        $args = func_get_args();
        $fldAr = $fldAr = $this->getFields($args, false);

The assignment to $fldAr is dead and can be removed.

        $this->fields = array_merge($this->fields, $fldAr);

        return $this;
    }

    public function join($join, $mixedParam, $param3 = null, $param4 = null, $mixedParam2 = null)
    {
        $this->join = array_merge($this->join, [[$join, $mixedParam, $param3, $param4, $mixedParam2]]);

        return $this;
    }

    public function leftJoin($leftJoin, $mixedParam, $param3 = null, $param4 = null, $mixedParam2 = null)
    {
        $this->leftJoin = array_merge($this->leftJoin, [[$leftJoin, $mixedParam, $param3, $param4, $mixedParam2]]);

        return $this;
    }

    public function rightJoin($rightJoin, $mixedParam, $param3 = null, $param4 = null, $mixedParam2 = null)
    {
        $this->rightJoin = array_merge($this->rightJoin, [[$rightJoin, $mixedParam, $param3, $param4, $mixedParam2]]);

        return $this;
    }

    public function crossJoin($crossJoin, $params = null)
    {
        $this->crossJoin = array_merge($this->crossJoin, [[$crossJoin, $params]]);

        return $this;
    }

    /**
     * @throws Exception
     */
    public function where()
    {
        $args = func_get_args();
        if(func_num_args()===2){
            $this->where = array_merge($this->where, [[$args[0], '=', $args[1]]]);
            return $this;
        } elseif(func_num_args()===3){
            $this->where = array_merge($this->where, [[$args[0], $args[1], $args[2]]]);
            return $this;
        }

        throw new Exception('Where parameter contains invalid number of parameters', 1);
    }

    public function whereIn($whereIn, $params = array())
    {
        $this->whereIn = array_merge($this->whereIn, [[$whereIn, $params]]);

        return $this;
    }

    public function whereNotIn($whereNotIn, $params = array())
    {
        $this->whereNotIn = array_merge($this->whereNotIn, [[$whereNotIn, $params]]);

        return $this;
    }

    public function whereNull($whereNull)
    {
        $this->whereNull = array_merge($this->whereNull, [$whereNull]);

        return $this;
    }

    public function whereNotNull($whereNotNull)
    {
        $this->whereNotNull = array_merge($this->whereNotNull, [$whereNotNull]);

        return $this;
    }

    public function offset($offset)
    {
        $this->offset = $offset;

        return $this;
    }

    public function limit($limit)
    {
        $this->limit = $limit;

        return $this;
    }

    public function orderBy($orderBy)
    {
        $this->orderBy = $orderBy;

        return $this;
    }

    public function groupBy($groupBy)
    {
        $this->groupBy = $groupBy;

        return $this;
    }

    public function having($having)
    {
        $this->having = $having;

        return $this;
    }

    /**
     * Builds Query added by method chaining.
     * It has the main logic of ORM
     */
    protected function buildQuery()
    {
        $tblWithPrefix = $this->table;
        $qb     = new QueryBuilder();
        $jqb    = new JoinQueryBuilder();
        $wqb    = new WhereQueryBuilder();
        $prefix = $qb->getPrefix();
        $tbl    = str_replace($prefix, '', $tblWithPrefix);
        $query  = [];

        $query[] = 'SELECT';
        $startQuery = join(', ', $this->fields);
        if (empty($this->fields)) {
            $startQuery = $qb->quote($tbl).'.*';
        }
        
        $query[] = $startQuery;
        $query[] = 'FROM';
        $query[] = $qb->quote($tblWithPrefix).' AS '.$qb->quote($tbl);

        $allJoinQuery = $jqb->buildAllJoinQuery(
                                $this->join, 
                                $this->leftJoin, 
                                $this->rightJoin, 
                                $this->crossJoin
                            );
        if (count($allJoinQuery)) {
            $query = array_merge($query, $allJoinQuery);
        }

        $allWhereQuery = $wqb->buildAllWhereQuery(
                                    $this->where, 
                                    $this->whereIn, 
                                    $this->whereNotIn, 
                                    $this->whereNull, 
                                    $this->whereNotNull
                                );

        if (count($allWhereQuery)) {
            $query = array_merge($query, $allWhereQuery);
        }

        if (!empty($this->groupBy)) {
            $query[] = 'GROUP BY';
            $query[] = $this->groupBy;
        }

        if (!empty($this->having)) {
            $query[] = 'HAVING';
            $query[] = $this->having;
        }

        if (!empty($this->orderBy)) {
            $query[] = 'ORDER BY';
            $query[] = $this->orderBy;
        }

        if (!empty($this->limit)) {
            $query[] = 'LIMIT';

            if (!empty($this->offset)) {
                $query[] = $this->offset.',';
            }

            $query[] = $this->limit;
        }

        return join(' ', $query);
    }

    protected function reset()
    {
        $this->fields = array();
        $this->table = null;
        $this->className = null;
        $this->groupBy = null;
        $this->orderBy = null;
        $this->having = null;
        $this->join = array();
        $this->leftJoin = array();
        $this->rightJoin = array();
        $this->crossJoin = array();
        $this->where = array();
        $this->whereIn = array();
        $this->whereNotIn = array();
        $this->whereNull = array();
        $this->whereNotNull = array();
        $this->limit = null;
        $this->offset = null;
    }

    public function prepare($query, $fetchRows = 'all')
    {
        $qb   = new QueryBuilder();
        $wqp  = new WhereQueryParser();
        $util = new Utils();
        
        try {
            $ar = $wqp->parseWhereQuery($this->where);
            $stmt = Connection::get()->prepare($qb->queryPrefix($query));
            $stmt->execute($ar);

            if ($fetchRows == 'first') {
                $rows = $stmt->fetch(\PDO::FETCH_OBJ);
                $this->results = $rows;
                // now turn this stdClass object to the object type of calling model
                $rows = $util->turnObject($this->className, $rows);
                // Reset class variables
                $this->reset();

                return $rows;
            }

            $rows = $stmt->fetchAll(\PDO::FETCH_ASSOC);
            $this->results = $rows;
            $rows = $util->turnObjects($this->className, $rows);

            // Reset class variables
            $this->reset();

            return $rows;
        } catch (\PDOException $ex) {
            throw new \PDOException($ex->getMessage(), 1);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), 1);
        }
    }

    public function query($query, $fetchRows = 'all')
    {
        $qb = new QueryBuilder();

        try {
            $obj = Connection::get()->query($qb->queryPrefix($query), \PDO::FETCH_OBJ);

            if ($fetchRows == 'count') {
                $data = $obj->fetchColumn();
            }

            // Reset class variables
            $this->reset();

            return isset($data) ? $data : $obj;
        } catch (\PDOException $ex) {
            throw new \PDOException($ex->getMessage(), 1);
        } catch (Exception $e) {
            throw new Exception($e->getMessage(), 1);
        }
    }

    public function get()
    {
        return $this->prepare($this->buildQuery());
    }

    public function first()
    {
        $query = $this->buildQuery();

        if (!strripos($query, 'LIMIT 1')) {
            $query .= ' LIMIT 1';
        }

        return $this->prepare($query, 'first');
    }

    /**
     * It fetches the row by primary key
     * 
     * @since v0.0.5 
     */
    public function find($id)
    {
        $this->where('id = :id', $id);
        
        return $this->first();
    }

    /**
     * It fetches the row by primary key
     * 
     * @param int $id
     * @return object $row
     * @throws Exception
     * @since v0.0.5 
     */
    public function findOrFail($id)
    {
        $this->where('id = :id', $id);
        
        $row = $this->first();

        if($row == null ){
            throw new Exception("The record does not exists!");
        }

        return $row;
    }

    public function count()
    {
        $this->fields = null;
        $query = $this->buildQuery();
        $query = str_replace('SELECT * ', 'SELECT COUNT(*) as count ', $query);

        return $this->query($query, 'count');
    }

    /**
     * It truncates the table
     * 
     * @return boolean
     * @throws Exception
     * @since v0.0.5 
     */
    public function truncate()
    {
        $qb = new QueryBuilder();
        $query = "TRUNCATE ".$this->table;
        
        try{
            Connection::get()->query($qb->queryPrefix($query));
        } catch(Exception $e){
            throw new Exception($e->getMessage());
        }

        return true;
    }

    /**
     * It inserts the new rows
     * 
     * @param array $rows
     * @return integer $lastInsertedId
     * @throws Exception
     * @since v0.0.5 
     */
    public function insert($rows)
    {
        $iqb = new InsertQueryBuilder();
        return $iqb->insert($rows, $this->table);
    }

    /**
     * It updates the rows
     * 
     * @param array $row
     * @return boolean
     * @throws Exception
     * @since v0.0.5 
     */
    public function update($row)
    {
        $qb    = new QueryBuilder();
        $wqb   = new WhereQueryBuilder();
        $query = "UPDATE ".$this->table." SET ";
        $ar    = array();
        
        foreach($row as $key => $val){
            $ar[':'.$key] = $val;
            $query.= $qb->quote($key)." =:".$key.",";
        }

        $query = rtrim($query, ",");
        
        try{
            $whereQuery = $wqb->buildAllWhereQuery(
                                $this->where, 
                                $this->whereIn, 
                                $this->whereNotIn, 
                                $this->whereNull, 
                                $this->whereNotNull
                            );
            $query.= " ".join(" ", $whereQuery);
            $stmt = Connection::get()->prepare($qb->queryPrefix($query));
            $stmt->execute($ar);
            $this->reset();
        } catch(Exception $e){
            throw new Exception($e->getMessage());
        }

        return true;
    }

    /**
     * It deleted the rows matched by where clause
     * 
     * @return boolean
     * @throws Exception
     * @since v0.0.5 
     */
    public function delete()
    {
        $qb = new QueryBuilder();
        $wqb = new WhereQueryBuilder();
        $query = "DELETE FROM ".$this->table;
        
        try{
            $whereQuery = $wqb->buildAllWhereQuery(
                                    $this->where, 
                                    $this->whereIn, 
                                    $this->whereNotIn, 
                                    $this->whereNull, 
                                    $this->whereNotNull
                                );
            $query.= " ".join(" ", $whereQuery);
            Connection::get()->query($qb->queryPrefix($query));
            $this->reset();
        } catch(Exception $e){
            throw new Exception($e->getMessage());
        }

        return true;
    }

}