Ps2alerts\Api\Repository\AbstractEndpointRepository

Complexity

Total Complexity

21

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	17
Bugs	4	Features	11

6 Methods

Rating	Name	Duplication	Size	Complexity
	getTable()	0	1	?
	getPrimaryKey()	0	1	?
	getResultKey()	0	1	?
A	newQuery()	0	9	1
F	read()	0	87	18
A	prepareAndExecuteQuery()	0	13	2

<?php

namespace Ps2alerts\Api\Repository;

use Aura\SqlQuery\AbstractQuery;
use Aura\SqlQuery\QueryFactory;
use Ps2alerts\Api\Contract\DatabaseAwareInterface;
use Ps2alerts\Api\Contract\DatabaseAwareTrait;
use Ps2alerts\Api\Contract\RedisAwareInterface;
use Ps2alerts\Api\Contract\RedisAwareTrait;
use Ps2alerts\Api\Contract\UuidAwareInterface;
use Ps2alerts\Api\Contract\UuidAwareTrait;
use Ps2alerts\Api\QueryObjects\QueryObject;

abstract class AbstractEndpointRepository implements
    DatabaseAwareInterface,
    RedisAwareInterface,
    UuidAwareInterface
{
    use DatabaseAwareTrait;
    use RedisAwareTrait;
    use UuidAwareTrait;

    /**
     * Determines the table that the DB is interfacing with
     *
     * @return string
     */
    abstract public function getTable();

    /**
     * Determines the primary key of the table
     *
     * @return string
     */
    abstract public function getPrimaryKey();

    /**
     * Determines the Result key of the table
     *
     * @return string
     */
    abstract public function getResultKey();

    /**
     * Builds a new query factory ready for use with the QueryObjects
     *
     * @return \Aura\SqlQuery\AbstractQuery
     */
    public function newQuery()
    {
        $factory = new QueryFactory('mysql');

        $query = $factory->newSelect(); // Suspect I'll only ever need this one
        $query->from($this->getTable());

        return $query;
    }

    /**
     * Sets up the resulting query based off properties present in the supplied object.
     *
     * @see \Ps2alerts\Api\QueryObjects\QueryObject
     *
     * @param  \Ps2alerts\Api\QueryObjects\QueryObject $queryObject
     * @return array
     */
    public function read(QueryObject $queryObject)
    {
        $query = $this->newQuery();

        // Setup select statements
        if (! empty($queryObject->getSelects())) {
            $query->cols($queryObject->getSelects());
        } else {
            $query->cols(['*']);
        }

        // Workarounds :-/
        if (! empty($queryObject->getFlags())) {
            if ($queryObject->getFlags() === 'outfitIDs') {
                // Prevent the VS, NC and TR "no outfit" workaround
                $queryObject->addWhere([
                    'col' => 'outfitID',
                    'op' => '>',
                    'value' => 0
                ]);
            }
        }

        // Setup where statements
        if (! empty($queryObject->getWheres())) {
            foreach ($queryObject->getWheres() as $where) {
                $col = $where['col'];

                if ($where['col'] === 'primary') {
                    $col = $this->getPrimaryKey();
                }
                if ($where['col'] === 'result') {
                    $col = $this->getResultKey();
                }

                // Generate a UUID so that any columns that are used multiple
                // times always have unique values. Tiny overhead for the benefit
                $uuid = $this->getUuidDriver()->uuid4()->toString();
                $bind = str_replace('-', '', $col.$uuid);

                $op = (isset($where['op']) ? $where['op'] : '=');

                $query->where("{$col} {$op} :$bind");
                $query->bindValue($bind, $where['value']);
            }
        }

        // Setup where statements
        if (! empty($queryObject->getWhereIns())) {
            foreach ($queryObject->getWhereIns() as $whereIn) {
                $col = $whereIn['col'];

                if ($whereIn['col'] === 'primary') {
                    $col = $this->getPrimaryKey();
                }
                if ($whereIn['col'] === 'result') {
                    $col = $this->getResultKey();
                }

                $query->where("{$col} IN ({$whereIn['value']})");
            }
        }

        // Set up order statement
        if (! empty($queryObject->getOrderBy())) {
            $orderBy = $queryObject->getOrderBy();
            if ($orderBy === 'primary') {
                $orderBy = $this->getPrimaryKey();
            }
            if ($orderBy === 'result') {
                $orderBy = $this->getResultKey();
            }

            $query->orderBy([

The method orderBy() does not exist on Aura\SqlQuery\AbstractQuery. Did you maybe mean addOrderBy()?

                "`{$orderBy}` {$queryObject->getOrderByDirection()}"
            ]);
        }

        if (! empty($queryObject->getLimit())) {
            // Only set a limit if it's required
            if ($queryObject->getLimit() !== 'unlimited') {

The strict comparison !== seems to always evaluate to true as the types of $queryObject->getLimit() (integer) and 'unlimited' (string) can never be identical. Maybe you want to use a loose comparison != instead?

                $query->limit($queryObject->getLimit());
            }
        }

        return $this->prepareAndExecuteQuery($query, $queryObject);
    }

    /**
     * Sets up the PDO Driver, then executes the query based on dimension.
     *
     * @param  \Aura\SqlQuery\AbstractQuery $query
     * @param  \Ps2alerts\Api\QueryObjects\QueryObject $queryObject Sent QueryObject to read dimension
     * @return array The final data
     */
    public function prepareAndExecuteQuery(AbstractQuery $query, QueryObject $queryObject)
    {
        $pdo = $this->getDatabaseDriver();

        //var_dump($query->getStatement());die;

82% of this comment could be valid code. Did you maybe forget this after debugging?

        if ($queryObject->getDimension() === 'multi') {
            return $pdo->fetchAll($query->getStatement(), $query->getBindValues());
        }


        return $pdo->fetchOne($query->getStatement(), $query->getBindValues());
    }
}