3 namespace Drupal\field\Tests\Views;
5 use Drupal\Core\Field\FieldStorageDefinitionInterface;
6 use Drupal\views\ViewExecutable;
7 use Drupal\views\Views;
8 use Drupal\field\Entity\FieldStorageConfig;
11 * Tests the field itself of the Field integration.
15 * Check a entity-type with bundles
16 * Check a entity-type without bundles
17 * Check locale:disabled, locale:enabled and locale:enabled with another language
20 class HandlerFieldFieldTest extends FieldTestBase {
25 public static $modules = ['node', 'field_test'];
28 * Views used by this test.
32 public static $testViews = ['test_view_fieldapi'];
37 * @var \Drupal\node\NodeInterface[]
44 protected function setUp() {
47 // Setup basic fields.
48 $this->setUpFieldStorages(3);
50 // Setup a field with cardinality > 1.
51 $this->fieldStorages[3] = FieldStorageConfig::create([
52 'field_name' => 'field_name_3',
53 'entity_type' => 'node',
55 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
57 $this->fieldStorages[3]->save();
58 // Setup a field that will have no value.
59 $this->fieldStorages[4] = FieldStorageConfig::create([
60 'field_name' => 'field_name_4',
61 'entity_type' => 'node',
63 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
65 $this->fieldStorages[4]->save();
67 // Setup a text field.
68 $this->fieldStorages[5] = FieldStorageConfig::create([
69 'field_name' => 'field_name_5',
70 'entity_type' => 'node',
73 $this->fieldStorages[5]->save();
75 // Setup a text field with access control.
76 // @see field_test_entity_field_access()
77 $this->fieldStorages[6] = FieldStorageConfig::create([
78 'field_name' => 'field_no_view_access',
79 'entity_type' => 'node',
82 $this->fieldStorages[6]->save();
88 for ($i = 0; $i < 3; $i++) {
89 $edit = ['type' => 'page'];
91 foreach ([0, 1, 2, 5] as $key) {
92 $field_storage = $this->fieldStorages[$key];
93 $edit[$field_storage->getName()][0]['value'] = $this->randomMachineName(8);
95 // Add a hidden value for the no-view field.
96 $edit[$this->fieldStorages[6]->getName()][0]['value'] = 'ssh secret squirrel';
97 for ($j = 0; $j < 5; $j++) {
98 $edit[$this->fieldStorages[3]->getName()][$j]['value'] = $this->randomMachineName(8);
100 // Set this field to be empty.
101 $edit[$this->fieldStorages[4]->getName()] = [['value' => NULL]];
103 $this->nodes[$i] = $this->drupalCreateNode($edit);
106 $this->container->get('views.views_data')->clear();
110 * Sets up the testing view with random field data.
112 * @param \Drupal\views\ViewExecutable $view
113 * The view to add field data to.
115 protected function prepareView(ViewExecutable $view) {
116 $view->storage->invalidateCaches();
117 $view->initDisplay();
118 foreach ($this->fieldStorages as $field_storage) {
119 $field_name = $field_storage->getName();
120 $view->display_handler->options['fields'][$field_name]['id'] = $field_name;
121 $view->display_handler->options['fields'][$field_name]['table'] = 'node__' . $field_name;
122 $view->display_handler->options['fields'][$field_name]['field'] = $field_name;
126 public function testFieldRender() {
127 $this->_testSimpleFieldRender();
128 $this->_testInaccessibleFieldRender();
129 $this->_testFormatterSimpleFieldRender();
130 $this->_testMultipleFieldRender();
133 public function _testSimpleFieldRender() {
134 $view = Views::getView('test_view_fieldapi');
135 $this->prepareView($view);
136 $this->executeView($view);
138 // Tests that the rendered fields match the actual value of the fields.
139 for ($i = 0; $i < 3; $i++) {
140 for ($key = 0; $key < 2; $key++) {
141 $field_name = $this->fieldStorages[$key]->getName();
142 $rendered_field = $view->style_plugin->getField($i, $field_name);
143 $expected_field = $this->nodes[$i]->$field_name->value;
144 $this->assertEqual($rendered_field, $expected_field);
149 public function _testInaccessibleFieldRender() {
150 $view = Views::getView('test_view_fieldapi');
151 $this->prepareView($view);
152 $this->executeView($view);
154 // Check that the field handler for the hidden field is correctly removed
156 // @see https://www.drupal.org/node/2382931
157 $this->assertFalse(array_key_exists('field_no_view_access', $view->field));
159 // Check that the access-denied field is not visible.
160 for ($i = 0; $i < 3; $i++) {
161 $field_name = $this->fieldStorages[6]->getName();
162 $rendered_field = $view->style_plugin->getField($i, $field_name);
163 $this->assertFalse($rendered_field, 'Hidden field not rendered');
168 * Tests that fields with formatters runs as expected.
170 public function _testFormatterSimpleFieldRender() {
171 $view = Views::getView('test_view_fieldapi');
172 $this->prepareView($view);
173 $view->displayHandlers->get('default')->options['fields'][$this->fieldStorages[5]->getName()]['type'] = 'text_trimmed';
174 $view->displayHandlers->get('default')->options['fields'][$this->fieldStorages[5]->getName()]['settings'] = [
177 $this->executeView($view);
179 // Make sure that the formatter works as expected.
180 // @TODO: actually there should be a specific formatter.
181 for ($i = 0; $i < 2; $i++) {
182 $rendered_field = $view->style_plugin->getField($i, $this->fieldStorages[5]->getName());
183 $this->assertEqual(strlen(html_entity_decode($rendered_field)), 3);
187 public function _testMultipleFieldRender() {
188 $view = Views::getView('test_view_fieldapi');
189 $field_name = $this->fieldStorages[3]->getName();
192 $this->prepareView($view);
193 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
194 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
195 $this->executeView($view);
197 for ($i = 0; $i < 3; $i++) {
198 $rendered_field = $view->style_plugin->getField($i, $field_name);
200 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
201 $pure_items = array_splice($pure_items, 0, 3);
202 foreach ($pure_items as $j => $item) {
203 $items[] = $pure_items[$j]['value'];
205 $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited.');
208 // Test that an empty field is rendered without error.
209 $view->style_plugin->getField(4, $this->fieldStorages[4]->getName());
212 // Test delta limit + offset
213 $this->prepareView($view);
214 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
215 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
216 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_offset'] = 1;
217 $this->executeView($view);
219 for ($i = 0; $i < 3; $i++) {
220 $rendered_field = $view->style_plugin->getField($i, $field_name);
222 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
223 $pure_items = array_splice($pure_items, 1, 3);
224 foreach ($pure_items as $j => $item) {
225 $items[] = $pure_items[$j]['value'];
227 $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited and the offset is correct.');
231 // Test delta limit + reverse.
232 $this->prepareView($view);
233 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_offset'] = 0;
234 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
235 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
236 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_reversed'] = TRUE;
237 $this->executeView($view);
239 for ($i = 0; $i < 3; $i++) {
240 $rendered_field = $view->style_plugin->getField($i, $field_name);
242 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
243 array_splice($pure_items, 0, -3);
244 $pure_items = array_reverse($pure_items);
245 foreach ($pure_items as $j => $item) {
246 $items[] = $pure_items[$j]['value'];
248 $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited and they are reversed.');
252 // Test delta first last.
253 $this->prepareView($view);
254 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
255 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 0;
256 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_first_last'] = TRUE;
257 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_reversed'] = FALSE;
258 $this->executeView($view);
260 for ($i = 0; $i < 3; $i++) {
261 $rendered_field = $view->style_plugin->getField($i, $field_name);
263 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
264 $items[] = $pure_items[0]['value'];
265 $items[] = $pure_items[4]['value'];
266 $this->assertEqual($rendered_field, implode(', ', $items), 'Items are limited to first and last.');
270 // Test delta limit + custom separator.
271 $this->prepareView($view);
272 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_first_last'] = FALSE;
273 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
274 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
275 $view->displayHandlers->get('default')->options['fields'][$field_name]['separator'] = ':';
276 $this->executeView($view);
278 for ($i = 0; $i < 3; $i++) {
279 $rendered_field = $view->style_plugin->getField($i, $field_name);
281 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
282 $pure_items = array_splice($pure_items, 0, 3);
283 foreach ($pure_items as $j => $item) {
284 $items[] = $pure_items[$j]['value'];
286 $this->assertEqual($rendered_field, implode(':', $items), 'The amount of items is limited and the custom separator is correct.');
290 // Test separator with HTML, ensure it is escaped.
291 $this->prepareView($view);
292 $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
293 $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
294 $view->displayHandlers->get('default')->options['fields'][$field_name]['separator'] = '<h2>test</h2>';
295 $this->executeView($view);
297 for ($i = 0; $i < 3; $i++) {
298 $rendered_field = $view->style_plugin->getField($i, $field_name);
300 $pure_items = $this->nodes[$i]->{$field_name}->getValue();
301 $pure_items = array_splice($pure_items, 0, 3);
302 foreach ($pure_items as $j => $item) {
303 $items[] = $pure_items[$j]['value'];
305 $this->assertEqual($rendered_field, implode('<h2>test</h2>', $items), 'The custom separator is correctly escaped.');