QuickEditTestBase.php

<?php

namespace Drupal\Tests\quickedit\Kernel;

use Drupal\field\Entity\FieldConfig;
use Drupal\KernelTests\KernelTestBase;
use Drupal\field\Entity\FieldStorageConfig;

/**
 * Base class for testing Quick Edit functionality.
 */
abstract class QuickEditTestBase extends KernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'system',
        'entity_test',
        'field',
        'field_test',
        'filter',
        'user',
        'text',
        'quickedit',
    ];
    
    /**
     * Bag of created fields.
     *
     * Allows easy access to test field names/IDs/objects via:
     * - $this->fields->{$field_name}_field_storage
     * - $this->fields->{$field_name}_instance
     *
     * @see \Drupal\quickedit\Tests\QuickEditTestBase::createFieldWithStorage()
     *
     * @var \ArrayObject
     */
    protected $fields;
    
    /**
     * Sets the default field storage backend for fields created during tests.
     */
    protected function setUp() {
        parent::setUp();
        $this->fields = new \ArrayObject([], \ArrayObject::ARRAY_AS_PROPS);
        $this->installEntitySchema('user');
        $this->installEntitySchema('entity_test');
        $this->installConfig([
            'field',
            'filter',
        ]);
    }
    
    /**
     * Creates a field.
     *
     * @param string $field_name
     *   The field name.
     * @param string $type
     *   The field type.
     * @param int $cardinality
     *   The field's cardinality.
     * @param string $label
     *   The field's label (used everywhere: widget label, formatter label).
     * @param array $field_settings
     *   The field's settings.
     * @param string $widget_type
     *   The widget type.
     * @param array $widget_settings
     *   The widget settings.
     * @param string $formatter_type
     *   The formatter type.
     * @param array $formatter_settings
     *   The formatter settings.
     */
    protected function createFieldWithStorage($field_name, $type, $cardinality, $label, $field_settings, $widget_type, $widget_settings, $formatter_type, $formatter_settings) {
        $field_storage = $field_name . '_field_storage';
        $this->fields->{$field_storage} = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => $type,
            'cardinality' => $cardinality,
        ]);
        $this->fields->{$field_storage}
            ->save();
        $field = $field_name . '_field';
        $this->fields->{$field} = FieldConfig::create([
            'field_storage' => $this->fields->{$field_storage},
            'bundle' => 'entity_test',
            'label' => $label,
            'description' => $label,
            'weight' => mt_rand(0, 127),
            'settings' => $field_settings,
        ]);
        $this->fields->{$field}
            ->save();
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
        $display_repository = \Drupal::service('entity_display.repository');
        $display_repository->getFormDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => $widget_type,
            'settings' => $widget_settings,
        ])
            ->save();
        $display_repository->getViewDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'label' => 'above',
            'type' => $formatter_type,
            'settings' => $formatter_settings,
        ])
            ->save();
    }

}