flipbox\craft\element\lists\fields\ElementListTrait

Complexity

Total Complexity

19

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	serializeValue()	0	4	1
A	isValueEmpty()	0	4	1
A	getStaticHtml()	0	30	3
A	getTableAttributeHtml()	0	12	2
A	getSearchKeywords()	0	15	3
A	ensureSortOrder()	0	4	1
A	setSortable()	0	5	1
A	getSortable()	0	4	1
A	getSettingsHtml()	0	14	1
A	afterElementSave()	0	21	5

<?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;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\events\FieldElementEvent;
use craft\helpers\StringHelper;
use flipbox\craft\element\lists\relationships\RelationshipInterface;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property string $settingsTemplate
 */
trait ElementListTrait
{
    use ModifyElementQueryTrait,
        NormalizeValueTrait,
        InputTrait;

    /**
     * @var bool
     */
    protected $ignoreSearchKeywords = true;

    /**
     * Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry
     * revision table.
     *
     * Data types that are JSON-encodable are safe (arrays, integers, strings, booleans, etc).
     * Whatever this returns should be something [[normalizeValue()]] can handle.
     *
     * @param mixed $value The raw field value
     * @param ElementInterface|null $element The element the field is associated with, if there is one
     * @return mixed The serialized field value
     */
    public function serializeValue($value, ElementInterface $element = null)
    {
        return $this->normalizeValue($value, $element)->getRelationships()->pluck('targetId')->all();
    }

    /**
     * Returns whether the given value should be considered “empty” to a validator.
     *
     * @param mixed $value The field’s value
     * @param ElementInterface $element The element the field is associated with, if there is one
     * @return bool Whether the value should be considered “empty”
     * @see Validator::$isEmpty
     */
    public function isValueEmpty($value, ElementInterface $element): bool
    {
        return $this->normalizeValue($value, $element)->getRelationships()->isEmpty();
    }

    /**
     * /**
     * Returns a static (non-editable) version of the field’s input HTML.
     *
     * This function is called to output field values when viewing entry drafts.
     *
     * @param mixed $value The field’s value
     * @param ElementInterface $element The element the field is associated with
     * @return string The static version of the field’s input HTML
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     */
    public function getStaticHtml($value, ElementInterface $element): string
    {
        $relationship = $this->normalizeValue($value, $element);

        $value = $relationship->getCollection()->all();

        if (empty($value)) {
            return '<p class="light">' . Craft::t('app', 'Nothing selected.') . '</p>';
        }

        $view = Craft::$app->getView();
        $id = $view->formatInputId($this->handle);
        $html = "<div id='{$id}' class='elementselect'><div class='elements'>";

        foreach ($value as $relatedElement) {
            $html .= Craft::$app->getView()->renderTemplate('_elements/element', [
                'element' => $relatedElement
            ]);
        }

        $html .= '</div></div>';

        $nsId = $view->namespaceInputId($id);
        $js = <<<JS
(new Craft.ElementThumbLoader()).load($('#{$nsId}'));
JS;
        $view->registerJs($js);

        return $html;
    }

    /**
     * Returns the HTML that should be shown for this field in Table View.
     *
     * @param mixed $value The field’s value
     * @param ElementInterface $element The element the field is associated with
     * @return string The HTML that should be shown for this field in Table View
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     */
    public function getTableAttributeHtml($value, ElementInterface $element): string
    {
        $relationship = $this->normalizeValue($value, $element);

        if (!$element = $relationship->getCollection()->first()) {
            return '';
        }

        return Craft::$app->getView()->renderTemplate('_elements/element', [
            'element' => $element
        ]);
    }

    /**
     * @inheritdoc
     */
    public function getSearchKeywords($value, ElementInterface $element): string
    {
        if ($this->ignoreSearchKeywords === true) {
            return '';
        }

        $relationship = $this->normalizeValue($value, $element);

        $titles = [];
        foreach ($relationship->getCollection()->all() as $relatedElement) {
            $titles[] = (string)$relatedElement;
        }

        return StringHelper::toString($titles, ' ');
    }

    /**
     * Identify whether a sort order should be enforced.
     *
     * @return bool
     */
    public function ensureSortOrder(): bool
    {
        return $this->sortable;

The property sortable does not exist. Did you maybe forget to declare it?

    }

    /**
     * Allow the settings to identify whether the element should be sortable
     *
     * @param bool $sortable
     * @return $this
     */
    public function setSortable(bool $sortable = null)
    {
        $this->sortable = ($sortable === true);
        return $this;
    }

    /**
     * Get the sortable attribute value
     *
     * @return bool
     */
    public function getSortable(): bool
    {
        return $this->sortable;
    }

    /**
     * @inheritDoc
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     */
    public function getSettingsHtml()
    {
        /** @var ElementInterface|string $elementType */
        $elementType = $this->elementType();

        return Craft::$app->getView()->renderTemplate(
            'element-lists/_components/fieldtypes/settings',
            [
                'settingsTemplate' => $this->settingsTemplate,
                'field' => $this,
                'pluralElementType' => $elementType::pluralDisplayName(),
            ]
        );
    }

    /**
     * Our value is not an ElementQueryInterface and therefore we should handle it
     * differently.
     *
     * @inheritdoc
     */
    public function afterElementSave(ElementInterface $element, bool $isNew)
    {
        // Skip if the element is just propagating, and we're not localizing relations
        /** @var Element $element */
        if (!$element->propagating || $this->localizeRelations) {

The property localizeRelations does not exist. Did you maybe forget to declare it?

            /** @var RelationshipInterface $value */
            $value = $element->getFieldValue($this->handle);

            if ($value->isMutated()) {
                $value->save();
            }
        }

        // Trigger an 'afterElementSave' event
        if ($this->hasEventHandlers(self::EVENT_AFTER_ELEMENT_SAVE)) {

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

            $this->trigger(self::EVENT_AFTER_ELEMENT_SAVE, new FieldElementEvent([

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

                'element' => $element,
                'isNew' => $isNew,
            ]));
        }
    }
}