flipbox\ember\services\traits\queries\Accessor

Complexity

Total Complexity

26

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
	getQuery()	0	1	?
A	cacheDuration()	0	4	1
A	cacheDependency()	0	4	1
A	getDb()	0	4	1
A	findAll()	0	4	1
A	find()	0	4	3
A	get()	0	8	2
A	findByCondition()	0	6	1
A	getByCondition()	0	8	2
A	findByCriteria()	0	8	1
A	getByCriteria()	0	8	2
A	findAllByCondition()	0	6	1
A	getAllByCondition()	0	9	2
A	findAllByCriteria()	0	8	1
A	getAllByCriteria()	0	9	2
A	queryOne()	0	18	3
A	queryAll()	0	18	3
A	notFoundException()	0	8	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember
 */

namespace flipbox\ember\services\traits\queries;

use Craft;
use flipbox\ember\exceptions\NotFoundException;
use flipbox\ember\helpers\RecordHelper;
use yii\base\BaseObject;
use yii\caching\Dependency;
use yii\db\Connection;
use yii\db\QueryInterface;

/**
 * A set of robust methods commonly used to retrieve data from the attached database.  An optional
 * cache layer can be applied to circumvent heavy queries.
 *
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait Accessor
{
    /*******************************************
     * QUERY
     *******************************************/

    /**
     * @param array $config
     * @return \yii\db\ActiveQuery
     */
    abstract public function getQuery($config = []): QueryInterface;

    /*******************************************
     * CACHE
     *******************************************/

    /**
     * @return int|null
     */
    protected static function cacheDuration()
    {
        return false;
    }

    /**
     * @return null|Dependency
     */
    protected static function cacheDependency()
    {
        return null;
    }

    /**
     * @return Connection
     */
    protected static function getDb(): Connection
    {
        return Craft::$app->getDb();
    }

    /*******************************************
     * FIND / GET
     *******************************************/

    /**
     * @return array[]
     */
    public function findAll()
    {
        return $this->findAllByCondition(null);

null is of type null, but the function expects a array.

    }

    /**
     * @param $identifier
     * @return mixed|null
     */
    public function find($identifier)
    {
        return $this->findByCondition($identifier);
    }

    /**
     * @param $identifier
     * @return mixed
     * @throws NotFoundException
     */
    public function get($identifier)
    {
        if (null === ($object = $this->find($identifier))) {
            $this->notFoundException();
        }

        return $object;
    }


    /*******************************************
     * ONE CONDITION
     *******************************************/

    /**
     * @param $condition
     * @return mixed|null
     */
    public function findByCondition($condition)
    {
        return $this->findByCriteria(
            RecordHelper::conditionToCriteria($condition)
        );
    }

    /**
     * @param $condition
     * @return mixed
     * @throws NotFoundException
     */
    public function getByCondition($condition)
    {
        if (null === ($object = $this->findByCondition($condition))) {
            $this->notFoundException();
        }

        return $object;
    }


    /*******************************************
     * ONE CRITERIA
     *******************************************/

    /**
     * @param $criteria
     * @return mixed|null
     */
    public function findByCriteria($criteria)
    {
        $object = $this->queryOne(
            $this->getQuery($criteria)
        );

        return $object;
    }

    /**
     * @param $criteria
     * @return mixed
     * @throws NotFoundException
     */
    public function getByCriteria($criteria)
    {
        if (null === ($record = $this->findByCriteria($criteria))) {
            $this->notFoundException();
        }

        return $record;
    }


    /*******************************************
     * ALL CONDITION
     *******************************************/

    /**
     * @param array $condition
     * @return BaseObject[]
     */
    public function findAllByCondition($condition = []): array
    {
        return $this->findAllByCriteria(
            RecordHelper::conditionToCriteria($condition)
        );
    }

    /**
     * @param array $condition
     * @return BaseObject[]
     * @throws NotFoundException
     */
    public function getAllByCondition($condition = []): array
    {
        $records = $this->findAllByCondition($condition);
        if (empty($records)) {
            $this->notFoundException();
        }

        return $records;
    }

    /*******************************************
     * ALL CRITERIA
     *******************************************/

    /**
     * @param array $criteria
     * @return BaseObject[]
     */
    public function findAllByCriteria($criteria = []): array
    {
        $records = $this->queryAll(
            $this->getQuery($criteria)
        );

        return $records;
    }

    /**
     * @param array $criteria
     * @return BaseObject[]
     * @throws NotFoundException
     */
    public function getAllByCriteria($criteria = []): array
    {
        $records = $this->findAllByCriteria($criteria);
        if (empty($records)) {
            $this->notFoundException();
        }

        return $records;
    }


    /*******************************************
     * CACHE
     *******************************************/

    /**
     * @param QueryInterface $query
     * @return mixed|null
     */
    protected function queryOne(QueryInterface $query)
    {
        $db = static::getDb();

        try {
            if (false === ($cacheDuration = static::cacheDuration())) {
                return $query->one($db);
            }

            $result = $db->cache(function ($db) use ($query) {
                return $query->one($db);
            }, $cacheDuration, static::cacheDependency());

$cacheDuration is of type boolean, but the function expects a integer|null.

        } catch (\Exception $e) {
            return null;
        }

        return $result;
    }

    /**
     * @param QueryInterface $query
     * @return mixed[]
     */
    protected function queryAll(QueryInterface $query)
    {
        $db = static::getDb();

        try {
            if (false === ($cacheDuration = static::cacheDuration())) {
                return $query->all($db);
            }

            $results = $db->cache(function ($db) use ($query) {
                return $query->all($db);
            }, $cacheDuration, static::cacheDependency());

$cacheDuration is of type boolean, but the function expects a integer|null.

        } catch (\Exception $e) {
            return [];
        }

        return $results;
    }

    /*******************************************
     * EXCEPTIONS
     *******************************************/

    /**
     * @throws NotFoundException
     */
    protected function notFoundException()
    {
        throw new NotFoundException(
            sprintf(
                "Results not found."
            )
        );
    }
}