annotate core/modules/image/tests/src/Kernel/ImageFieldCreationTrait.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Tests\image\Kernel;
Chris@0 4
Chris@0 5 use Drupal\field\Entity\FieldConfig;
Chris@0 6 use Drupal\field\Entity\FieldStorageConfig;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Provides a helper method for creating Image fields.
Chris@0 10 */
Chris@0 11 trait ImageFieldCreationTrait {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Create a new image field.
Chris@0 15 *
Chris@0 16 * @param string $name
Chris@0 17 * The name of the new field (all lowercase), exclude the "field_" prefix.
Chris@0 18 * @param string $type_name
Chris@0 19 * The node type that this field will be added to.
Chris@0 20 * @param array $storage_settings
Chris@0 21 * (optional) A list of field storage settings that will be added to the
Chris@0 22 * defaults.
Chris@0 23 * @param array $field_settings
Chris@0 24 * (optional) A list of instance settings that will be added to the instance
Chris@0 25 * defaults.
Chris@0 26 * @param array $widget_settings
Chris@0 27 * (optional) Widget settings to be added to the widget defaults.
Chris@0 28 * @param array $formatter_settings
Chris@0 29 * (optional) Formatter settings to be added to the formatter defaults.
Chris@0 30 * @param string $description
Chris@0 31 * (optional) A description for the field. Defaults to ''.
Chris@0 32 */
Chris@0 33 protected function createImageField($name, $type_name, $storage_settings = [], $field_settings = [], $widget_settings = [], $formatter_settings = [], $description = '') {
Chris@0 34 FieldStorageConfig::create([
Chris@0 35 'field_name' => $name,
Chris@0 36 'entity_type' => 'node',
Chris@0 37 'type' => 'image',
Chris@0 38 'settings' => $storage_settings,
Chris@0 39 'cardinality' => !empty($storage_settings['cardinality']) ? $storage_settings['cardinality'] : 1,
Chris@0 40 ])->save();
Chris@0 41
Chris@0 42 $field_config = FieldConfig::create([
Chris@0 43 'field_name' => $name,
Chris@0 44 'label' => $name,
Chris@0 45 'entity_type' => 'node',
Chris@0 46 'bundle' => $type_name,
Chris@0 47 'required' => !empty($field_settings['required']),
Chris@0 48 'settings' => $field_settings,
Chris@0 49 'description' => $description,
Chris@0 50 ]);
Chris@0 51 $field_config->save();
Chris@0 52
Chris@0 53 entity_get_form_display('node', $type_name, 'default')
Chris@0 54 ->setComponent($name, [
Chris@0 55 'type' => 'image_image',
Chris@0 56 'settings' => $widget_settings,
Chris@0 57 ])
Chris@0 58 ->save();
Chris@0 59
Chris@0 60 entity_get_display('node', $type_name, 'default')
Chris@0 61 ->setComponent($name, [
Chris@0 62 'type' => 'image',
Chris@0 63 'settings' => $formatter_settings,
Chris@0 64 ])
Chris@0 65 ->save();
Chris@0 66
Chris@0 67 return $field_config;
Chris@0 68 }
Chris@0 69
Chris@0 70 }