flipbox\craft\element\lists\fields\InputTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	elementType()	0	1	?
A	inputTemplateVariables()	0	22	3
A	getInputJs()	0	28	3
A	getIndexJs()	0	30	2

<?php

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

namespace flipbox\craft\element\lists\fields;

use Craft;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\elements\db\ElementQueryInterface;
use flipbox\craft\elements\nestedIndex\web\assets\index\NestedElementIndex;
use flipbox\craft\ember\helpers\SiteHelper;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property string $inputTemplate
 * @property string $inputJsClass
 */
trait InputTrait
{
    /**
     * Returns the element class associated with this field type.
     *
     * @return string The Element class name
     */
    abstract protected static function elementType(): string;

    /**
     * @param null $value
     * @param ElementInterface|null $element
     * @return array
     * @throws \yii\base\InvalidConfigException
     */
    protected function inputTemplateVariables($value = null, ElementInterface $element = null): array
    {
        if ($value instanceof ElementQueryInterface) {
            $value = $value
                ->anyStatus()
                ->ids();
        } elseif (!is_array($value)) {
            $value = [];
        }

        Craft::$app->getView()->registerAssetBundle(NestedElementIndex::class);

        return [
            'element' => $element,
            'container' => 'nested-index-' . $this->handle,

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

            'elementType' => static::elementType(),
            'inputJsClass' => $this->inputJsClass,
            'inputJs' => $this->getInputJs($value, $element),

It seems like $element defined by parameter $element on line 40 can be null; however, flipbox\craft\element\lists\fields\InputTrait::getInputJs() does not accept null, maybe add an additional type check?

            'indexJsClass' => 'Craft.NestedElementIndex',
            'indexJs' => $this->getIndexJs($element)

It seems like $element defined by parameter $element on line 40 can be null; however, flipbox\craft\element\lists\fields\InputTrait::getIndexJs() does not accept null, maybe add an additional type check?

        ];
    }

    /*******************************************
     * JS CONFIGS
     *******************************************/

    /**
     * @param array $elementIds
     * @param ElementInterface $element
     * @return array
     */
    private function getInputJs(array $elementIds, ElementInterface $element): array
    {
        /** @var Element $element */
        $siteId = SiteHelper::ensureSiteId($element->siteId);

        $selectionCriteria = [
            'enabledForSite' => null,
            'siteId' => $siteId
        ];

        return [
            'elementType' => static::elementType(),
            'sources' => $this->inputSources($element),

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

            'criteria' => $selectionCriteria,
            'sourceElementId' => $element->getId() ?: null,
            'viewMode' => $this->viewMode,

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

            'limit' => $this->limit,

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

            'selectionLabel' => $this->selectionLabel,

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

            'storageKey' => 'nested.index.input.' . $this->handle,
            'elements' => $elementIds,
            'addAction' => 'element-lists/source/associate',
            'selectTargetAttribute' => 'target',
            'selectParams' => [
                'source' => $element->getId() ?: null,
                'field' => $this->id

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

            ]
        ];
    }

    /**
     * @param ElementInterface $element
     * @return array
     */
    private function getIndexJs(
        ElementInterface $element
    ): array {

        /** @var Element $element */
        $elementId = $element->getId() !== null ? $element->getId() : false;

        return [
            'source' => 'nested',
            'context' => 'index',
            'viewMode' => $this->viewMode,
            'showStatusMenu' => true,
            'showSiteMenu' => true,
            'hideSidebar' => false,
            'toolbarFixed' => false,
            'storageKey' => 'nested.index.' . $this->handle,
            'updateElementsAction' => 'element-lists/element-indexes/get-elements',
            'submitActionsAction' => 'element-lists/element-indexes/perform-action',
            'loadMoreElementsAction' => 'element-lists/element-indexes/get-more-elements',
            'criteria' => [
                'enabledForSite' => null,
                'siteId' => SiteHelper::ensureSiteId($element->siteId),
                $this->handle => $elementId
            ],
            'viewParams' => [
                'sourceId' => $elementId,
                'fieldId' => $this->id
            ]
        ];
    }
}