3 namespace Drupal\Tests\field\Kernel;
5 use Drupal\Core\Entity\Entity\EntityViewMode;
6 use Drupal\entity_test\Entity\EntityTest;
7 use Drupal\field\Entity\FieldConfig;
8 use Drupal\field\Entity\FieldStorageConfig;
11 * Tests the field display API.
15 class DisplayApiTest extends FieldKernelTestBase {
18 * The field name to use in this test.
25 * The field label to use in this test.
32 * The field cardinality to use in this test.
36 protected $cardinality;
39 * The field display options to use in this test.
43 protected $displayOptions;
48 * @var \Drupal\Core\Entity\EntityInterface
53 * An array of random values, in the format expected for field values.
62 public static $modules = ['system'];
64 protected function setUp() {
67 // Create a field and its storage.
68 $this->fieldName = 'test_field';
69 $this->label = $this->randomMachineName();
70 $this->cardinality = 4;
73 'field_name' => $this->fieldName,
74 'entity_type' => 'entity_test',
75 'type' => 'test_field',
76 'cardinality' => $this->cardinality,
79 'field_name' => $this->fieldName,
80 'entity_type' => 'entity_test',
81 'bundle' => 'entity_test',
82 'label' => $this->label,
85 $this->displayOptions = [
87 'type' => 'field_test_default',
89 'test_formatter_setting' => $this->randomMachineName(),
93 'type' => 'field_test_default',
95 'test_formatter_setting' => $this->randomMachineName(),
100 FieldStorageConfig::create($field_storage)->save();
101 FieldConfig::create($field)->save();
102 // Create a display for the default view mode.
103 entity_get_display($field['entity_type'], $field['bundle'], 'default')
104 ->setComponent($this->fieldName, $this->displayOptions['default'])
106 // Create a display for the teaser view mode.
107 EntityViewMode::create(['id' => 'entity_test.teaser', 'targetEntityType' => 'entity_test'])->save();
108 entity_get_display($field['entity_type'], $field['bundle'], 'teaser')
109 ->setComponent($this->fieldName, $this->displayOptions['teaser'])
112 // Create an entity with values.
113 $this->values = $this->_generateTestFieldValues($this->cardinality);
114 $this->entity = EntityTest::create();
115 $this->entity->{$this->fieldName}->setValue($this->values);
116 $this->entity->save();
120 * Tests the FieldItemListInterface::view() method.
122 public function testFieldItemListView() {
123 $items = $this->entity->get($this->fieldName);
125 \Drupal::service('theme_handler')->install(['classy']);
126 $this->config('system.theme')->set('default', 'classy')->save();
128 // No display settings: check that default display settings are used.
129 $build = $items->view();
130 $this->render($build);
131 $settings = \Drupal::service('plugin.manager.field.formatter')->getDefaultSettings('field_test_default');
132 $setting = $settings['test_formatter_setting'];
133 $this->assertText($this->label, 'Label was displayed.');
134 foreach ($this->values as $delta => $value) {
135 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
138 // Display settings: Check hidden field.
141 'type' => 'field_test_multiple',
143 'test_formatter_setting_multiple' => $this->randomMachineName(),
147 $build = $items->view($display);
148 $this->render($build);
149 $setting = $display['settings']['test_formatter_setting_multiple'];
150 $this->assertNoText($this->label, 'Label was not displayed.');
151 $this->assertText('field_test_entity_display_build_alter', 'Alter fired, display passed.');
152 $this->assertText('entity language is en', 'Language is placed onto the context.');
154 foreach ($this->values as $delta => $value) {
155 $array[] = $delta . ':' . $value['value'];
157 $this->assertText($setting . '|' . implode('|', $array), 'Values were displayed with expected setting.');
159 // Display settings: Check visually_hidden field.
161 'label' => 'visually_hidden',
162 'type' => 'field_test_multiple',
164 'test_formatter_setting_multiple' => $this->randomMachineName(),
168 $build = $items->view($display);
169 $this->render($build);
170 $setting = $display['settings']['test_formatter_setting_multiple'];
171 $this->assertRaw('visually-hidden', 'Label was visually hidden.');
172 $this->assertText('field_test_entity_display_build_alter', 'Alter fired, display passed.');
173 $this->assertText('entity language is en', 'Language is placed onto the context.');
175 foreach ($this->values as $delta => $value) {
176 $array[] = $delta . ':' . $value['value'];
178 $this->assertText($setting . '|' . implode('|', $array), 'Values were displayed with expected setting.');
180 // Check the prepare_view steps are invoked.
183 'type' => 'field_test_with_prepare_view',
185 'test_formatter_setting_additional' => $this->randomMachineName(),
188 $build = $items->view($display);
189 $this->render($build);
190 $setting = $display['settings']['test_formatter_setting_additional'];
191 $this->assertNoText($this->label, 'Label was not displayed.');
192 $this->assertNoText('field_test_entity_display_build_alter', 'Alter not fired.');
193 foreach ($this->values as $delta => $value) {
194 $this->assertText($setting . '|' . $value['value'] . '|' . ($value['value'] + 1), format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
197 // View mode: check that display settings specified in the display object
199 $build = $items->view('teaser');
200 $this->render($build);
201 $setting = $this->displayOptions['teaser']['settings']['test_formatter_setting'];
202 $this->assertText($this->label, 'Label was displayed.');
203 foreach ($this->values as $delta => $value) {
204 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
207 // Unknown view mode: check that display settings for 'default' view mode
209 $build = $items->view('unknown_view_mode');
210 $this->render($build);
211 $setting = $this->displayOptions['default']['settings']['test_formatter_setting'];
212 $this->assertText($this->label, 'Label was displayed.');
213 foreach ($this->values as $delta => $value) {
214 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
219 * Tests the FieldItemInterface::view() method.
221 public function testFieldItemView() {
222 // No display settings: check that default display settings are used.
223 $settings = \Drupal::service('plugin.manager.field.formatter')->getDefaultSettings('field_test_default');
224 $setting = $settings['test_formatter_setting'];
225 foreach ($this->values as $delta => $value) {
226 $item = $this->entity->{$this->fieldName}[$delta];
227 $build = $item->view();
228 $this->render($build);
229 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
232 // Check that explicit display settings are used.
234 'type' => 'field_test_multiple',
236 'test_formatter_setting_multiple' => $this->randomMachineName(),
239 $setting = $display['settings']['test_formatter_setting_multiple'];
240 foreach ($this->values as $delta => $value) {
241 $item = $this->entity->{$this->fieldName}[$delta];
242 $build = $item->view($display);
243 $this->render($build);
244 $this->assertText($setting . '|0:' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
247 // Check that prepare_view steps are invoked.
249 'type' => 'field_test_with_prepare_view',
251 'test_formatter_setting_additional' => $this->randomMachineName(),
254 $setting = $display['settings']['test_formatter_setting_additional'];
255 foreach ($this->values as $delta => $value) {
256 $item = $this->entity->{$this->fieldName}[$delta];
257 $build = $item->view($display);
258 $this->render($build);
259 $this->assertText($setting . '|' . $value['value'] . '|' . ($value['value'] + 1), format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
262 // View mode: check that display settings specified in the field are used.
263 $setting = $this->displayOptions['teaser']['settings']['test_formatter_setting'];
264 foreach ($this->values as $delta => $value) {
265 $item = $this->entity->{$this->fieldName}[$delta];
266 $build = $item->view('teaser');
267 $this->render($build);
268 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
271 // Unknown view mode: check that display settings for 'default' view mode
273 $setting = $this->displayOptions['default']['settings']['test_formatter_setting'];
274 foreach ($this->values as $delta => $value) {
275 $item = $this->entity->{$this->fieldName}[$delta];
276 $build = $item->view('unknown_view_mode');
277 $this->render($build);
278 $this->assertText($setting . '|' . $value['value'], format_string('Value @delta was displayed with expected setting.', ['@delta' => $delta]));
283 * Tests that the prepareView() formatter method still fires for empty values.
285 public function testFieldEmpty() {
286 // Uses \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldEmptyFormatter.
289 'type' => 'field_empty_test',
291 'test_empty_string' => '**EMPTY FIELD**' . $this->randomMachineName(),
294 // $this->entity is set by the setUp() method and by default contains 4
295 // numeric values. We only want to test the display of this one field.
296 $build = $this->entity->get($this->fieldName)->view($display);
297 $this->render($build);
298 // The test field by default contains values, so should not display the
299 // default "empty" text.
300 $this->assertNoText($display['settings']['test_empty_string']);
302 // Now remove the values from the test field and retest.
303 $this->entity->{$this->fieldName} = [];
304 $this->entity->save();
305 $build = $this->entity->get($this->fieldName)->view($display);
306 $this->render($build);
307 // This time, as the field values have been removed, we *should* show the
308 // default "empty" text.
309 $this->assertText($display['settings']['test_empty_string']);