Same name in other branches

1. 9 core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php \Drupal\Tests\image\Kernel\ImageFieldCreationTrait::createImageField()
2. 8.9.x core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php \Drupal\Tests\image\Kernel\ImageFieldCreationTrait::createImageField()
3. 11.x core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php \Drupal\Tests\image\Kernel\ImageFieldCreationTrait::createImageField()

Create a new image field.

Parameters

string $field_name: The name of the new field (all lowercase). The Field UI 'field_' prefix is not added to the field name.

string $entity_type: The entity type that this field will be added to. For backwards-compatibility, a bundle is also accepted in this parameter.

string $bundle: The bundle this field will be added to.

array $storage_settings: (optional) A list of field storage settings that will be added to the defaults.

array $field_settings: (optional) A list of instance settings that will be added to the instance defaults.

array $widget_settings: (optional) Widget settings to be added to the widget defaults.

array $formatter_settings: (optional) Formatter settings to be added to the formatter defaults.

string $description: (optional) A description for the field. Defaults to ''.

26 calls to ImageFieldCreationTrait::createImageField()

ContentTranslationLanguageChangeTest::setUp in core/modules/content_translation/tests/src/Functional/ContentTranslationLanguageChangeTest.php

FilterTest::savePaintingType in core/modules/jsonapi/tests/src/Kernel/Query/FilterTest.php

Creates a painting node type.

ImageAdminStylesTest::testConfigImport in core/modules/image/tests/src/Functional/ImageAdminStylesTest.php

Tests image style configuration import that does a delete.

ImageAdminStylesTest::testStyleReplacement in core/modules/image/tests/src/Functional/ImageAdminStylesTest.php

Tests deleting a style and choosing a replacement style.

ImageFieldDefaultImagesTest::testDefaultImages in core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php

Tests CRUD for fields and field storages with default images.

... See full list

File

core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php, line 39

Class

ImageFieldCreationTrait

Provides a helper method for creating Image fields.

Namespace

Drupal\Tests\image\Kernel

Code

protected function createImageField($field_name, $entity_type, $bundle = '', $storage_settings = [], $field_settings = [], $widget_settings = [], $formatter_settings = [], $description = '') {
    // Previously, nodes were the only entity type supported, For backwards
    // compatibility, the $entity_type parameter is used as the $bundle in
    // cases where only one machine name is passed.
    if (func_num_args() == 2) {
        @trigger_error('Calling ' . __METHOD__ . '() with only two arguments is deprecated in drupal:10.3.0 and three arguments will be required in drupal:11.0.0. See https://www.drupal.org/node/3441322', E_USER_DEPRECATED);
        $bundle = $entity_type;
        $entity_type = 'node';
    }
    elseif (is_array($bundle)) {
        @trigger_error('Calling ' . __METHOD__ . '() without the $entity_type argument is deprecated in drupal:10.3.0 and this argument will be required in drupal:11.0.0. See https://www.drupal.org/node/3441322', E_USER_DEPRECATED);
        return $this->createImageField($field_name, 'node', $entity_type, $bundle, $storage_settings, $field_settings, $widget_settings, $formatter_settings, $description);
    }
    FieldStorageConfig::create([
        'field_name' => $field_name,
        'entity_type' => $entity_type,
        'type' => 'image',
        'settings' => $storage_settings,
        'cardinality' => !empty($storage_settings['cardinality']) ? $storage_settings['cardinality'] : 1,
    ])->save();
    $field_config = FieldConfig::create([
        'field_name' => $field_name,
        'label' => $field_name,
        'entity_type' => $entity_type,
        'bundle' => $bundle,
        'required' => !empty($field_settings['required']),
        'settings' => $field_settings,
        'description' => $description,
    ]);
    $field_config->save();
    
    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');
    $display_repository->getFormDisplay($entity_type, $bundle)
        ->setComponent($field_name, [
        'type' => 'image_image',
        'settings' => $widget_settings,
    ])
        ->save();
    $display_repository->getViewDisplay($entity_type, $bundle)
        ->setComponent($field_name, [
        'type' => 'image',
        'settings' => $formatter_settings,
    ])
        ->save();
    return $field_config;
}

---