flipbox\ember\services\traits\ElementAccessorByString

Complexity

Total Complexity

25

Size/Duplication

Total Lines	245
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
	stringProperty()	0	1	?
A	stringValue()	0	6	1
A	addToCache()	0	6	1
A	findByString()	0	15	3
A	getByString()	0	8	2
A	freshFindByString()	0	15	2
A	freshGetByString()	0	8	2
A	findCacheByString()	0	10	2
A	isCachedByString()	0	10	2
A	cacheByString()	0	19	3
A	notFoundByStringException()	0	9	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;

use craft\base\Element;
use craft\base\ElementInterface;
use craft\elements\db\ElementQuery;
use flipbox\ember\exceptions\ElementNotFoundException;
use flipbox\ember\helpers\SiteHelper;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait ElementAccessorByString
{
    use ElementAccessor {
        find as parentFind;
        findCache as parentFindCache;
    }

    /**
     * @var [ElementInterface[]]
     */
    protected $cacheByString = [];

    /**
     * @return string
     */
    abstract protected function stringProperty(): string;

    /*******************************************
     * STRING
     *******************************************/

    /**
     * @param ElementInterface $element
     * @return string
     */
    protected function stringValue(ElementInterface $element)
    {
        $property = $this->stringProperty();

        return $element->{$property};
    }


    /*******************************************
     * FIND OVERRIDES
     *******************************************/

    /**
     * @inheritdoc
     */
    public function find($identifier, int $siteId = null, string $toScenario = null)
    {
        if ($element = $this->parentFind($identifier, $siteId, $toScenario)) {

It seems like parentFind() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $element;
        }

        if (!is_string($identifier)) {
            return null;
        }

        return $this->findByString($identifier, $siteId, $toScenario);
    }

    /*******************************************
     * CACHE OVERRIDES
     *******************************************/

    /**
     * @inheritdoc
     */
    public function findCache($identifier, int $siteId = null)
    {
        if ($element = $this->parentFindCache($identifier, $siteId)) {

The method parentFindCache() does not exist on flipbox\ember\services\traits\ElementAccessorByString. Did you maybe mean findCache()?

            return $element;
        }

        if (!is_string($identifier)) {
            return null;
        }

        return $this->findCacheByString($identifier, $siteId);
    }

    /**
     * @inheritdoc
     */
    public function addToCache(ElementInterface $element)
    {
        $this->cacheById($element);
        $this->cacheByString($element);
        return $this;
    }


    /*******************************************
     * FIND/GET BY STRING
     *******************************************/

    /**
     * @param string $string
     * @param int|null $siteId
     * @param string|null $toScenario
     * @return ElementInterface|null
     */
    public function findByString(string $string, int $siteId = null, string $toScenario = null)
    {
        $siteId = SiteHelper::resolveSiteId($siteId);

        if (!$element = $this->findCacheByString($string, $siteId)) {
            if (!$element = $this->freshFindByString($string, $siteId)) {
                $this->cacheByString[$siteId][$string] = null;
                return null;
            }

            $this->addToCache($element);
        }

        return $this->applyScenario($element, $toScenario);
    }

    /**
     * @param string $string
     * @param string|null $toScenario
     * @return ElementInterface|null
     * @throws ElementNotFoundException
     */
    public function getByString(string $string, string $toScenario = null): ElementInterface
    {
        if (!$element = $this->findByString($string, $toScenario)) {
            $this->notFoundByStringException($string);
        }

        return $element;
    }

    /**
     * @param string $string
     * @param int|null $siteId
     * @param string $toScenario
     * @return ElementInterface|null
     */
    public function freshFindByString(string $string, int $siteId = null, string $toScenario = null)
    {
        /** @var ElementQuery $query */
        $query = $this->getQuery();
        $query->{$this->stringProperty()} = $string;
        $query->siteId = $siteId;
        $query->status = null;
        $query->enabledForSite = false;

        if (!$element = $query->one()) {
            return null;
        }

        return $this->applyScenario($element, $toScenario);
    }

    /**
     * @param string $string
     * @param string|null $toScenario
     * @return ElementInterface
     * @throws ElementNotFoundException
     */
    public function freshGetByString(string $string, string $toScenario = null): ElementInterface
    {
        if (!$element = $this->freshFindByString($string, $toScenario)) {
            $this->notFoundByStringException($string);
        }

        return $element;
    }


    /*******************************************
     * CACHE BY STRING
     *******************************************/

    /**
     * Find an existing cache by ID
     *
     * @param string $string
     * @param int|null $siteId
     * @return ElementInterface|null
     */
    public function findCacheByString(string $string, int $siteId = null)
    {
        $siteId = SiteHelper::resolveSiteId($siteId);

        if ($this->isCachedByString($string, $siteId)) {
            return $this->cacheByString[$siteId][$string];
        }

        return null;
    }

    /**
     * Identify whether in cached by ID
     *
     * @param string $string
     * @param int|null $siteId
     * @return bool
     */
    protected function isCachedByString(string $string, int $siteId = null): bool
    {
        $siteId = SiteHelper::resolveSiteId($siteId);

        if (!array_key_exists($siteId, $this->cacheByString)) {
            $this->cacheByString[$siteId] = [];
        }

        return array_key_exists($string, $this->cacheByString[$siteId]);
    }

    /**
     * @param ElementInterface|Element $element
     * @return $this
     */
    protected function cacheByString(ElementInterface $element)
    {
        $stringValue = $this->stringValue($element);

        if (null === $stringValue) {
            return $this;
        }

        $siteId = $element->siteId;

Accessing siteId on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

        // todo - ensure siteId is set?

        // Check if already in cache
        if (!$this->isCachedByString($stringValue, $siteId)) {
            $this->cacheByString[$siteId][$stringValue] = $element;
        }

        return $this;
    }

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

    /**
     * @param string|null $string
     * @throws ElementNotFoundException
     */
    protected function notFoundByStringException(string $string = null)
    {
        throw new ElementNotFoundException(
            sprintf(
                'Element does not exist with the string "%s".',
                (string)$string
            )
        );
    }
}