diff --git a/core/lib/Drupal/Core/Entity/EntityManager.php b/core/lib/Drupal/Core/Entity/EntityManager.php index fcba978..888fe41 100644 --- a/core/lib/Drupal/Core/Entity/EntityManager.php +++ b/core/lib/Drupal/Core/Entity/EntityManager.php @@ -857,7 +857,7 @@ public function getEntityTypeLabels($group = FALSE) { public function getTranslationFromContext(EntityInterface $entity, $langcode = NULL, $context = array()) { $translation = $entity; - if ($entity instanceof TranslatableInterface) { + if ($entity instanceof TranslatableInterface && count($entity->getTranslationLanguages()) > 1) { if (empty($langcode)) { $langcode = $this->languageManager->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId(); } diff --git a/core/lib/Drupal/Core/Field/FormatterInterface.php b/core/lib/Drupal/Core/Field/FormatterInterface.php index 4ba0efa..196fb89 100644 --- a/core/lib/Drupal/Core/Field/FormatterInterface.php +++ b/core/lib/Drupal/Core/Field/FormatterInterface.php @@ -60,7 +60,7 @@ public function settingsSummary(); * items. * * @param \Drupal\Core\Field\FieldItemListInterface[] $entities_items - * Array of field values, keyed by entity ID. + * An array with the field values from the multiple entities being rendered. */ public function prepareView(array $entities_items); diff --git a/core/modules/comment/src/Tests/Views/CommentUserNameTest.php b/core/modules/comment/src/Tests/Views/CommentUserNameTest.php index 2c64bb2..bf06be6 100644 --- a/core/modules/comment/src/Tests/Views/CommentUserNameTest.php +++ b/core/modules/comment/src/Tests/Views/CommentUserNameTest.php @@ -152,6 +152,8 @@ public function testUsername() { $account_switcher->switchTo(new AnonymousUserSession()); $executable = Views::getView($view_id); + $executable->storage->invalidateCaches(); + $build = $executable->preview(); $this->setRawContent($renderer->render($build)); diff --git a/core/modules/contact/src/Tests/Views/ContactLinkTest.php b/core/modules/contact/src/Tests/Views/ContactLinkTest.php index bb7fb91..d4f01b8 100644 --- a/core/modules/contact/src/Tests/Views/ContactLinkTest.php +++ b/core/modules/contact/src/Tests/Views/ContactLinkTest.php @@ -7,6 +7,7 @@ namespace Drupal\contact\Tests\Views; +use Drupal\Core\Cache\Cache; use Drupal\views\Tests\ViewTestBase; use Drupal\views\Tests\ViewTestData; @@ -83,6 +84,8 @@ public function testContactLink() { // Disable contact link for no_contact. $this->userData->set('contact', $no_contact_account->id(), 'enabled', FALSE); + // @todo Remove cache invalidation in https://www.drupal.org/node/2477903. + Cache::invalidateTags($no_contact_account->getCacheTags()); $this->drupalGet('test-contact-link'); $this->assertContactLinks($accounts, array('root', 'admin')); } diff --git a/core/modules/contact/tests/modules/contact_test_views/test_views/views.view.test_contact_link.yml b/core/modules/contact/tests/modules/contact_test_views/test_views/views.view.test_contact_link.yml index 28b74c8..339f4ff 100644 --- a/core/modules/contact/tests/modules/contact_test_views/test_views/views.view.test_contact_link.yml +++ b/core/modules/contact/tests/modules/contact_test_views/test_views/views.view.test_contact_link.yml @@ -3,12 +3,13 @@ status: true dependencies: module: - contact + - user id: test_contact_link label: test_contact_link module: views description: '' tag: '' -base_table: users +base_table: users_field_data base_field: uid core: 8.x display: @@ -69,7 +70,7 @@ display: fields: name: id: name - table: users + table: users_field_data field: name label: '' alter: @@ -111,7 +112,7 @@ display: filters: status: value: true - table: users + table: users_field_data field: status id: status expose: @@ -127,10 +128,22 @@ display: empty: { } relationships: { } arguments: { } + display_extenders: { } + cache_metadata: + contexts: + - 'languages:language_content' + - 'languages:language_interface' + cacheable: false page_1: display_plugin: page id: page_1 display_title: Page position: 1 display_options: + display_extenders: { } path: test-contact-link + cache_metadata: + contexts: + - 'languages:language_content' + - 'languages:language_interface' + cacheable: false diff --git a/core/modules/dblog/src/Tests/Views/ViewsIntegrationTest.php b/core/modules/dblog/src/Tests/Views/ViewsIntegrationTest.php index e934e0f..c7f3797 100644 --- a/core/modules/dblog/src/Tests/Views/ViewsIntegrationTest.php +++ b/core/modules/dblog/src/Tests/Views/ViewsIntegrationTest.php @@ -100,6 +100,7 @@ public function testIntegration() { // Disable replacing variables and check that the tokens aren't replaced. $view->destroy(); + $view->storage->invalidateCaches(); $view->initHandlers(); $this->executeView($view); $view->initStyle(); diff --git a/core/modules/field/src/Tests/Views/HandlerFieldFieldTest.php b/core/modules/field/src/Tests/Views/HandlerFieldFieldTest.php index 92353f0..f3be429 100644 --- a/core/modules/field/src/Tests/Views/HandlerFieldFieldTest.php +++ b/core/modules/field/src/Tests/Views/HandlerFieldFieldTest.php @@ -117,6 +117,7 @@ protected function setUp() { * The view to add field data to. */ protected function prepareView(ViewExecutable $view) { + $view->storage->invalidateCaches(); $view->initDisplay(); foreach ($this->fieldStorages as $field_storage) { $field_name = $field_storage->getName(); @@ -205,7 +206,7 @@ public function _testMultipleFieldRender() { foreach ($pure_items as $j => $item) { $items[] = $pure_items[$j]['value']; } - $this->assertEqual($rendered_field, implode(', ', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited.'); } // Test that an empty field is rendered without error. @@ -227,7 +228,7 @@ public function _testMultipleFieldRender() { foreach ($pure_items as $j => $item) { $items[] = $pure_items[$j]['value']; } - $this->assertEqual($rendered_field, implode(', ', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited and the offset is correct.'); } $view->destroy(); @@ -248,7 +249,7 @@ public function _testMultipleFieldRender() { foreach ($pure_items as $j => $item) { $items[] = $pure_items[$j]['value']; } - $this->assertEqual($rendered_field, implode(', ', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode(', ', $items), 'The amount of items is limited and they are reversed.'); } $view->destroy(); @@ -266,7 +267,7 @@ public function _testMultipleFieldRender() { $pure_items = $this->nodes[$i]->{$field_name}->getValue(); $items[] = $pure_items[0]['value']; $items[] = $pure_items[4]['value']; - $this->assertEqual($rendered_field, implode(', ', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode(', ', $items), 'Items are limited to first and last.'); } $view->destroy(); @@ -286,7 +287,7 @@ public function _testMultipleFieldRender() { foreach ($pure_items as $j => $item) { $items[] = $pure_items[$j]['value']; } - $this->assertEqual($rendered_field, implode(':', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode(':', $items), 'The amount of items is limited and the custom separator is correct.'); } $view->destroy(); @@ -305,7 +306,7 @@ public function _testMultipleFieldRender() { foreach ($pure_items as $j => $item) { $items[] = $pure_items[$j]['value']; } - $this->assertEqual($rendered_field, implode('

test

', $items), 'Make sure that the amount of items is limited.'); + $this->assertEqual($rendered_field, implode('

test

', $items), 'The custom separator is correctly escaped.'); } $view->destroy(); } diff --git a/core/modules/system/src/Tests/Entity/EntityTranslationTest.php b/core/modules/system/src/Tests/Entity/EntityTranslationTest.php index c8549e6..7d513eb 100644 --- a/core/modules/system/src/Tests/Entity/EntityTranslationTest.php +++ b/core/modules/system/src/Tests/Entity/EntityTranslationTest.php @@ -383,10 +383,20 @@ protected function doTestEntityTranslationAPI($entity_type) { // Verify that changing the default translation flag causes an exception to // be thrown. - $message = 'The default translation flag cannot be changed.'; foreach ($entity->getTranslationLanguages() as $t_langcode => $language) { $translation = $entity->getTranslation($t_langcode); $default = $translation->isDefaultTranslation(); + + $message = 'The default translation flag can be reassigned the same value.'; + try { + $translation->{$default_langcode_key}->value = $default; + $this->pass($message); + } + catch (\LogicException $e) { + $this->fail($message); + } + + $message = 'The default translation flag cannot be changed.'; try { $translation->{$default_langcode_key}->value = !$default; $this->fail($message); @@ -394,6 +404,7 @@ protected function doTestEntityTranslationAPI($entity_type) { catch (\LogicException $e) { $this->pass($message); } + $this->assertEqual($translation->{$default_langcode_key}->value, $default); } diff --git a/core/modules/system/tests/modules/entity_test/entity_test.views.inc b/core/modules/system/tests/modules/entity_test/entity_test.views.inc new file mode 100644 index 0000000..d74af47 --- /dev/null +++ b/core/modules/system/tests/modules/entity_test/entity_test.views.inc @@ -0,0 +1,9 @@ +storage->getDisplay('default'); $display['display_options']['fields']['name']['convert_spaces'] = TRUE; - + $view->storage->invalidateCaches(); $this->executeView($view); $this->assertEqual(str_replace(' ', '-', $this->term1->getName()), $view->getStyle()->getField(0, 'name')); $this->assertEqual($this->term2->getName(), $view->getStyle()->getField(1, 'name')); - } } diff --git a/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php b/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php index 9ce52f2..c2c0c93 100644 --- a/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php +++ b/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php @@ -33,6 +33,7 @@ public function testUserName() { $view->field['name']->options['link_to_user'] = TRUE; $view->field['name']->options['type'] = 'user_name'; $view->field['name']->init($view, $view->getDisplay('default')); + $view->field['name']->options['id'] = 'name'; $this->executeView($view); $anon_name = $this->config('user.settings')->get('anonymous'); diff --git a/core/modules/views/src/Entity/Render/ConfigurableLanguageRenderer.php b/core/modules/views/src/Entity/Render/ConfigurableLanguageRenderer.php index 8470efd..697ae8a 100644 --- a/core/modules/views/src/Entity/Render/ConfigurableLanguageRenderer.php +++ b/core/modules/views/src/Entity/Render/ConfigurableLanguageRenderer.php @@ -15,7 +15,7 @@ /** * Renders entities in a configured language. */ -class ConfigurableLanguageRenderer extends RendererBase { +class ConfigurableLanguageRenderer extends EntityTranslationRendererBase { /** * A specific language code for rendering if available. diff --git a/core/modules/views/src/Entity/Render/DefaultLanguageRenderer.php b/core/modules/views/src/Entity/Render/DefaultLanguageRenderer.php index bab75d8..dbd3a72 100644 --- a/core/modules/views/src/Entity/Render/DefaultLanguageRenderer.php +++ b/core/modules/views/src/Entity/Render/DefaultLanguageRenderer.php @@ -12,7 +12,7 @@ /** * Renders entities in their default language. */ -class DefaultLanguageRenderer extends RendererBase { +class DefaultLanguageRenderer extends EntityTranslationRendererBase { /** * {@inheritdoc} diff --git a/core/modules/views/src/Entity/Render/EntityFieldRenderer.php b/core/modules/views/src/Entity/Render/EntityFieldRenderer.php new file mode 100644 index 0000000..d5f6e68 --- /dev/null +++ b/core/modules/views/src/Entity/Render/EntityFieldRenderer.php @@ -0,0 +1,293 @@ +relationship = $relationship; + $this->entityManager = $entity_manager; + } + + /** + * {@inheritdoc} + */ + public function getCacheContexts() { + return $this->getEntityTranslationRenderer()->getCacheContexts(); + } + + /** + * {@inheritdoc} + */ + public function getEntityTypeId() { + return $this->entityType->id(); + } + + /** + * {@inheritdoc} + */ + protected function getEntityManager() { + return $this->entityManager; + } + + /** + * {@inheritdoc} + */ + + protected function getLanguageManager() { + return $this->languageManager; + } + + /** + * {@inheritdoc} + */ + protected function getView() { + return $this->view; + } + + /** + * {@inheritdoc} + */ + public function query(QueryPluginBase $query, $relationship = NULL) { + $this->getEntityTranslationRenderer()->query($query, $relationship); + } + + /** + * Builds the render arrays for all fields of all result rows. + * + * The output is built using EntityViewDisplay objects to leverage + * multiple-entity building and ensure a common code path with regular entity + * view. + * - Each relationship is handled by a separate EntityFieldRenderer instance, + * since it operates on its own set of entities. This also ensures different + * entity types are handled separately, as they imply different + * relationships. + * - Within each relationship, the fields to render are arranged in unique + * sets containing each field at most once (an EntityViewDisplay can + * only process a field once with given display options, but a View can + * contain the same field several times with different display options). + * - For each set of fields, entities are processed by bundle, so that + * formatters can operate on the proper field definition for the bundle. + * + * @param \Drupal\views\ResultRow[] $values + * An array of all ResultRow objects returned from the query. + * + * @return array + * A renderable array for the fields handled by this renderer. + * + * @see \Drupal\Core\Entity\Entity\EntityViewDisplay + */ + protected function buildFields(array $values) { + $build = []; + + if ($values && ($field_ids = $this->getRenderableFieldIds())) { + $entity_type_id = $this->getEntityTypeId(); + + // Collect the entities for the relationship, fetch the right translation, + // and group by bundle. + $entities_by_bundles = []; + $field = $this->view->field[current($field_ids)]; + foreach ($values as $result_row) { + $entity = $field->getEntity($result_row); + $entities_by_bundles[$entity->bundle()][$result_row->index] = $this->getEntityTranslation($entity, $result_row); + } + + // Determine unique sets of fields that can be processed by the same + // display. Fields that appear several times in the View open additional + // "overflow" displays. + $display_sets = []; + foreach ($field_ids as $field_id) { + $field = $this->view->field[$field_id]; + $index = 0; + while (isset($display_sets[$index][$field->definition['field_name']])) { + $index++; + } + $display_sets[$index][$field_id] = $field; + } + + // For each set of fields, build the output by bundle. + foreach ($display_sets as $display_fields) { + foreach ($entities_by_bundles as $bundle => $bundle_entities) { + // Create the display, and configure the field display options. + $display = EntityViewDisplay::create([ + 'targetEntityType' => $entity_type_id, + 'bundle' => $bundle, + 'status' => TRUE, + ]); + foreach ($display_fields as $field_id => $field) { + $display->setComponent($field->definition['field_name'], [ + 'type' => $field->options['type'], + 'settings' => $field->options['settings'], + ]); + } + // Let the display build the render array for the entities. + $display_build = $display->buildMultiple($bundle_entities); + // Collect the field render arrays and index them using our internal + // row indexes and field IDs. + foreach ($display_build as $row_index => $entity_build) { + foreach ($display_fields as $field_id => $field) { + $build[$row_index][$field_id] = !empty($entity_build[$field->definition['field_name']]) ? $entity_build[$field->definition['field_name']] : []; + } + } + } + } + } + + return $build; + } + + /** + * Returns a list of names of entity fields to be rendered. + * + * @return string[] + * An associative array of views fields. + */ + protected function getRenderableFieldIds() { + if (!isset($this->renderableFieldIds)) { + $this->renderableFieldIds = []; + foreach ($this->view->field as $field_id => $field) { + if ($field instanceof Field && $field->relationship == $this->relationship) { + $this->renderableFieldIds[] = $field_id; + } + } + } + return $this->renderableFieldIds; + } + + /** + * Returns the entity translation matching the configured row language. + * + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity object the field value being processed is attached to. + * @param \Drupal\views\ResultRow $row + * The result row the field value being processed belongs to. + * + * @return \Drupal\Core\Entity\FieldableEntityInterface + * The entity translation object for the specified row. + */ + protected function getEntityTranslation(EntityInterface $entity, ResultRow $row) { + // We assume the same language should be used for all entity fields + // belonging to a single row, even if they are attached to different entity + // types. Below we apply language fallback to ensure a valid value is always + // picked. + $langcode = $this->getEntityTranslationRenderer()->getLangcode($row); + return $this->entityManager->getTranslationFromContext($entity, $langcode); + } + + /** + * Renders entity field data. + * + * @param \Drupal\views\ResultRow $row + * A single row of the query result. + * @param \Drupal\views\Plugin\views\field\Field $field + * (optional) A field to be rendered. + * + * @return array + * A renderable array for the entity data contained in the result row. + */ + public function render(ResultRow $row, Field $field = NULL) { + // The method is called for each field in each result row. In order to + // leverage multiple-entity building of formatter output, we build the + // render arrays for all fields in all rows on the first call. + if (!isset($this->build)) { + $this->build = $this->buildFields($this->view->result); + } + + if (isset($field)) { + $field_id = $field->options['id']; + // Pick the render array for the row / field we are being asked to render, + // and remove it from $this->build to free memory as we progress. + if (isset($this->build[$row->index][$field_id])) { + $build = $this->build[$row->index][$field_id]; + unset($this->build[$row->index][$field_id]); + } + else { + // In the uncommon case where a field gets rendered several times + // (typically through direct Views API calls), the pre-computed render + // array was removed be the unset() above. We have to manually rebuild + // the render array for the row. + $build = $this->buildFields([$row])[$row->index][$field_id]; + } + } + else { + // Same logic as above, in the case where we are being called for a whole + // row. + if (isset($this->build[$row->index])) { + $build = $this->build[$row->index]; + unset($this->build[$row->index]); + } + else { + $build = $this->buildFields([$row])[$row->index]; + } + } + + return $build; + } + +} diff --git a/core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php b/core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php index 1be7364..9c6d330 100644 --- a/core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php +++ b/core/modules/views/src/Entity/Render/EntityTranslationRenderTrait.php @@ -10,25 +10,25 @@ use Drupal\views\Plugin\views\PluginBase; /** - * Trait used to instantiate the view's entity language render. + * Trait used to instantiate the view's entity translation renderer. */ trait EntityTranslationRenderTrait { /** * The renderer to be used to render the entity row. * - * @var \Drupal\views\Entity\Render\RendererBase + * @var \Drupal\views\Entity\Render\EntityTranslationRendererBase */ - protected $entityLanguageRenderer; + protected $entityTranslationRenderer; /** * Returns the current renderer. * - * @return \Drupal\views\Entity\Render\RendererBase + * @return \Drupal\views\Entity\Render\EntityTranslationRendererBase * The configured renderer. */ - protected function getEntityTranslationRenderer() { - if (!isset($this->entityLanguageRenderer)) { + public function getEntityTranslationRenderer() { + if (!isset($this->entityTranslationRenderer)) { $view = $this->getView(); $rendering_language = $view->display_handler->getOption('rendering_language'); $langcode = NULL; @@ -52,9 +52,9 @@ protected function getEntityTranslationRenderer() { } $class = '\Drupal\views\Entity\Render\\' . $renderer; $entity_type = $this->getEntityManager()->getDefinition($this->getEntityTypeId()); - $this->entityLanguageRenderer = new $class($view, $this->getLanguageManager(), $entity_type, $langcode); + $this->entityTranslationRenderer = new $class($view, $this->getLanguageManager(), $entity_type, $langcode); } - return $this->entityLanguageRenderer; + return $this->entityTranslationRenderer; } /** diff --git a/core/modules/views/src/Entity/Render/EntityTranslationRendererBase.php b/core/modules/views/src/Entity/Render/EntityTranslationRendererBase.php new file mode 100644 index 0000000..4da6672 --- /dev/null +++ b/core/modules/views/src/Entity/Render/EntityTranslationRendererBase.php @@ -0,0 +1,59 @@ +view->rowPlugin->entityManager->getViewBuilder($this->entityType->id()); + + /** @var \Drupal\views\ResultRow $row */ + foreach ($result as $row) { + // @todo Take relationships into account. + // See https://www.drupal.org/node/2457999. + $entity = $row->_entity; + $entity->view = $this->view; + $this->build[$entity->id()] = $view_builder->view($entity, $this->view->rowPlugin->options['view_mode'], $this->getLangcode($row)); + } + } + + /** + * {@inheritdoc} + */ + public function render(ResultRow $row) { + $entity_id = $row->_entity->id(); + return $this->build[$entity_id]; + } + +} diff --git a/core/modules/views/src/Entity/Render/RendererBase.php b/core/modules/views/src/Entity/Render/RendererBase.php index a0baec6..deb1806 100644 --- a/core/modules/views/src/Entity/Render/RendererBase.php +++ b/core/modules/views/src/Entity/Render/RendererBase.php @@ -8,7 +8,6 @@ namespace Drupal\views\Entity\Render; use Drupal\Core\Entity\EntityTypeInterface; -use Drupal\Core\Language\LanguageInterface; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\views\Plugin\CacheablePluginInterface; use Drupal\views\Plugin\views\query\QueryPluginBase; @@ -16,7 +15,7 @@ use Drupal\views\ViewExecutable; /** - * Defines a base class for entity row renderers. + * Defines a base class for entity renderers. */ abstract class RendererBase implements CacheablePluginInterface { @@ -46,7 +45,7 @@ * * @var array */ - protected $build = array(); + protected $build; /** * Constructs a renderer object. @@ -79,17 +78,6 @@ public function getCacheContexts() { } /** - * Returns the language code associated to the given row. - * - * @param \Drupal\views\ResultRow $row - * The result row. - * - * @return string - * A language code. - */ - abstract public function getLangcode(ResultRow $row); - - /** * Alters the query if needed. * * @param \Drupal\views\Plugin\views\query\QueryPluginBase $query @@ -97,38 +85,26 @@ public function getCacheContexts() { * @param string $relationship * (optional) The relationship, used by a field. */ - public function query(QueryPluginBase $query, $relationship = NULL) { - } + abstract public function query(QueryPluginBase $query, $relationship = NULL); /** - * Runs before each row is rendered. + * Runs before each entity is rendered. * * @param $result * The full array of results from the query. */ public function preRender(array $result) { - $view_builder = $this->view->rowPlugin->entityManager->getViewBuilder($this->entityType->id()); - - /** @var \Drupal\views\ResultRow $row */ - foreach ($result as $row) { - $entity = $row->_entity; - $entity->view = $this->view; - $this->build[$entity->id()] = $view_builder->view($entity, $this->view->rowPlugin->options['view_mode'], $this->getLangcode($row)); - } } /** - * Renders a row object. + * Renders entity data. * * @param \Drupal\views\ResultRow $row * A single row of the query result. * * @return array - * The renderable array of a single row. + * A renderable array for the entity data contained in the result row. */ - public function render(ResultRow $row) { - $entity_id = $row->_entity->id(); - return $this->build[$entity_id]; - } + abstract public function render(ResultRow $row); } diff --git a/core/modules/views/src/Entity/Render/TranslationLanguageRenderer.php b/core/modules/views/src/Entity/Render/TranslationLanguageRenderer.php index cf0c296..c94243b 100644 --- a/core/modules/views/src/Entity/Render/TranslationLanguageRenderer.php +++ b/core/modules/views/src/Entity/Render/TranslationLanguageRenderer.php @@ -12,9 +12,9 @@ use Drupal\views\ResultRow; /** - * Renders entity translations in their active language. + * Renders entity translations in their row language. */ -class TranslationLanguageRenderer extends RendererBase { +class TranslationLanguageRenderer extends EntityTranslationRendererBase { /** * Stores the field alias of the langcode column. diff --git a/core/modules/views/src/Entity/View.php b/core/modules/views/src/Entity/View.php index 34b4ab0..36bb9be 100644 --- a/core/modules/views/src/Entity/View.php +++ b/core/modules/views/src/Entity/View.php @@ -333,6 +333,7 @@ public function postSave(EntityStorageInterface $storage, $update = TRUE) { // @todo Remove if views implements a view_builder controller. views_invalidate_cache(); + $this->invalidateCaches(); // Rebuild the router if this is a new view, or it's status changed. if (!isset($this->original) || ($this->status() != $this->original->status())) { @@ -448,4 +449,13 @@ public function __sleep() { return $keys; } + /** + * Invalidates cache tags. + */ + public function invalidateCaches() { + // Invalidate cache tags for cached rows. + $tags = $this->getCacheTags(); + \Drupal::service('cache_tags.invalidator')->invalidateTags($tags); + } + } diff --git a/core/modules/views/src/Plugin/views/field/Field.php b/core/modules/views/src/Plugin/views/field/Field.php index 5013b21..8b6b4e0 100644 --- a/core/modules/views/src/Plugin/views/field/Field.php +++ b/core/modules/views/src/Plugin/views/field/Field.php @@ -17,13 +17,12 @@ use Drupal\Core\Field\FormatterPluginManager; use Drupal\Core\Form\FormHelper; use Drupal\Core\Form\FormStateInterface; -use Drupal\Core\Language\LanguageInterface; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\Core\Render\Element; use Drupal\Core\Render\RendererInterface; use Drupal\Core\Session\AccountInterface; use Drupal\views\FieldAPIHandlerTrait; -use Drupal\views\Entity\Render\EntityTranslationRenderTrait; +use Drupal\views\Entity\Render\EntityFieldRenderer; use Drupal\views\Plugin\CacheablePluginInterface; use Drupal\views\Plugin\views\display\DisplayPluginBase; use Drupal\views\ResultRow; @@ -31,7 +30,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * A field that displays fieldapi fields. + * A field that displays entity field data. * * @ingroup views_field_handlers * @@ -40,8 +39,6 @@ * @ViewsField("field") */ class Field extends FieldPluginBase implements CacheablePluginInterface, MultiItemsFieldHandlerInterface { - use EntityTranslationRenderTrait; - use FieldAPIHandlerTrait; /** @@ -115,6 +112,13 @@ class Field extends FieldPluginBase implements CacheablePluginInterface, MultiIt protected $fieldTypePluginManager; /** + * Static cache for ::getEntityFieldRenderer(). + * + * @var \Drupal\views\Entity\Render\EntityFieldRenderer + */ + protected $entityFieldRenderer; + + /** * Constructs a \Drupal\field\Plugin\views\field\Field object. * * @param array $configuration @@ -202,13 +206,6 @@ public function init(ViewExecutable $view, DisplayPluginBase $display, array &$o /** * {@inheritdoc} */ - public function getEntityTypeId() { - return $this->getEntityType(); - } - - /** - * {@inheritdoc} - */ protected function getEntityManager() { return $this->entityManager; } @@ -216,19 +213,6 @@ protected function getEntityManager() { /** * {@inheritdoc} */ - protected function getLanguageManager() { - return $this->languageManager; - } - /** - * {@inheritdoc} - */ - protected function getView() { - return $this->view; - } - - /** - * {@inheritdoc} - */ public function access(AccountInterface $account) { $access_control_handler = $this->entityManager->getAccessControlHandler($this->getEntityType()); return $access_control_handler->fieldAccess('view', $this->getFieldDefinition(), $account); @@ -272,8 +256,8 @@ public function query($use_groupby = FALSE) { $this->addAdditionalFields($fields); } - // Let the configured entity translation renderer alter the query if needed. - $this->getEntityTranslationRenderer()->query($this->query, $this->relationship); + // Let the entity field renderer alter the query if needed. + $this->getEntityFieldRenderer()->query($this->query, $this->relationship); } /** @@ -686,6 +670,7 @@ public function submitGroupByForm(&$form, FormStateInterface $form_state) { */ public function renderItems($items) { if (!empty($items)) { + $items = $this->prepareItemsByDelta($items); if ($this->options['multi_type'] == 'separator' || !$this->options['group_rows']) { $separator = $this->options['multi_type'] == 'separator' ? SafeMarkup::checkAdminXss($this->options['separator']) : ''; $build = [ @@ -707,6 +692,118 @@ public function renderItems($items) { } /** + * Adapts the $items according to the delta configuration. + * + * This selects displayed deltas, reorders items, and takes offsets into + * account. + * + * @param array $all_values + * The items for individual rendering. + * + * @return array + * The manipulated items. + */ + protected function prepareItemsByDelta(array $all_values) { + if ($this->options['delta_reversed']) { + $all_values = array_reverse($all_values); + } + + // We are supposed to show only certain deltas. + if ($this->limit_values) { + $row = $this->view->result[$this->view->row_index]; + + // Offset is calculated differently when row grouping for a field is not + // enabled. Since there are multiple rows, delta needs to be taken into + // account, so that different values are shown per row. + if (!$this->options['group_rows'] && isset($this->aliases['delta']) && isset($row->{$this->aliases['delta']})) { + $delta_limit = 1; + $offset = $row->{$this->aliases['delta']}; + } + // Single fields don't have a delta available so choose 0. + elseif (!$this->options['group_rows'] && !$this->multiple) { + $delta_limit = 1; + $offset = 0; + } + else { + $delta_limit = $this->options['delta_limit']; + $offset = intval($this->options['delta_offset']); + + // We should only get here in this case if there is an offset, and in + // that case we are limiting to all values after the offset. + if ($delta_limit === 0) { + $delta_limit = count($all_values) - $offset; + } + } + + // Determine if only the first and last values should be shown. + $delta_first_last = $this->options['delta_first_last']; + + $new_values = array(); + for ($i = 0; $i < $delta_limit; $i++) { + $new_delta = $offset + $i; + + if (isset($all_values[$new_delta])) { + // If first-last option was selected, only use the first and last + // values. + if (!$delta_first_last + // Use the first value. + || $new_delta == $offset + // Use the last value. + || $new_delta == ($delta_limit + $offset - 1)) { + $new_values[] = $all_values[$new_delta]; + } + } + } + $all_values = $new_values; + } + + return $all_values; + } + + /** + * {@inheritdoc} + */ + public function alterRowIdData(array& $data, ResultRow $row) { + if (!isset($data['entity_langcode'])) { + $data['entity_langcode'] = $this->getEntityFieldRenderer() + ->getEntityTranslationRenderer() + ->getLangcode($row); + } + } + + /** + * {@inheritdoc} + */ + public function preRender(&$values) { + parent::preRender($values); + $this->getEntityFieldRenderer()->preRender($values); + } + + /** + * Returns the entity field renderer. + * + * @return \Drupal\views\Entity\Render\EntityFieldRenderer + * The entity field renderer. + */ + protected function getEntityFieldRenderer() { + if (!isset($this->entityFieldRenderer[$this->relationship])) { + if (!empty($this->view->field)) { + foreach ($this->view->field as $field) { + if ($field instanceof Field && isset($field->entityFieldRenderer[$this->relationship])) { + $this->entityFieldRenderer[$this->relationship] = $field->entityFieldRenderer[$this->relationship]; + break; + } + } + } + if (!isset($this->entityFieldRenderer[$this->relationship])) { + $entity_type = $this->entityManager->getDefinition($this->getEntityType()); + $this->entityFieldRenderer[$this->relationship] = new EntityFieldRenderer($this->view, $this->relationship, $this->languageManager, $entity_type, $this->entityManager); + } + } + return $this->entityFieldRenderer[$this->relationship]; + } + + /** * Gets an array of items for the field. * * @param \Drupal\views\ResultRow $values @@ -716,38 +813,29 @@ public function renderItems($items) { * An array of items for the field. */ public function getItems(ResultRow $values) { - $original_entity = $this->getEntity($values); - if (!$original_entity) { - return array(); - } - $entity = $this->process_entity($values, $original_entity); - if (!$entity) { - return array(); - } + $build_list = $this->getEntityFieldRenderer()->render($values, $this); - $display = array( - 'type' => $this->options['type'], - 'settings' => $this->options['settings'], - 'label' => 'hidden', - ); - $render_array = $entity->get($this->definition['field_name'])->view($display); + if (!$build_list) { + return []; + } if ($this->options['field_api_classes']) { - return array(array('rendered' => $this->renderer->render($render_array))); + return [['rendered' => $this->renderer->render($build_list)]]; } - $items = array(); - foreach (Element::children($render_array) as $delta) { - $items[$delta]['rendered'] = $render_array[$delta]; + // Render using the formatted data itself. + $items = []; + foreach (Element::children($build_list) as $delta) { + $items[$delta]['rendered'] = $build_list[$delta]; // Merge the cacheability metadata of the top-level render array into // each child because they will most likely be rendered individually. - if (isset($render_array['#cache'])) { - CacheableMetadata::createFromRenderArray($render_array) + if (isset($build_list['#cache'])) { + CacheableMetadata::createFromRenderArray($build_list) ->merge(CacheableMetadata::createFromRenderArray($items[$delta]['rendered'])) ->applyTo($items[$delta]['rendered']); } // Add the raw field items (for use in tokens). - $items[$delta]['raw'] = $render_array['#items'][$delta]; + $items[$delta]['raw'] = $build_list['#items'][$delta]; } return $items; } @@ -762,15 +850,15 @@ public function getItems(ResultRow $values) { * The result row object containing the values. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity to be processed. + * @param bool $clone + * (optional) Whether a clone of the specified entity should processed. + * Defaults to TRUE. * - * @return - * TRUE if the processing completed successfully, otherwise FALSE. + * @return bool|\Drupal\Core\Entity\FieldableEntityInterface + * Returns the processed entity if successful, else returns FALSE. */ - function process_entity(ResultRow $values, EntityInterface $entity) { - $processed_entity = clone $entity; - - $langcode = $this->getFieldLangcode($processed_entity, $values); - $processed_entity = $processed_entity->getTranslation($langcode); + public function processEntity(ResultRow $values, EntityInterface $entity, $clone = TRUE) { + $processed_entity = $clone ? clone $entity : $entity; // If we are grouping, copy our group fields into the cloned entity. // It's possible this will cause some weirdness, but there's only @@ -808,57 +896,6 @@ function process_entity(ResultRow $values, EntityInterface $entity) { return FALSE; } - // We are supposed to show only certain deltas. - if ($this->limit_values && !empty($processed_entity->{$this->definition['field_name']})) { - $all_values = !empty($processed_entity->{$this->definition['field_name']}) ? $processed_entity->{$this->definition['field_name']}->getValue() : array(); - if ($this->options['delta_reversed']) { - $all_values = array_reverse($all_values); - } - - // Offset is calculated differently when row grouping for a field is - // not enabled. Since there are multiple rows, the delta needs to be - // taken into account, so that different values are shown per row. - if (!$this->options['group_rows'] && isset($this->aliases['delta']) && isset($values->{$this->aliases['delta']})) { - $delta_limit = 1; - $offset = $values->{$this->aliases['delta']}; - } - // Single fields don't have a delta available so choose 0. - elseif (!$this->options['group_rows'] && !$this->multiple) { - $delta_limit = 1; - $offset = 0; - } - else { - $delta_limit = $this->options['delta_limit']; - $offset = intval($this->options['delta_offset']); - - // We should only get here in this case if there's an offset, and - // in that case we're limiting to all values after the offset. - if ($delta_limit === 0) { - $delta_limit = count($all_values) - $offset; - } - } - - // Determine if only the first and last values should be shown - $delta_first_last = $this->options['delta_first_last']; - - $new_values = array(); - for ($i = 0; $i < $delta_limit; $i++) { - $new_delta = $offset + $i; - - if (isset($all_values[$new_delta])) { - // If first-last option was selected, only use the first and last values - if (!$delta_first_last - // Use the first value. - || $new_delta == $offset - // Use the last value. - || $new_delta == ($delta_limit + $offset - 1)) { - $new_values[] = $all_values[$new_delta]; - } - } - } - $processed_entity->{$this->definition['field_name']} = $new_values; - } - return $processed_entity; } @@ -897,39 +934,6 @@ protected function addSelfTokens(&$tokens, $item) { } /** - * Return the code of the language the field should be displayed in. - * - * @param \Drupal\Core\Entity\EntityInterface $entity - * The entity object the field value being processed is attached to. - * @param \Drupal\views\ResultRow $row - * The result row the field value being processed belongs to. - * - * @return string - * The field language code. - */ - protected function getFieldLangcode(EntityInterface $entity, ResultRow $row) { - if ($this->getFieldDefinition()->isTranslatable()) { - // Even if the current field is not attached to the main entity, we use it - // to determine the field language, as we assume the same language should - // be used for all values belonging to a single row, when possible. Below - // we apply language fallback to ensure a valid value is always picked. - $langcode = $this->getEntityTranslationRenderer()->getLangcode($row); - - // Give the Entity Field API a chance to fallback to a different language - // (or LanguageInterface::LANGCODE_NOT_SPECIFIED), in case the field has - // no data for the selected language. FieldItemListInterface::view() does - // this as well, but since the returned language code is used before - // calling it, the fallback needs to happen explicitly. - $langcode = $this->entityManager->getTranslationFromContext($entity, $langcode)->language()->getId(); - - return $langcode; - } - else { - return LanguageInterface::LANGCODE_NOT_SPECIFIED; - } - } - - /** * {@inheritdoc} */ public function calculateDependencies() { @@ -958,9 +962,7 @@ public function isCacheable() { * {@inheritdoc} */ public function getCacheContexts() { - $contexts = $this->getEntityTranslationRenderer()->getCacheContexts(); - - return $contexts; + return $this->getEntityFieldRenderer()->getCacheContexts(); } /** @@ -977,11 +979,19 @@ protected function getTableMapping() { * {@inheritdoc} */ public function getValue(ResultRow $values, $field = NULL) { - if ($field === NULL) { - return $this->getEntity($values)->{$this->definition['field_name']}->value; + /** @var \Drupal\Core\Field\FieldItemListInterface $field_item_list */ + $field_item_list = $this->getEntity($values)->{$this->definition['field_name']}; + $field_item_definition = $field_item_list->getFieldDefinition(); + + if ($field_item_definition->getFieldStorageDefinition()->getCardinality() == 1) { + return $field ? $field_item_list->$field : $field_item_list->value; } - return $this->getEntity($values)->{$this->definition['field_name']}->$field; + $values = []; + foreach ($field_item_list as $field_item) { + $values[] = $field ? $field_item->$field : $field_item->value; + } + return $values; } } diff --git a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php index a6e388c..51d3273 100644 --- a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php +++ b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php @@ -1095,6 +1095,17 @@ public function adminSummary() { } /** + * Allows field handlers to alter data used to compute row unique identifiers. + * + * @param string[] $data + * The row cache keys data. + * @param \Drupal\views\ResultRow $row + * A result row. + */ + public function alterRowIdData(array& $data, ResultRow $row) { + } + + /** * {@inheritdoc} */ public function preRender(&$values) { } diff --git a/core/modules/views/src/Plugin/views/style/StylePluginBase.php b/core/modules/views/src/Plugin/views/style/StylePluginBase.php index c07a5b8..cdc733d 100644 --- a/core/modules/views/src/Plugin/views/style/StylePluginBase.php +++ b/core/modules/views/src/Plugin/views/style/StylePluginBase.php @@ -8,10 +8,13 @@ namespace Drupal\views\Plugin\views\style; use Drupal\Component\Utility\Html; +use Drupal\Component\Utility\SafeMarkup; +use Drupal\Core\Cache\Cache; use Drupal\Core\Form\FormStateInterface; -use Drupal\views\Plugin\views\PluginBase; use Drupal\views\Plugin\views\display\DisplayPluginBase; +use Drupal\views\Plugin\views\PluginBase; use Drupal\views\Plugin\views\wizard\WizardInterface; +use Drupal\views\ResultRow; use Drupal\views\ViewExecutable; /** @@ -625,6 +628,41 @@ public function renderGrouping($records, $groupings = array(), $group_rendered = return $sets; } + // @todo Copied from renderer for now. + protected function createCacheID(array $elements) { + // If the maximum age is zero, then caching is effectively prohibited. + if (isset($elements['#cache']['max-age']) && $elements['#cache']['max-age'] === 0) { + return FALSE; + } + + if (isset($elements['#cache']['keys'])) { + $cid_parts = $elements['#cache']['keys']; + if (!empty($elements['#cache']['contexts'])) { + $contexts = \Drupal::service('cache_contexts_manager')->convertTokensToKeys($elements['#cache']['contexts']); + $cid_parts = array_merge($cid_parts, $contexts); + } + return implode(':', $cid_parts); + } + return FALSE; + } + + /** + * TODO + */ + public function preRenderRow($build) { + $keys = array_keys($this->view->field); + $row = $build['#row']; + unset($build['#row']); + + foreach ($keys as $id) { + $build[$id] = ['#markup' => $this->view->field[$id]->theme($row)]; + } + + $build['#pre_rendered_row'] = TRUE; + + return $build; + } + /** * Renders all of the fields for a given style and store them on the object. * @@ -637,27 +675,165 @@ protected function renderFields(array $result) { } if (!isset($this->rendered_fields)) { - $this->rendered_fields = array(); + $this->rendered_fields = []; $this->view->row_index = 0; $keys = array_keys($this->view->field); // If all fields have a field::access FALSE there might be no fields, so // there is no reason to execute this code. if (!empty($keys)) { - foreach ($result as $count => $row) { - $this->view->row_index = $count; - foreach ($keys as $id) { - $this->rendered_fields[$count][$id] = $this->view->field[$id]->theme($row); + $renderer = $this->getRenderer(); + foreach ($result as $index => $row) { + // Here we implement render caching for result rows. Since we never + // build a render array for single rows, given that style templates + // need individual field markup to support proper theming, we build + // a raw render array containing all field render arrays and cache it, + // after manually pre-rendering it and discarding the global markup. + // This allow us to cache the markup of the various children, that is + // individual fields, which is then available for style template + // preprocess functions, later in the rendering workflow. + // @todo Fetch all the available cached row items in one single cache + // get operation, once https://www.drupal.org/node/2453945 is fixed. + $this->view->row_index = $index; + + // FIXME: Hack: Use render_cache ::cacheGet / ::cacheSet instead. + $element = [ + '#pre_render' => [ + [$this, 'preRenderRow'], + ], + '#row' => $row, + '#cache' => [ + 'tags' => $this->getRowCacheTags($row), + 'keys' => $this->getRowCacheKeys($row), + ], + ]; + // @todo Should use renderPlain, but that was broken before as fields + // are rendered to strings, so no need to fix it. + $renderer->render($element); + $data = $renderer->getCacheableRenderArray($element); + + // This will set the row into cache, but as raw #markup, but we need + // the individual fields. Fortunately we can detect that case and + // update the cache entry :). + if (!empty($element['#pre_rendered_row'])) { + foreach ($keys as $id) { + $data[$id] = $element[$id]['#markup']; + } + + // RendererInterface::getCacheableRenderArray() does not preserve + // cache keys. + $data['#cache']['keys'] = $element['#cache']['keys']; + + // Unset the big markup. + $data['#markup'] = ''; + + // FIXME: Copied from renderer::cacheSet. + $cid = $this->createCacheID($data); + $bin = isset($element['#cache']['bin']) ? $element['#cache']['bin'] : 'render'; + $expire = ($element['#cache']['max-age'] === Cache::PERMANENT) ? Cache::PERMANENT : (int) \Drupal::service('request_stack')->getMasterRequest()->server->get('REQUEST_TIME') + $element['#cache']['max-age']; + $cache = \Drupal::service('cache_factory')->get($bin); + + $view_cache_tag = 'config:' . $this->view->storage->getConfigDependencyName(); + $cache->set($cid, $data, $expire, Cache::mergeTags($data['#cache']['tags'], ['rendered', $view_cache_tag, $view_cache_tag . ':' . $this->displayHandler->display['id']])); } + else { + // This is exactly what we stored into cache earlier. + $data = $element; - $this->rowTokens[$count] = $this->view->field[$id]->getRenderTokens(array()); + // Restore SafeMarkup. + foreach ($keys as $id) { + $data[$id] = SafeMarkup::set($data[$id]); + } + } + + // Remove all render cache metadata now and store field output. + $this->rendered_fields[$index] = array_intersect_key($data, array_flip($keys)); + + $id = end($keys); + $this->rowTokens[$index] = $this->view->field[$id]->getRenderTokens(array()); } } + unset($this->view->row_index); } } /** + * Returns the row cache tags. + * + * @param \Drupal\views\ResultRow $row + * A result row. + * + * @return string[] + * The row cache tags. + */ + protected function getRowCacheTags(ResultRow $row) { + $tags = []; + $entities = []; + + if (!empty($row->_entity)) { + $entities[] = $row->_entity; + } + if (!empty($row->_relationship_entities)) { + $entities = array_merge($entities, $row->_relationship_entities); + } + + /** @var \Drupal\Core\Entity\EntityInterface $entity */ + foreach ($entities as $entity) { + $tags = Cache::mergeTags($tags, $entity->getCacheTags()); + } + + return $tags; + } + + /** + * Returns the row cache keys. + * + * @param \Drupal\views\ResultRow $row + * A result row. + * + * @return string[] + * The row cache keys. + */ + protected function getRowCacheKeys(ResultRow $row) { + return [ + 'views', + 'fields', + $this->view->id(), + $this->view->current_display, + $this->getRowId($row), + ]; + } + + /** + * Returns a unique identifier for the specified row. + * + * @param \Drupal\views\ResultRow $row + * A result row. + * + * @return string + * The row identifier. + */ + protected function getRowId(ResultRow $row) { + // Here we compute a unique identifier for the row by computing the hash of + // its data. We exclude the current index, since the same row could have a + // different result index depending on the user permissions. We exclude also + // entity data, since serializing entity objects is very expensive. Instead + // we include entity cache tags, which are enough to identify all the + // entities associated with the row. + $row_data = array_diff_key((array) $row, array_flip(['index', '_entity', '_relationship_entities'])) + $this->getRowCacheTags($row); + + // Additionally we allow field handlers to alter row data if that is + // required by their business logic. + foreach ($this->view->field as $field) { + $field->alterRowIdData($row_data, $row); + } + + // Finally we compute a hash of row data and return it as row identifier. + return hash('sha256', serialize($row_data)); + } + + /** * Gets a rendered field. * * @param int $index diff --git a/core/modules/views/src/Tests/Entity/RowEntityRenderersTest.php b/core/modules/views/src/Tests/Entity/RowEntityRenderersTest.php index 1d83776..6a8a12d 100644 --- a/core/modules/views/src/Tests/Entity/RowEntityRenderersTest.php +++ b/core/modules/views/src/Tests/Entity/RowEntityRenderersTest.php @@ -211,6 +211,7 @@ protected function checkLanguageRenderers($display, $values) { */ protected function assertTranslations($display, $renderer_id, array $expected, $message = '', $group = 'Other') { $view = Views::getView('test_entity_row_renderers'); + $view->storage->invalidateCaches(); $view->setDisplay($display); $view->getDisplay()->setOption('rendering_language', $renderer_id); $view->preview(); diff --git a/core/modules/views/src/Tests/Handler/FieldCounterTest.php b/core/modules/views/src/Tests/Handler/FieldCounterTest.php index 1290e67..fd17ffd 100644 --- a/core/modules/views/src/Tests/Handler/FieldCounterTest.php +++ b/core/modules/views/src/Tests/Handler/FieldCounterTest.php @@ -57,6 +57,7 @@ function testSimple() { $counter = $view->style_plugin->getField(2, 'counter'); $this->assertEqual($counter, 3, format_string('Make sure the expected number (@expected) patches with the rendered number (@counter)', array('@expected' => 3, '@counter' => $counter))); $view->destroy(); + $view->storage->invalidateCaches(); $view->setDisplay(); $rand_start = rand(5, 10); diff --git a/core/modules/views/src/Tests/Handler/FieldFieldTest.php b/core/modules/views/src/Tests/Handler/FieldFieldTest.php index 4982cdd..942379b 100644 --- a/core/modules/views/src/Tests/Handler/FieldFieldTest.php +++ b/core/modules/views/src/Tests/Handler/FieldFieldTest.php @@ -7,10 +7,12 @@ namespace Drupal\views\Tests\Handler; +use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\entity_test\Entity\EntityTest; use Drupal\entity_test\Entity\EntityTestRev; use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldStorageConfig; +use Drupal\user\Entity\User; use Drupal\views\Plugin\views\field\Field; use Drupal\views\Tests\ViewUnitTestBase; use Drupal\views\Views; @@ -31,7 +33,7 @@ class FieldFieldTest extends ViewUnitTestBase { /** * {@inheritdoc} */ - public static $testViews = ['test_field_field_test', 'test_field_field_revision_test']; + public static $testViews = ['test_field_field_test', 'test_field_alias_test', 'test_field_field_complex_test', 'test_field_field_revision_test', 'test_field_field_revision_complex_test']; /** * The stored test entities. @@ -48,14 +50,43 @@ class FieldFieldTest extends ViewUnitTestBase { protected $entityRevision; /** + * Stores a couple of test users. + * + * @var \Drupal\user\UserInterface[] + */ + protected $testUsers; + + /** + * The admin user. + * + * @var \Drupal\user\UserInterface + */ + protected $adminUser; + + /** * {@inheritdoc} */ protected function setUp() { parent::setUp(); $this->installEntitySchema('entity_test'); + $this->installEntitySchema('user'); $this->installEntitySchema('entity_test_rev'); + // Bypass any field access. + $this->adminUser = User::create(); + $this->adminUser->save(); + $this->container->get('current_user')->setAccount($this->adminUser); + + $this->testUsers = []; + for ($i = 0; $i < 5; $i++) { + $this->testUsers[$i] = User::create([ + 'name' => 'test ' . $i, + 'timezone' => User::getAllowedTimezones()[$i], + ]); + $this->testUsers[$i]->save(); + } + // Setup a field storage and field, but also change the views data for the // entity_test entity type. $field_storage = FieldStorageConfig::create([ @@ -72,11 +103,30 @@ protected function setUp() { ]); $field->save(); + $field_storage_multiple = FieldStorageConfig::create([ + 'field_name' => 'field_test_multiple', + 'type' => 'integer', + 'entity_type' => 'entity_test', + 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, + ]); + $field_storage_multiple->save(); + + $field_multiple = FieldConfig::create([ + 'field_name' => 'field_test_multiple', + 'entity_type' => 'entity_test', + 'bundle' => 'entity_test', + ]); + $field_multiple->save(); + $random_number = (string) 30856; + $random_number_multiple = (string) 1370359990; for ($i = 0; $i < 5; $i++) { $this->entities[$i] = $entity = EntityTest::create([ 'bundle' => 'entity_test', + 'name' => 'test ' . $i, 'field_test' => $random_number[$i], + 'field_test_multiple' => [$random_number_multiple[$i * 2], $random_number_multiple[$i * 2 + 1]], + 'user_id' => $this->testUsers[$i]->id(), ]); $entity->save(); } @@ -97,30 +147,58 @@ protected function setUp() { ]); $field->save(); + $field_storage_multiple = FieldStorageConfig::create([ + 'field_name' => 'field_test_multiple', + 'type' => 'integer', + 'entity_type' => 'entity_test_rev', + 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, + ]); + $field_storage_multiple->save(); + + $field_multiple = FieldConfig::create([ + 'field_name' => 'field_test_multiple', + 'entity_type' => 'entity_test_rev', + 'bundle' => 'entity_test_rev', + ]); + $field_multiple->save(); + $this->entityRevision = []; $this->entityRevision[0] = $entity = EntityTestRev::create([ 'name' => 'base value', 'field_test' => 1, + 'field_test_multiple' => [1, 3, 7], + 'user_id' => $this->testUsers[0]->id(), ]); $entity->save(); + $original_entity = clone $entity; - $entity = clone $entity; + $entity = clone $original_entity; $entity->setNewRevision(TRUE); $entity->name->value = 'revision value1'; $entity->field_test->value = 2; + $entity->field_test_multiple[0]->value = 0; + $entity->field_test_multiple[1]->value = 3; + $entity->field_test_multiple[2]->value = 5; + $entity->user_id->target_id = $this->testUsers[1]->id(); $entity->save(); $this->entityRevision[1] = $entity; - $entity = clone $entity; + $entity = clone $original_entity; $entity->setNewRevision(TRUE); $entity->name->value = 'revision value2'; $entity->field_test->value = 3; + $entity->field_test_multiple[0]->value = 9; + $entity->field_test_multiple[1]->value = 9; + $entity->field_test_multiple[2]->value = 9; + $entity->user_id->target_id = $this->testUsers[2]->id(); $entity->save(); $this->entityRevision[2] = $entity; - $this->entityRevision[0] = $entity = EntityTestRev::create([ + $this->entityRevision[3] = $entity = EntityTestRev::create([ 'name' => 'next entity value', 'field_test' => 4, + 'field_test_multiple' => [2, 9, 9], + 'user_id' => $this->testUsers[3]->id(), ]); $entity->save(); @@ -186,6 +264,114 @@ public function testSimpleRender() { } /** + * Tests the result of a view with complex field configuration. + * + * A complex field configuration contains multiple times the same field, with + * different delta limit / offset. + */ + public function testFieldAlias() { + $executable = Views::getView('test_field_alias_test'); + $executable->execute(); + + $this->assertTrue($executable->field['id'] instanceof Field); + $this->assertTrue($executable->field['name'] instanceof Field); + $this->assertTrue($executable->field['name_alias'] instanceof Field); + + $this->assertIdenticalResultset($executable, + [ + ['id' => 1, 'name' => 'test 0', 'name_alias' => 'test 0'], + ['id' => 2, 'name' => 'test 1', 'name_alias' => 'test 1'], + ['id' => 3, 'name' => 'test 2', 'name_alias' => 'test 2'], + ['id' => 4, 'name' => 'test 3', 'name_alias' => 'test 3'], + ['id' => 5, 'name' => 'test 4', 'name_alias' => 'test 4'], + ], + ['id' => 'id', 'name' => 'name', 'name_alias' => 'name_alias'] + ); + } + + /** + * Tests the result of a view with complex field configuration. + * + * A complex field configuration contains multiple times the same field, with + * different delta limit / offset. + */ + public function testFieldAliasRender() { + $executable = Views::getView('test_field_alias_test'); + $executable->execute(); + + for ($i = 0; $i < 5; $i++) { + $this->assertEqual($i + 1, $executable->getStyle()->getField($i, 'id')); + $this->assertEqual('test ' . $i, $executable->getStyle()->getField($i, 'name')); + $this->assertEqual('test ' . $i . '', $executable->getStyle()->getField($i, 'name_alias')); + } + } + + /** + * Tests the result of a view with complex field configuration. + * + * A complex field configuration contains multiple times the same field, with + * different delta limit / offset. + */ + public function testComplexExecute() { + $executable = Views::getView('test_field_field_complex_test'); + $executable->execute(); + + $timezones = []; + foreach ($this->testUsers as $user) { + $timezones[] = $user->getTimeZone(); + } + + $this->assertTrue($executable->field['field_test_multiple'] instanceof Field); + $this->assertTrue($executable->field['field_test_multiple_1'] instanceof Field); + $this->assertTrue($executable->field['field_test_multiple_2'] instanceof Field); + $this->assertTrue($executable->field['timezone'] instanceof Field); + + $this->assertIdenticalResultset($executable, + [ + ['timezone' => $timezones[0], 'field_test_multiple' => [1, 3], 'field_test_multiple_1' => [1, 3], 'field_test_multiple_2' => [1, 3]], + ['timezone' => $timezones[1], 'field_test_multiple' => [7, 0], 'field_test_multiple_1' => [7, 0], 'field_test_multiple_2' => [7, 0]], + ['timezone' => $timezones[2], 'field_test_multiple' => [3, 5], 'field_test_multiple_1' => [3, 5], 'field_test_multiple_2' => [3, 5]], + ['timezone' => $timezones[3], 'field_test_multiple' => [9, 9], 'field_test_multiple_1' => [9, 9], 'field_test_multiple_2' => [9, 9]], + ['timezone' => $timezones[4], 'field_test_multiple' => [9, 0], 'field_test_multiple_1' => [9, 0], 'field_test_multiple_2' => [9, 0]], + ], + ['timezone' => 'timezone', 'field_test_multiple' => 'field_test_multiple', 'field_test_multiple_1' => 'field_test_multiple_1', 'field_test_multiple_2' => 'field_test_multiple_2'] + ); + } + + /** + * Tests the output of a view with complex field configuration. + */ + public function testComplexRender() { + $executable = Views::getView('test_field_field_complex_test'); + $executable->execute(); + + $this->assertEqual($this->testUsers[0]->getTimeZone(), $executable->getStyle()->getField(0, 'timezone')); + $this->assertEqual("1, 3", $executable->getStyle()->getField(0, 'field_test_multiple')); + $this->assertEqual("1", $executable->getStyle()->getField(0, 'field_test_multiple_1')); + $this->assertEqual("3", $executable->getStyle()->getField(0, 'field_test_multiple_2')); + + $this->assertEqual($this->testUsers[1]->getTimeZone(), $executable->getStyle()->getField(1, 'timezone')); + $this->assertEqual("7, 0", $executable->getStyle()->getField(1, 'field_test_multiple')); + $this->assertEqual("7", $executable->getStyle()->getField(1, 'field_test_multiple_1')); + $this->assertEqual("0", $executable->getStyle()->getField(1, 'field_test_multiple_2')); + + $this->assertEqual($this->testUsers[2]->getTimeZone(), $executable->getStyle()->getField(2, 'timezone')); + $this->assertEqual("3, 5", $executable->getStyle()->getField(2, 'field_test_multiple')); + $this->assertEqual("3", $executable->getStyle()->getField(2, 'field_test_multiple_1')); + $this->assertEqual("5", $executable->getStyle()->getField(2, 'field_test_multiple_2')); + + $this->assertEqual($this->testUsers[3]->getTimeZone(), $executable->getStyle()->getField(3, 'timezone')); + $this->assertEqual("9, 9", $executable->getStyle()->getField(3, 'field_test_multiple')); + $this->assertEqual("9", $executable->getStyle()->getField(3, 'field_test_multiple_1')); + $this->assertEqual("9", $executable->getStyle()->getField(3, 'field_test_multiple_2')); + + $this->assertEqual($this->testUsers[4]->getTimeZone(), $executable->getStyle()->getField(4, 'timezone')); + $this->assertEqual("9, 0", $executable->getStyle()->getField(4, 'field_test_multiple')); + $this->assertEqual("9", $executable->getStyle()->getField(4, 'field_test_multiple_1')); + $this->assertEqual("0", $executable->getStyle()->getField(4, 'field_test_multiple_2')); + } + + /** * Tests the revision result. */ public function testRevisionExecute() { @@ -207,7 +393,7 @@ public function testRevisionExecute() { } /** - * Tests the output of a revision view with base fields and configurable fields. + * Tests the output of a revision view with base and configurable fields. */ public function testRevisionRender() { $executable = Views::getView('test_field_field_revision_test'); @@ -232,7 +418,93 @@ public function testRevisionRender() { $this->assertEqual(4, $executable->getStyle()->getField(3, 'revision_id')); $this->assertEqual(4, $executable->getStyle()->getField(3, 'field_test')); $this->assertEqual('next entity value', $executable->getStyle()->getField(3, 'name')); + } + + /** + * Tests the result set of a complex revision view. + */ + public function testRevisionComplexExecute() { + $executable = Views::getView('test_field_field_revision_complex_test'); + $executable->execute(); + + $timezones = []; + foreach ($this->testUsers as $user) { + $timezones[] = $user->getTimeZone(); + } + + $this->assertTrue($executable->field['id'] instanceof Field); + $this->assertTrue($executable->field['revision_id'] instanceof Field); + $this->assertTrue($executable->field['timezone'] instanceof Field); + $this->assertTrue($executable->field['field_test_multiple'] instanceof Field); + $this->assertTrue($executable->field['field_test_multiple_1'] instanceof Field); + $this->assertTrue($executable->field['field_test_multiple_2'] instanceof Field); + + $this->assertIdenticalResultset($executable, + [ + ['id' => 1, 'field_test' => 1, 'revision_id' => 1, 'uid' => $this->testUsers[0]->id(), 'timezone' => $timezones[0], 'field_test_multiple' => [1, 3, 7], 'field_test_multiple_1' => [1, 3, 7], 'field_test_multiple_2' => [1, 3, 7]], + ['id' => 1, 'field_test' => 2, 'revision_id' => 2, 'uid' => $this->testUsers[1]->id(), 'timezone' => $timezones[1], 'field_test_multiple' => [0, 3, 5], 'field_test_multiple_1' => [0, 3, 5], 'field_test_multiple_2' => [0, 3, 5]], + ['id' => 1, 'field_test' => 3, 'revision_id' => 3, 'uid' => $this->testUsers[2]->id(), 'timezone' => $timezones[2], 'field_test_multiple' => [9, 9, 9], 'field_test_multiple_1' => [9, 9, 9], 'field_test_multiple_2' => [9, 9, 9]], + ['id' => 2, 'field_test' => 4, 'revision_id' => 4, 'uid' => $this->testUsers[3]->id(), 'timezone' => $timezones[3], 'field_test_multiple' => [2, 9, 9], 'field_test_multiple_1' => [2, 9, 9], 'field_test_multiple_2' => [2, 9, 9]], + ], + ['entity_test_rev_revision_id' => 'id', 'revision_id' => 'revision_id', 'users_field_data_entity_test_rev_revision_uid' => 'uid', 'timezone' => 'timezone', 'field_test_multiple' => 'field_test_multiple', 'field_test_multiple_1' => 'field_test_multiple_1', 'field_test_multiple_2' => 'field_test_multiple_2'] + ); + } + + /** + * Tests the output of a revision view with base fields and configurable fields. + */ + public function testRevisionComplexRender() { + $executable = Views::getView('test_field_field_revision_complex_test'); + $executable->execute(); + + $this->assertEqual(1, $executable->getStyle()->getField(0, 'id')); + $this->assertEqual(1, $executable->getStyle()->getField(0, 'revision_id')); + $this->assertEqual($this->testUsers[0]->getTimeZone(), $executable->getStyle()->getField(0, 'timezone')); + $this->assertEqual('1, 3, 7', $executable->getStyle()->getField(0, 'field_test_multiple')); + $this->assertEqual('1', $executable->getStyle()->getField(0, 'field_test_multiple_1')); + $this->assertEqual('3, 7', $executable->getStyle()->getField(0, 'field_test_multiple_2')); + + $this->assertEqual(1, $executable->getStyle()->getField(1, 'id')); + $this->assertEqual(2, $executable->getStyle()->getField(1, 'revision_id')); + $this->assertEqual($this->testUsers[1]->getTimeZone(), $executable->getStyle()->getField(1, 'timezone')); + $this->assertEqual('0, 3, 5', $executable->getStyle()->getField(1, 'field_test_multiple')); + $this->assertEqual('0', $executable->getStyle()->getField(1, 'field_test_multiple_1')); + $this->assertEqual('3, 5', $executable->getStyle()->getField(1, 'field_test_multiple_2')); + + $this->assertEqual(1, $executable->getStyle()->getField(2, 'id')); + $this->assertEqual(3, $executable->getStyle()->getField(2, 'revision_id')); + $this->assertEqual($this->testUsers[2]->getTimeZone(), $executable->getStyle()->getField(2, 'timezone')); + $this->assertEqual('9, 9, 9', $executable->getStyle()->getField(2, 'field_test_multiple')); + $this->assertEqual('9', $executable->getStyle()->getField(2, 'field_test_multiple_1')); + $this->assertEqual('9, 9', $executable->getStyle()->getField(2, 'field_test_multiple_2')); + + $this->assertEqual(2, $executable->getStyle()->getField(3, 'id')); + $this->assertEqual(4, $executable->getStyle()->getField(3, 'revision_id')); + $this->assertEqual($this->testUsers[3]->getTimeZone(), $executable->getStyle()->getField(3, 'timezone')); + $this->assertEqual('2, 9, 9', $executable->getStyle()->getField(3, 'field_test_multiple')); + $this->assertEqual('2', $executable->getStyle()->getField(3, 'field_test_multiple_1')); + $this->assertEqual('9, 9', $executable->getStyle()->getField(3, 'field_test_multiple_2')); + } + + /** + * Tests that a field not available for every bundle is rendered as empty. + */ + public function testMissingBundleFieldRender() { + // Create a new bundle not having the test field attached. + $bundle = $this->randomMachineName(); + entity_test_create_bundle($bundle); + + $entity = EntityTest::create([ + 'type' => $bundle, + 'name' => $this->randomString(), + 'user_id' => $this->testUsers[0]->id(), + ]); + $entity->save(); + + $executable = Views::getView('test_field_field_test'); + $executable->execute(); + $this->assertIdentical('', $executable->getStyle()->getField(1, 'field_test')); } } diff --git a/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php b/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php index a5f18d2..2aa0e9c 100644 --- a/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php +++ b/core/modules/views/src/Tests/Handler/FieldGroupRowsTest.php @@ -85,8 +85,13 @@ public function testGroupRows() { // Test ungrouped rows. $this->executeView($view); + $view->render(); + + $view->row_index = 0; $this->assertEqual($view->field[$this->fieldName]->advancedRender($view->result[0]), 'a'); + $view->row_index = 1; $this->assertEqual($view->field[$this->fieldName]->advancedRender($view->result[1]), 'b'); + $view->row_index = 2; $this->assertEqual($view->field[$this->fieldName]->advancedRender($view->result[2]), 'c'); } diff --git a/core/modules/views/src/Tests/ViewResultAssertionTrait.php b/core/modules/views/src/Tests/ViewResultAssertionTrait.php index b8ad34f..f88c8c5 100644 --- a/core/modules/views/src/Tests/ViewResultAssertionTrait.php +++ b/core/modules/views/src/Tests/ViewResultAssertionTrait.php @@ -113,7 +113,18 @@ protected function assertIdenticalResultsetHelper($view, $expected_result, $colu $row = array(); foreach ($column_map as $expected_column) { // The comparison will be done on the string representation of the value. - $row[$expected_column] = (string) (is_object($value) ? $value->$expected_column : $value[$expected_column]); + if (is_object($value)) { + $row[$expected_column] = (string) $value->$expected_column; + } + // This case is about fields with multiple values. + elseif (is_array($value[$expected_column])) { + foreach (array_keys($value[$expected_column]) as $delta) { + $row[$expected_column][$delta] = (string) $value[$expected_column][$delta]; + } + } + else { + $row[$expected_column] = (string) $value[$expected_column]; + } } $expected_result[$key] = $row; } @@ -140,4 +151,3 @@ protected function assertIdenticalResultsetHelper($view, $expected_result, $colu } } - diff --git a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_alias_test.yml b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_alias_test.yml new file mode 100644 index 0000000..6e178cc --- /dev/null +++ b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_alias_test.yml @@ -0,0 +1,64 @@ +langcode: und +status: true +dependencies: { } +id: test_field_alias_test +module: views +description: '' +tag: '' +base_table: entity_test +base_field: id +core: '8' +display: + default: + display_options: + access: + type: none + cache: + type: none + fields: + id: + id: id + table: entity_test + field: id + plugin_id: field + entity_type: entity_test + entity_field: id + name: + id: name + table: entity_test + field: name + plugin_id: field + entity_type: entity_test + entity_field: name + type: string + settings: + link_to_entity: false + name_alias: + id: name_alias + table: entity_test + field: name_alias + plugin_id: field + entity_type: entity_test + entity_field: name + type: string + settings: + link_to_entity: true + relationships: + user_id: + table: entity_test + field: user_id + id: user_id + plugin_id: standard + sorts: + id: + id: id + table: entity_test + field: id + plugin_id: standard + order: asc + style: + type: html_list + display_plugin: default + display_title: Master + id: default + position: 0 diff --git a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_complex_test.yml b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_complex_test.yml new file mode 100644 index 0000000..58ee430 --- /dev/null +++ b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_complex_test.yml @@ -0,0 +1,79 @@ +langcode: und +status: true +dependencies: { } +id: test_field_field_complex_test +module: views +description: '' +tag: '' +base_table: entity_test +base_field: id +core: '8' +display: + default: + display_options: + access: + type: none + cache: + type: none + fields: + id: + id: id + table: entity_test + field: id + plugin_id: field + entity_type: entity_test + entity_field: id + field_test_multiple: + id: field_test_multiple + table: entity_test__field_test_multiple + field: field_test_multiple + plugin_id: field + entity_type: entity_test + entity_field: field_test_multiple + delta_limit: 0 + group_rows: true + field_test_multiple_1: + id: field_test_multiple_1 + table: entity_test__field_test_multiple + field: field_test_multiple + plugin_id: field + entity_type: entity_test + entity_field: field_test_multiple + delta_limit: 1 + group_rows: true + field_test_multiple_2: + id: field_test_multiple_2 + table: entity_test__field_test_multiple + field: field_test_multiple + plugin_id: field + entity_type: entity_test + entity_field: field_test_multiple + delta_limit: 0 + delta_offset: 1 + group_rows: true + timezone: + id: timezone + table: users_field_data + field: timezone + plugin_id: field + relationship: user_id + alter: {} + relationships: + user_id: + table: entity_test + field: user_id + id: user_id + plugin_id: standard + sorts: + id: + id: id + table: entity_test + field: id + plugin_id: standard + order: asc + style: + type: html_list + display_plugin: default + display_title: Master + id: default + position: 0 diff --git a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_complex_test.yml similarity index 50% copy from core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml copy to core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_complex_test.yml index 5a49a08..b0122a3 100644 --- a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml +++ b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_complex_test.yml @@ -1,7 +1,7 @@ langcode: und status: true dependencies: { } -id: test_field_field_revision_test +id: test_field_field_revision_complex_test module: views description: '' tag: '' @@ -30,20 +30,47 @@ display: plugin_id: field entity_type: entity_test_rev entity_field: revision_id - field_test: - id: field_test - table: entity_test__field_test - field: field_test + field_test_multiple: + id: field_test_multiple + table: entity_test_rev__field_test_multiple + field: field_test_multiple plugin_id: field entity_type: entity_test_rev - entity_field: field_test - name: - id: name - table: entity_test_rev_revision - field: name + entity_field: field_test_multiple + delta_limit: 0 + group_rows: true + field_test_multiple_1: + id: field_test_multiple_1 + table: entity_test_rev__field_test_multiple + field: field_test_multiple + plugin_id: field + entity_type: entity_test_rev + entity_field: field_test_multiple + delta_limit: 1 + group_rows: true + field_test_multiple_2: + id: field_test_multiple_2 + table: entity_test_rev__field_test_multiple + field: field_test_multiple plugin_id: field entity_type: entity_test_rev - entity_field: name + entity_field: field_test_multiple + delta_limit: 0 + delta_offset: 1 + group_rows: true + timezone: + id: timezone + table: users_field_data + field: timezone + plugin_id: field + relationship: user_id + alter: {} + relationships: + user_id: + table: entity_test_rev_revision + field: user_id + id: user_id + plugin_id: standard sorts: revision_id: id: revision_id diff --git a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml index 5a49a08..d85d4d1 100644 --- a/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml +++ b/core/modules/views/tests/modules/views_test_config/test_views/views.view.test_field_field_revision_test.yml @@ -32,7 +32,7 @@ display: entity_field: revision_id field_test: id: field_test - table: entity_test__field_test + table: entity_test_rev__field_test field: field_test plugin_id: field entity_type: entity_test_rev diff --git a/core/modules/views/tests/src/Unit/Plugin/field/FieldPluginBaseTest.php b/core/modules/views/tests/src/Unit/Plugin/field/FieldPluginBaseTest.php index 9a04103..0e45537 100644 --- a/core/modules/views/tests/src/Unit/Plugin/field/FieldPluginBaseTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/field/FieldPluginBaseTest.php @@ -492,12 +492,12 @@ public function providerTestRenderAsLinkWithPathAndTokens() { /** * Sets up a test field. * - * @return \Drupal\Tests\views\Unit\Plugin\field\TestField|\PHPUnit_Framework_MockObject_MockObject + * @return \Drupal\Tests\views\Unit\Plugin\field\FieldPluginBaseTestField|\PHPUnit_Framework_MockObject_MockObject * The test field. */ protected function setupTestField(array $options = []) { - /** @var \Drupal\Tests\views\Unit\Plugin\field\TestField $field */ - $field = $this->getMock('Drupal\Tests\views\Unit\Plugin\field\TestField', ['l'], [$this->configuration, $this->pluginId, $this->pluginDefinition]); + /** @var \Drupal\Tests\views\Unit\Plugin\field\FieldPluginBaseTestField $field */ + $field = $this->getMock('Drupal\Tests\views\Unit\Plugin\field\FieldPluginBaseTestField', ['l'], [$this->configuration, $this->pluginId, $this->pluginDefinition]); $field->init($this->executable, $this->display, $options); $field->setLinkGenerator($this->linkGenerator); @@ -506,7 +506,7 @@ protected function setupTestField(array $options = []) { } -class TestField extends FieldPluginBase { +class FieldPluginBaseTestField extends FieldPluginBase { public function setLinkGenerator(LinkGeneratorInterface $link_generator) { $this->linkGenerator = $link_generator; diff --git a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php index 9ca73d4..90bd2cc 100644 --- a/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php +++ b/core/modules/views/tests/src/Unit/Plugin/field/FieldTest.php @@ -7,9 +7,11 @@ namespace Drupal\Tests\views\Unit\Plugin\field; +use Drupal\Core\Field\FieldStorageDefinitionInterface; use Drupal\Tests\UnitTestCase; use Drupal\Tests\views\Unit\Plugin\HandlerTestTrait; use Drupal\views\Plugin\views\field\Field; +use Drupal\views\ResultRow; use Symfony\Component\DependencyInjection\ContainerBuilder; /** @@ -438,6 +440,7 @@ public function testQueryWithGroupByForBaseField() { ]; $handler = new Field([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); $handler->view = $this->executable; + $handler->view->field = [$handler]; $this->setupLanguageRenderer($handler, $definition); @@ -499,6 +502,7 @@ public function testQueryWithGroupByForConfigField() { ]; $handler = new Field([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); $handler->view = $this->executable; + $handler->view->field = [$handler]; $this->setupLanguageRenderer($handler, $definition); @@ -551,6 +555,85 @@ public function testQueryWithGroupByForConfigField() { } /** + * @covers ::prepareItemsByDelta + * + * @dataProvider providerTestPrepareItemsByDelta + */ + public function testPrepareItemsByDelta(array $options, array $expected_values) { + $definition = [ + 'entity_type' => 'test_entity', + 'field_name' => 'integer', + ]; + $handler = new FieldTestField([], 'field', $definition, $this->entityManager, $this->formatterPluginManager, $this->fieldTypePluginManager, $this->languageManager, $this->renderer); + $handler->view = $this->executable; + $handler->view->field = [$handler]; + + $this->setupLanguageRenderer($handler, $definition); + + $field_storage = $this->getConfigFieldStorage(); + $field_storage->expects($this->any()) + ->method('getCardinality') + ->willReturn(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED); + + $this->entityManager->expects($this->any()) + ->method('getFieldStorageDefinitions') + ->with('test_entity') + ->willReturn([ + 'integer' => $field_storage, + ]); + + $table_mapping = $this->getMock('Drupal\Core\Entity\Sql\TableMappingInterface'); + $table_mapping + ->expects($this->any()) + ->method('getFieldColumnName') + ->with($field_storage, 'value') + ->willReturn('integer_value'); + $entity_storage = $this->getMock('Drupal\Core\Entity\Sql\SqlEntityStorageInterface'); + $entity_storage->expects($this->any()) + ->method('getTableMapping') + ->willReturn($table_mapping); + $this->entityManager->expects($this->any()) + ->method('getStorage') + ->with('test_entity') + ->willReturn($entity_storage); + + $options = [ + 'group_column' => 'value', + 'group_columns' => [], + 'table' => 'test_entity__integer', + ] + $options; + $handler->init($this->executable, $this->display, $options); + + $this->executable->row_index = 0; + $this->executable->result = [0 => new ResultRow([])]; + + $items = [3, 1, 4, 1, 5, 9]; + $this->assertEquals($expected_values, $handler->executePrepareItemsByDelta($items)); + } + + /** + * Provides test data for testPrepareItemsByDelta(). + */ + public function providerTestPrepareItemsByDelta() { + $data = []; + + // Let's display all values. + $data[] = [[], [3, 1, 4, 1, 5, 9]]; + // Test just reversed deltas. + $data[] = [['delta_reversed' => TRUE], [9, 5, 1, 4, 1, 3]]; + + // Test combinations of delta limit, offset and first_last. + $data[] = [['group_rows' => TRUE, 'delta_limit' => 3], [3, 1, 4]]; + $data[] = [['group_rows' => TRUE, 'delta_limit' => 3, 'delta_offset' => 2], [4, 1, 5]]; + $data[] = [['group_rows' => TRUE, 'delta_reversed' => TRUE, 'delta_limit' => 3, 'delta_offset' => 2], [1, 4, 1]]; + $data[] = [['group_rows' => TRUE, 'delta_first_last' => TRUE], [3, 9]]; + $data[] = [['group_rows' => TRUE, 'delta_limit' => 1, 'delta_first_last' => TRUE], [3]]; + $data[] = [['group_rows' => TRUE, 'delta_offset' => 1, 'delta_first_last' => TRUE], [1, 9]]; + + return $data; + } + + /** * Returns a mocked base field storage object. * * @return \Drupal\Core\Field\FieldStorageDefinitionInterface|\PHPUnit_Framework_MockObject_MockObject @@ -640,3 +723,11 @@ protected function setupLanguageRenderer(Field $handler, $definition) { } } + +class FieldTestField extends Field { + + public function executePrepareItemsByDelta(array $all_values) { + return $this->prepareItemsByDelta($all_values); + } + +} diff --git a/core/tests/Drupal/Tests/Core/Entity/EntityManagerTest.php b/core/tests/Drupal/Tests/Core/Entity/EntityManagerTest.php index 5762e9e..397cb9d 100644 --- a/core/tests/Drupal/Tests/Core/Entity/EntityManagerTest.php +++ b/core/tests/Drupal/Tests/Core/Entity/EntityManagerTest.php @@ -1139,6 +1139,9 @@ public function testGetTranslationFromContext() { ->method('getTranslation') ->with('custom_langcode') ->will($this->returnValue($translated_entity)); + $entity->expects($this->any()) + ->method('getTranslationLanguages') + ->will($this->returnValue([new Language(['id' => 'en']), new Language(['id' => 'custom_langcode'])])); $this->assertSame($entity, $this->entityManager->getTranslationFromContext($entity)); $this->assertSame($translated_entity, $this->entityManager->getTranslationFromContext($entity, 'custom_langcode'));