flipbox\craft\element\lists\fields\NormalizeValueTrait

Complexity

Total Complexity

20

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	elementType()	0	1	?
A	getQuery()	0	16	3
A	normalizeValue()	0	17	2
A	normalizeQuery()	0	32	5
A	normalizeQueryValue()	0	15	3
A	normalizeQueryInputValues()	0	12	2
A	normalizeQueryInputValue()	0	18	4
A	normalizeQueryEmptyValue()	0	5	1

<?php

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

namespace flipbox\craft\element\lists\fields;

use craft\base\Element;
use craft\base\ElementInterface;
use craft\elements\db\ElementQuery;
use craft\elements\db\ElementQueryInterface;
use craft\helpers\StringHelper;
use flipbox\craft\element\lists\records\Association;
use flipbox\craft\element\lists\relationships\Relationship;
use flipbox\craft\element\lists\relationships\RelationshipInterface;
use flipbox\craft\ember\helpers\SiteHelper;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property int|null $id
 * @property int|null $limit
 * @property bool $allowLimit
 *
 * @mixin RelationalInterface
 */
trait NormalizeValueTrait
{
    abstract protected static function elementType(): string;

    /**
     * @param ElementInterface|null $element
     * @return ElementQueryInterface
     */
    public function getQuery(ElementInterface $element = null): ElementQueryInterface
    {
        /** @var Element $elementType */
        $elementType = static::elementType();

        /** @var ElementQuery $query */
        $query = $elementType::find();

        if ($this->allowLimit && $this->limit) {
            $query->limit($this->limit);
        }

        $this->normalizeQuery($query, $element);

        return $query;
    }

    /**
     * @param $value
     * @param ElementInterface|null $element
     * @return RelationshipInterface
     */
    public function normalizeValue(
        $value,
        ElementInterface $element = null
    ) {
        if ($value instanceof RelationshipInterface) {
            return $value;
        }

        $query = $this->getQuery($element);

        $this->normalizeQueryValue($query, $value, $element);

$query of type object<craft\elements\db\ElementQueryInterface> is not a sub-type of object<craft\elements\db\ElementQuery>. It seems like you assume a concrete implementation of the interface craft\elements\db\ElementQueryInterface to be always present.

        return new Relationship(
            $this,
            $element
        );
    }

    /**
     * @param ElementQuery $query
     * @param ElementInterface|null $element
     */
    protected function normalizeQuery(
        ElementQuery $query,
        ElementInterface $element = null
    ) {
        /** @var Element|null $element */

        $source = ($element !== null && $element->getId() !== null ? $element->getId() : false);

        if ($source !== false) {
            $name = Association::tableName();
            $alias = Association::tableAlias();

            $query->innerJoin(
                $name . ' ' . $alias,
                [
                    'and',
                    '[[' . $alias . '.targetId]] = [[elements.id]]',
                    [
                        $alias . '.sourceId' => $source,
                        $alias . '.fieldId' => $this->id
                    ],
                    [
                        'or',
                        [$alias . '.sourceSiteId' => null],
                        [$alias . '.sourceSiteId' => SiteHelper::ensureSiteId($element->siteId ?: null)]
                    ]
                ]
            );
        } else {
            $query->id(false);
        }
    }

    /**
     * @param ElementQuery $query
     * @param $value
     * @param ElementInterface|null $element
     */
    protected function normalizeQueryValue(
        ElementQuery $query,
        $value,
        ElementInterface $element = null
    ) {
        if (is_array($value)) {
            $this->normalizeQueryInputValues($query, $value, $element);
            return;
        }

        if ($value === '') {
            $this->normalizeQueryEmptyValue($query);
            return;
        }
    }

    /**
     * @param ElementQuery $query
     * @param array $value
     * @param ElementInterface|null $element
     */
    protected function normalizeQueryInputValues(
        ElementQuery $query,
        array $value,
        ElementInterface $element = null
    ) {
        $models = [];
        $sortOrder = 1;
        foreach ($value as $val) {
            $models[] = $this->normalizeQueryInputValue($val, $sortOrder, $element);
        }
        $query->setCachedResult($models);
    }

    /**
     * @param $value
     * @param int $sortOrder
     * @param ElementInterface|Element|null $element
     * @return Association
     */
    protected function normalizeQueryInputValue(
        $value,
        int &$sortOrder,
        ElementInterface $element = null
    ): Association {

        if (is_array($value)) {
            $value = StringHelper::toString($value);
        }

        return new Association([
            'fieldId' => $this->id,
            'targetId' => $value,
            'sourceId' => $element === null ? null : $element->getId(),
            'siteId' => SiteHelper::ensureSiteId($element === null ? null : $element->siteId),
            'sortOrder' => $sortOrder++
        ]);
    }

    /**
     * @param ElementQuery $query
     */
    protected function normalizeQueryEmptyValue(
        ElementQuery $query
    ) {
        $query->setCachedResult([]);
    }
}