diff --git a/core/includes/common.inc b/core/includes/common.inc index 9ec0e86..b9d80ab 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -3808,16 +3808,6 @@ function drupal_render(&$elements, $is_recursive_call = FALSE) { return ''; } - // Collect all #post_render_cache callbacks associated with this element when: - // - about to store this element in the render cache, or when; - // - about to apply #post_render_cache callbacks. - if (isset($elements['#cache']) || !$is_recursive_call) { - $post_render_cache = drupal_render_collect_post_render_cache($elements); - if ($post_render_cache) { - $elements['#post_render_cache'] = $post_render_cache; - } - } - // Add any JavaScript state information associated with the element. if (!empty($elements['#states'])) { drupal_process_states($elements); @@ -3921,6 +3911,15 @@ function drupal_render(&$elements, $is_recursive_call = FALSE) { $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : ''; $elements['#markup'] = $prefix . $elements['#children'] . $suffix; + // Collect all #post_render_cache callbacks associated with this element when: + // - about to store this element in the render cache, or when; + // - about to apply #post_render_cache callbacks. + if (!$is_recursive_call || isset($elements['#cache'])) { + $post_render_cache = drupal_render_collect_post_render_cache($elements); + if ($post_render_cache) { + $elements['#post_render_cache'] = $post_render_cache; + } + } // Collect all cache tags. This allows the caller of drupal_render() to also // access the complete list of cache tags. if (!$is_recursive_call || isset($elements['#cache'])) { @@ -4170,6 +4169,13 @@ function drupal_render_cache_generate_placeholder($callback, array $context, $to } /** + * Generates a unique token for use in a render cache placeholder. + */ +function drupal_render_cache_generate_token() { + return \Drupal\Component\Utility\Crypt::randomBytesBase64(55); +} + +/** * Pre-render callback: Renders a render cache placeholder into #markup. * * @param $elements @@ -4226,42 +4232,11 @@ function _drupal_render_process_post_render_cache(array &$elements) { // and if keyed by a number, no token is passed, otherwise, the token string // is passed to the callback as well. This token is used to uniquely // identify the placeholder in the markup. - $modified_elements = $elements; foreach ($elements['#post_render_cache'] as $callback => $options) { foreach ($elements['#post_render_cache'][$callback] as $token => $context) { - // The advanced option, when setting #post_render_cache directly. - if (is_numeric($token)) { - $modified_elements = call_user_func_array($callback, array($modified_elements, $context)); - } - // The simple option, when using the standard placeholders, and hence - // also when using #type => render_cache_placeholder. - else { - // Call #post_render_cache callback to generate the element that will - // fill in the placeholder. - $generated_element = call_user_func_array($callback, array($context)); - - // Update #attached based on the generated element. - if (isset($generated_element['#attached'])) { - if (!isset($modified_elements['#attached'])) { - $modified_elements['#attached'] = array(); - } - $modified_elements['#attached'] = drupal_merge_attached($modified_elements['#attached'], drupal_render_collect_attached($generated_element, TRUE)); - } - - // Replace the placeholder with the rendered markup of the generated - // element. - $placeholder = drupal_render_cache_generate_placeholder($callback, $context, $token); - $modified_elements['#markup'] = str_replace($placeholder, drupal_render($generated_element), $modified_elements['#markup']); - } + $elements = call_user_func_array($callback, array($elements, $context)); } } - // Only retain changes to the #markup and #attached properties, as would be - // the case when the render cache was actually being used. - $elements['#markup'] = $modified_elements['#markup']; - if (isset($modified_elements['#attached'])) { - $elements['#attached'] = $modified_elements['#attached']; - } - // Make sure that any attachments added in #post_render_cache callbacks are // also executed. if (isset($elements['#attached'])) { @@ -4318,13 +4293,6 @@ function drupal_render_collect_post_render_cache(array &$elements, array $callba } } - // If this is a render cache placeholder that hasn't been rendered yet, then - // render it now, because we must be able to collect its #post_render_cache - // callback. - if (!isset($elements['#post_render_cache']) && isset($elements['#type']) && $elements['#type'] === 'render_cache_placeholder') { - $elements = drupal_pre_render_render_cache_placeholder($elements); - } - // Collect all #post_render_cache callbacks for this element. if (isset($elements['#post_render_cache'])) { $callbacks = NestedArray::mergeDeep($callbacks, $elements['#post_render_cache']); diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php index b4c72a4..ba39249 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php @@ -15,6 +15,8 @@ use Drupal\Core\Language\LanguageManagerInterface; use Drupal\Core\TypedData\TranslatableInterface; use Drupal\entity\Entity\EntityViewDisplay; +use Drupal\Core\Render\Element; +use Drupal\Component\Utility\NestedArray; use Symfony\Component\DependencyInjection\ContainerInterface; /** @@ -91,8 +93,10 @@ public static function createInstance(ContainerInterface $container, EntityTypeI public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) { $entities_by_bundle = array(); foreach ($entities as $id => $entity) { - // Remove previously built content, if exists. - $entity->content = array( + if (empty($entity->content)) { + $entity->content = array(); + } + $entity->content += array( '#view_mode' => $view_mode, ); // Initialize the field item attributes for the fields being displayed. @@ -119,7 +123,7 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang foreach ($entities_by_bundle as $bundle => $bundle_entities) { $build = $displays[$bundle]->buildMultiple($bundle_entities); foreach ($bundle_entities as $id => $entity) { - $entity->content += $build[$id]; + $entity->content = NestedArray::mergeDeepArray(array($entity->content, array('#view_mode' => $view_mode), $build[$id]), TRUE); } } } @@ -138,8 +142,13 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang * @return array */ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) { + // Allow modules to change the view mode. + $context = array('langcode' => $langcode); + $this->moduleHandler->alter('entity_view_mode', $view_mode, $entity, $context); + $return = array( '#theme' => $this->entityTypeId, + '#pre_render' => array(array($this, 'entityViewBuilderBuildView')), "#{$this->entityTypeId}" => $entity, '#view_mode' => $view_mode, '#langcode' => $langcode, @@ -175,6 +184,60 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco } /** + * Builds an entity's view on an entity view; augments entity defaults. + * + * This function is assigned as a #build callback in + * \Drupal\Core\Entity\EntityViewBuilder::getBuildDefaults(). + * + * @param array $elements + * A structured array containing build information and context for an + * entity view. + * + * @see drupal_render() + */ + public function entityViewBuilderBuildView(array $elements) { + $entity = $elements['#entity']; + $bundle = $entity->bundle(); + $view_hook = "{$this->entityTypeId}_view"; + $view_mode = $elements['#view_mode']; + $langcode = $elements['#langcode']; + + // Get the corresponding display settings. + $display = EntityViewDisplay::collectRenderDisplay($entity, $view_mode); + + // Build field renderables. + $entity->content = $elements; + $this->buildContent(array($entity->id() => $entity), array($bundle => $display), $view_mode, $langcode); + $view_mode = isset($entity->content['#view_mode']) ? $entity->content['#view_mode'] : $view_mode; + + $this->moduleHandler()->invokeAll($view_hook, array($entity, $display, $view_mode, $langcode)); + $this->moduleHandler()->invokeAll('entity_view', array($entity, $display, $view_mode, $langcode)); + + // Do not override $build = $elements because hook_view implementations + // are expected to add content, not alter it. For example, mymodule_view + // should not change the #theme key. + $build = $entity->content; + // We don't need duplicate rendering info in $entity->content. + unset($entity->content); + + $this->alterBuild($build, $entity, $display, $view_mode, $langcode); + + // Assign the weights configured in the display. + // @todo: Once https://drupal.org/node/1875974 provides the missing API, + // only do it for 'extra fields', since other components have been taken + // care of in EntityViewDisplay::buildMultiple(). + foreach ($display->getComponents() as $name => $options) { + if (isset($build[$name])) { + $build[$name]['#weight'] = $options['weight']; + } + } + + // Allow modules to modify the render array. + \Drupal::moduleHandler()->alter(array($view_hook, 'entity_view'), $build, $entity, $display); + return $build; + } + + /** * Specific per-entity building. * * @param array $build @@ -209,58 +272,25 @@ public function viewMultiple(array $entities = array(), $view_mode = 'full', $la } // Build the view modes and display objects. - $view_modes = array(); - $context = array('langcode' => $langcode); - foreach ($entities as $key => $entity) { - $bundle = $entity->bundle(); + $build = array('#sorted' => TRUE); + $weight = 0; + foreach ($entities as $key => $entity) { + $entityType = "{$this->entityTypeId}"; // Ensure that from now on we are dealing with the proper translation // object. $entity = $this->entityManager->getTranslationFromContext($entity, $langcode); $entities[$key] = $entity; - // Allow modules to change the view mode. - $entity_view_mode = $view_mode; - $this->moduleHandler->alter('entity_view_mode', $entity_view_mode, $entity, $context); - // Store entities for rendering by view_mode. - $view_modes[$entity_view_mode][$entity->id()] = $entity; - } + $build[$key] = array( + '#entity' => $entity + ); - foreach ($view_modes as $mode => $view_mode_entities) { - $displays[$mode] = EntityViewDisplay::collectRenderDisplays($view_mode_entities, $mode); - $this->buildContent($view_mode_entities, $displays[$mode], $mode, $langcode); - } - - $view_hook = "{$this->entityTypeId}_view"; - $build = array('#sorted' => TRUE); - $weight = 0; - foreach ($entities as $key => $entity) { - $entity_view_mode = isset($entity->content['#view_mode']) ? $entity->content['#view_mode'] : $view_mode; - $display = $displays[$entity_view_mode][$entity->bundle()]; - \Drupal::moduleHandler()->invokeAll($view_hook, array($entity, $display, $entity_view_mode, $langcode)); - \Drupal::moduleHandler()->invokeAll('entity_view', array($entity, $display, $entity_view_mode, $langcode)); - - $build[$key] = $entity->content; - // We don't need duplicate rendering info in $entity->content. - unset($entity->content); - - $build[$key] += $this->getBuildDefaults($entity, $entity_view_mode, $langcode); - $this->alterBuild($build[$key], $entity, $display, $entity_view_mode, $langcode); - - // Assign the weights configured in the display. - // @todo: Once https://drupal.org/node/1875974 provides the missing API, - // only do it for 'extra fields', since other components have been taken - // care of in EntityViewDisplay::buildMultiple(). - foreach ($display->getComponents() as $name => $options) { - if (isset($build[$key][$name])) { - $build[$key][$name]['#weight'] = $options['weight']; - } - } + // Set defaults for #pre_render. + $build[$key] += $this->getBuildDefaults($entity, $view_mode, $langcode); + \Drupal::moduleHandler()->alter(array($entityType . '_defaults', 'entity_defaults'), $build[$key], $entity, $view_mode, $langcode); $build[$key]['#weight'] = $weight++; - - // Allow modules to modify the render array. - $this->moduleHandler->alter(array($view_hook, 'entity_view'), $build[$key], $entity, $display); } return $build; diff --git a/core/lib/Drupal/Core/Field/FormatterBase.php b/core/lib/Drupal/Core/Field/FormatterBase.php index 1b4287f..fbee57e 100644 --- a/core/lib/Drupal/Core/Field/FormatterBase.php +++ b/core/lib/Drupal/Core/Field/FormatterBase.php @@ -91,22 +91,9 @@ public function view(FieldItemListInterface $items) { '#object' => $entity, '#items' => $items, '#formatter' => $this->getPluginId(), - '#cache' => array('tags' => array()) ); - // Gather cache tags from reference fields. - foreach ($items as $item) { - if (isset($item->format)) { - $info['#cache']['tags']['filter_format'] = $item->format; - } - - if (isset($item->entity)) { - $info['#cache']['tags'][$item->entity->getEntityTypeId()][] = $item->entity->id(); - $info['#cache']['tags'][$item->entity->getEntityTypeId() . '_view'] = TRUE; - } - } - - $addition = array_merge($info, $elements); + $addition[$field_name] = array_merge($info, $elements); } return $addition; diff --git a/core/modules/aggregator/lib/Drupal/aggregator/FeedViewBuilder.php b/core/modules/aggregator/lib/Drupal/aggregator/FeedViewBuilder.php index 853122f..5066eaa 100644 --- a/core/modules/aggregator/lib/Drupal/aggregator/FeedViewBuilder.php +++ b/core/modules/aggregator/lib/Drupal/aggregator/FeedViewBuilder.php @@ -18,7 +18,7 @@ class FeedViewBuilder extends EntityViewBuilder { /** * {@inheritdoc} */ - protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) { + protected function getBuildDefaults(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { $defaults = parent::getBuildDefaults($entity, $view_mode, $langcode); $defaults['#theme'] = 'aggregator_feed_source'; return $defaults; diff --git a/core/modules/aggregator/lib/Drupal/aggregator/ItemViewBuilder.php b/core/modules/aggregator/lib/Drupal/aggregator/ItemViewBuilder.php index 7d3f919..da69ecf 100644 --- a/core/modules/aggregator/lib/Drupal/aggregator/ItemViewBuilder.php +++ b/core/modules/aggregator/lib/Drupal/aggregator/ItemViewBuilder.php @@ -18,7 +18,7 @@ class ItemViewBuilder extends EntityViewBuilder { /** * {@inheritdoc} */ - protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) { + protected function getBuildDefaults(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { $defaults = parent::getBuildDefaults($entity, $view_mode, $langcode); // Use a different template for the summary view mode. diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index e353501..c193ad3 100644 --- a/core/modules/comment/comment.module +++ b/core/modules/comment/comment.module @@ -13,6 +13,7 @@ use Drupal\comment\CommentInterface; use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface; use Drupal\Core\Entity\EntityInterface; +use Drupal\entity\Entity\EntityViewDisplay; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Url; use Drupal\field\FieldInstanceConfigInterface; @@ -358,20 +359,22 @@ function comment_new_page_count($num_comments, $new_replies, EntityInterface $en } /** - * Implements hook_entity_view_alter(). + * Implements hook_entity_defaults_alter(). */ -function comment_entity_view_alter(&$build, EntityInterface $entity, EntityViewDisplayInterface $display) { +function comment_entity_defaults_alter(array &$build, EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { + // Get the corresponding display settings. + $display = EntityViewDisplay::collectRenderDisplay($entity, $view_mode); // Add the comment page number to the cache key if render caching is enabled. if (isset($build['#cache']) && isset($build['#cache']['keys']) && \Drupal::request()->query->has('page')) { foreach ($entity->getFieldDefinitions() as $field_name => $definition) { - if (isset($build[$field_name]) && $definition->getType() === 'comment') { - $display_options = $display->getComponent($field_name); + if ($definition->getType() === 'comment' && ($display_options = $display->getComponent($field_name))) { $pager_id = $display_options['settings']['pager_id']; $page = pager_find_page($pager_id); $build['#cache']['keys'][] = $field_name . '-pager-' . $page; } } } + return $build; } /** @@ -1237,16 +1240,13 @@ function comment_preview(CommentInterface $comment, array &$form_state) { // therefore the rendered parent entity. This results in an infinite loop of // parent entity output rendering the comment form and the comment form // rendering the parent entity. To prevent this infinite loop we temporarily - // set the value of the comment field on the rendered entity to hidden + // set the value of the comment field on a clone of the entity to hidden // before calling entity_view(). That way when the output of the commented - // entity is rendered, it excludes the comment field output. As objects are - // always addressed by reference we ensure changes are not lost by setting - // the value back to its original state after the call to entity_view(). + // entity is rendered, it excludes the comment field output. $field_name = $comment->getFieldName(); - $original_status = $entity->get($field_name)->status; - $entity->get($field_name)->status = CommentItemInterface::HIDDEN; + $entity = clone $entity; + $entity->$field_name->status = CommentItemInterface::HIDDEN; $build = entity_view($entity, 'full'); - $entity->get($field_name)->status = $original_status; } $preview_build['comment_output_below'] = $build; diff --git a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php index 3661080..01453c9 100644 --- a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php +++ b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php @@ -123,17 +123,23 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang } $entity->content['#entity'] = $entity; $entity->content['#theme'] = 'comment__' . $entity->getFieldId() . '__' . $commented_entity->bundle(); + $callback = '\Drupal\comment\CommentViewBuilder::renderLinks'; + $context = array( + 'comment_entity_id' => $entity->id(), + 'view_mode' => $view_mode, + 'langcode' => $langcode, + 'commented_entity_type' => $commented_entity->getEntityTypeId(), + 'commented_entity_id' => $commented_entity->id(), + 'in_preview' => !empty($entity->in_preview), + 'token' => drupal_render_cache_generate_token(), + ); $entity->content['links'] = array( - '#type' => 'render_cache_placeholder', - '#callback' => '\Drupal\comment\CommentViewBuilder::renderLinks', - '#context' => array( - 'comment_entity_id' => $entity->id(), - 'view_mode' => $view_mode, - 'langcode' => $langcode, - 'commented_entity_type' => $commented_entity->getEntityTypeId(), - 'commented_entity_id' => $commented_entity->id(), - 'in_preview' => !empty($entity->in_preview), + '#post_render_cache' => array( + $callback => array( + $context, + ), ), + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), ); if (!isset($entity->content['#attached'])) { @@ -168,7 +174,9 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang * @return array * A renderable array representing the comment links. */ - public static function renderLinks(array $context) { + public static function renderLinks(array $element, array $context) { + $callback = '\Drupal\comment\CommentViewBuilder::renderLinks'; + $placeholder = drupal_render_cache_generate_placeholder($callback, $context, $context['token']); $links = array( '#theme' => 'links__comment', '#pre_render' => array('drupal_pre_render_links'), @@ -189,8 +197,10 @@ public static function renderLinks(array $context) { ); \Drupal::moduleHandler()->alter('comment_links', $links, $entity, $hook_context); } + $replace = drupal_render($links); + $element['#markup'] = str_replace($placeholder, $replace, $element['#markup']); - return $links; + return $element; } /** diff --git a/core/modules/comment/lib/Drupal/comment/Controller/CommentController.php b/core/modules/comment/lib/Drupal/comment/Controller/CommentController.php index 7829950..55b8b3b 100644 --- a/core/modules/comment/lib/Drupal/comment/Controller/CommentController.php +++ b/core/modules/comment/lib/Drupal/comment/Controller/CommentController.php @@ -251,11 +251,11 @@ public function getReplyForm(Request $request, $entity_type, $entity_id, $field_ elseif ($entity->access('view', $account)) { // We make sure the field value isn't set so we don't end up with a // redirect loop. + $entity = clone $entity; $entity->{$field_name}->status = CommentItemInterface::HIDDEN; // Render array of the entity full view mode. $build['commented_entity'] = $this->entityManager()->getViewBuilder($entity->getEntityTypeId())->view($entity, 'full'); unset($build['commented_entity']['#cache']); - $entity->{$field_name}->status = $status; } } else { diff --git a/core/modules/comment/lib/Drupal/comment/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php b/core/modules/comment/lib/Drupal/comment/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php index 1832e32..2774ad8 100644 --- a/core/modules/comment/lib/Drupal/comment/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php +++ b/core/modules/comment/lib/Drupal/comment/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php @@ -162,14 +162,20 @@ public function viewElements(FieldItemListInterface $items) { // All other users need a user-specific form, which would break the // render cache: hence use a #post_render_cache callback. else { + $callback = '\Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter::renderForm'; + $context = array( + 'entity_type' => $entity->getEntityTypeId(), + 'entity_id' => $entity->id(), + 'field_name' => $field_name, + 'token' => drupal_render_cache_generate_token(), + ); $output['comment_form'] = array( - '#type' => 'render_cache_placeholder', - '#callback' => '\Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter::renderForm', - '#context' => array( - 'entity_type' => $entity->getEntityTypeId(), - 'entity_id' => $entity->id(), - 'field_name' => $field_name, + '#post_render_cache' => array( + $callback => array( + $context, + ), ), + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), ); } } @@ -199,9 +205,16 @@ public function viewElements(FieldItemListInterface $items) { * @return array * A renderable array containing the comment form. */ - public static function renderForm(array $context) { + public static function renderForm(array $element, array $context) { + $callback = '\Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter::renderForm'; + $placeholder = drupal_render_cache_generate_placeholder($callback, $context, $context['token']); $entity = entity_load($context['entity_type'], $context['entity_id']); - return comment_add($entity, $context['field_name']); + $form = comment_add($entity, $context['field_name']); + // @todo: #attached. + $replace = drupal_render($form, TRUE); + $element['#markup'] = str_replace($placeholder, $replace, $element['#markup']); + + return $element; } /** @@ -231,5 +244,4 @@ public function settingsSummary() { } return array(); } - } diff --git a/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php b/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php index 07cac6e..082604d 100644 --- a/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php +++ b/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php @@ -7,6 +7,7 @@ namespace Drupal\comment\Tests; +use Drupal\Core\Entity\EntityInterface; use Drupal\system\Tests\Entity\EntityWithUriCacheTagsTestBase; /** @@ -71,4 +72,7 @@ protected function createEntity() { return $comment; } + protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) { + return array('filter_format:'); + } } diff --git a/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php b/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php index 6af84c9..bf7cf67 100644 --- a/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php +++ b/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php @@ -211,7 +211,7 @@ public function build(ContentEntityInterface $entity) { public function buildMultiple(array $entities) { $build = array(); foreach ($entities as $key => $entity) { - $build[$key] = array(); + $build[$key] = $entity->content; } // Run field formatters. @@ -230,7 +230,13 @@ public function buildMultiple(array $entities) { // Then let the formatter build the output for each entity. foreach ($entities as $key => $entity) { $items = $entity->get($field_name); - $build[$key][$field_name] = $formatter->view($items); + if (!isset($build[$key][$field_name])) { + $build[$key][$field_name] = array(); + } + // @todo, maybe just return the contents of view without a wrapper and the subsequent need to reference + // a $field_name index? + $built_field = $formatter->view($items); + $build[$key][$field_name] += (!empty($built_field[$field_name])) ? $built_field[$field_name] : array(); } } } diff --git a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php index 6df0d11..b3f61a8 100644 --- a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php +++ b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceIdFormatter.php @@ -35,7 +35,15 @@ public function viewElements(FieldItemListInterface $items) { continue; } if (!empty($item->entity) && !empty($item->target_id)) { - $elements[$delta] = array('#markup' => check_plain($item->target_id)); + $elements[$delta] = array( + '#markup' => check_plain($item->target_id), + '#cache' => array( + 'tags' => array( + $referenced_entity->getEntityTypeID() => $referenced_entity->id(), + $referenced_entity->getEntityTypeID() . '_view' => TRUE, + ), + ), + ); } } diff --git a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php index 7cdac18..b7157c9 100644 --- a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php +++ b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php @@ -79,6 +79,10 @@ public function viewElements(FieldItemListInterface $items) { else { $elements[$delta] = array('#markup' => check_plain($label)); } + $elements[$delta]['#cache']['tags'] = array( + $referenced_entity->getEntityTypeID() => $referenced_entity->id(), + $referenced_entity->getEntityTypeID() . '_view' => TRUE, + ); } } diff --git a/core/modules/image/lib/Drupal/image/Tests/ImageFieldDefaultImagesTest.php b/core/modules/image/lib/Drupal/image/Tests/ImageFieldDefaultImagesTest.php index edf1919..bea8117 100644 --- a/core/modules/image/lib/Drupal/image/Tests/ImageFieldDefaultImagesTest.php +++ b/core/modules/image/lib/Drupal/image/Tests/ImageFieldDefaultImagesTest.php @@ -160,7 +160,7 @@ public function testDefaultImages() { // Confirm that the image default is shown for a new article node. $article = $this->drupalCreateNode(array('type' => 'article')); - $article_built = node_view($article); + $article_built = $this->drupalBuildView($article); $this->assertEqual( $article_built[$field_name]['#items'][0]->target_id, $default_images['instance']->id(), @@ -172,7 +172,7 @@ public function testDefaultImages() { // Confirm that the image default is shown for a new page node. $page = $this->drupalCreateNode(array('type' => 'page')); - $page_built = node_view($page); + $page_built = $this->drupalBuildView($page); $this->assertEqual( $page_built[$field_name]['#items'][0]->target_id, $default_images['instance2']->id(), @@ -198,8 +198,8 @@ public function testDefaultImages() { ); // Reload the nodes and confirm the field instance defaults are used. - $article_built = node_view($article = node_load($article->id(), TRUE)); - $page_built = node_view($page = node_load($page->id(), TRUE)); + $article_built = $this->drupalBuildView($article = node_load($article->id(), TRUE)); + $page_built = $this->drupalBuildView($page = node_load($page->id(), TRUE)); $this->assertEqual( $article_built[$field_name]['#items'][0]->target_id, $default_images['instance']->id(), @@ -234,8 +234,8 @@ public function testDefaultImages() { ); // Reload the nodes. - $article_built = node_view($article = node_load($article->id(), TRUE)); - $page_built = node_view($page = node_load($page->id(), TRUE)); + $article_built = $this->drupalBuildView($article = node_load($article->id(), TRUE)); + $page_built = $this->drupalBuildView($page = node_load($page->id(), TRUE)); // Confirm the article uses the new default. $this->assertEqual( @@ -269,8 +269,8 @@ public function testDefaultImages() { ); // Reload the nodes. - $article_built = node_view($article = node_load($article->id(), TRUE)); - $page_built = node_view($page = node_load($page->id(), TRUE)); + $article_built = $this->drupalBuildView($article = node_load($article->id(), TRUE)); + $page_built = $this->drupalBuildView($page = node_load($page->id(), TRUE)); // Confirm the article uses the new field (not instance) default. $this->assertEqual( $article_built[$field_name]['#items'][0]->target_id, diff --git a/core/modules/node/lib/Drupal/node/NodeViewBuilder.php b/core/modules/node/lib/Drupal/node/NodeViewBuilder.php index 34ca5de..ba9a5bf 100644 --- a/core/modules/node/lib/Drupal/node/NodeViewBuilder.php +++ b/core/modules/node/lib/Drupal/node/NodeViewBuilder.php @@ -34,16 +34,24 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang $bundle = $entity->bundle(); $display = $displays[$bundle]; + $callback = '\Drupal\node\NodeViewBuilder::renderLinks'; + $context = array( + 'node_entity_id' => $entity->id(), + 'view_mode' => $view_mode, + 'langcode' => $langcode, + 'in_preview' => !empty($entity->in_preview), + 'token' => drupal_render_cache_generate_token(), + ); + $entity->content['links'] = array( - '#type' => 'render_cache_placeholder', - '#callback' => '\Drupal\node\NodeViewBuilder::renderLinks', - '#context' => array( - 'node_entity_id' => $entity->id(), - 'view_mode' => $view_mode, - 'langcode' => $langcode, - 'in_preview' => !empty($entity->in_preview), + '#post_render_cache' => array( + $callback => array( + $context, + ), ), - ); + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), + ); + // Add Language field text element to node render array. if ($display->getComponent('langcode')) { @@ -61,13 +69,18 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang /** * {@inheritdoc} */ - protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) { + protected function getBuildDefaults(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { $defaults = parent::getBuildDefaults($entity, $view_mode, $langcode); // Don't cache nodes that are in 'preview' mode. if (isset($defaults['#cache']) && isset($entity->in_preview)) { unset($defaults['#cache']); } + else { + // The node 'submitted' info is not rendered in a standard way (renderable + // array) so we have to add a cache tag manually. + $defaults['#cache']['tags']['user'][] = $entity->getOwnerId(); + } return $defaults; } @@ -87,7 +100,10 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco * @return array * A renderable array representing the node links. */ - public static function renderLinks(array $context) { + public static function renderLinks(array $element, array $context) { + $callback = '\Drupal\node\NodeViewBuilder::renderLinks'; + $placeholder = drupal_render_cache_generate_placeholder($callback, $context, $context['token']); + $links = array( '#theme' => 'links__node', '#pre_render' => array('drupal_pre_render_links'), @@ -105,8 +121,10 @@ public static function renderLinks(array $context) { ); \Drupal::moduleHandler()->alter('node_links', $links, $entity, $hook_context); } + $replace = drupal_render($links); + $element['#markup'] = str_replace($placeholder, $replace, $element['#markup']); - return $links; + return $element; } /** @@ -160,10 +178,6 @@ protected function alterBuild(array &$build, EntityInterface $entity, EntityView 'metadata' => array('changed' => $entity->getChangedTime()), ); } - - // The node 'submitted' info is not rendered in a standard way (renderable - // array) so we have to add a cache tag manually. - $build['#cache']['tags']['user'][] = $entity->getOwnerId(); } } diff --git a/core/modules/node/lib/Drupal/node/Tests/NodeEntityViewModeAlterTest.php b/core/modules/node/lib/Drupal/node/Tests/NodeEntityViewModeAlterTest.php index 2fb9918..17ab549 100644 --- a/core/modules/node/lib/Drupal/node/Tests/NodeEntityViewModeAlterTest.php +++ b/core/modules/node/lib/Drupal/node/Tests/NodeEntityViewModeAlterTest.php @@ -51,7 +51,7 @@ function testNodeViewModeChange() { $this->assertNoText('Data that should appear only in the body for the node.', 'Body text not present'); // Test that the correct build mode has been set. - $build = node_view($node); + $build = $this->drupalBuildView($node); $this->assertEqual($build['#view_mode'], 'teaser', 'The view mode has correctly been set to teaser.'); } } diff --git a/core/modules/node/lib/Drupal/node/Tests/SummaryLengthTest.php b/core/modules/node/lib/Drupal/node/Tests/SummaryLengthTest.php index 9ad3373..eb168f8 100644 --- a/core/modules/node/lib/Drupal/node/Tests/SummaryLengthTest.php +++ b/core/modules/node/lib/Drupal/node/Tests/SummaryLengthTest.php @@ -35,9 +35,8 @@ function testSummaryLength() { $web_user = $this->drupalCreateUser(array('access content', 'administer content types')); $this->loggedInUser = $web_user; - $controller = $this->container->get('entity.manager')->getViewBuilder('node'); // Render the node as a teaser. - $content = $controller->view($node, 'teaser'); + $content = $this->drupalBuildView($node, 'teaser'); $this->assertTrue(strlen($content['body'][0]['#markup']) < 600, 'Teaser is less than 600 characters long.'); $this->drupalSetContent(drupal_render($content)); // The string 'What is a Drupalism?' is between the 200th and 600th @@ -55,7 +54,7 @@ function testSummaryLength() { // Render the node as a teaser again and check that the summary is now only // 200 characters in length and so does not include 'What is a Drupalism?'. - $content = $controller->view($node, 'teaser'); + $content = $this->drupalBuildView($node, 'teaser'); $this->assertTrue(strlen($content['body'][0]['#markup']) < 200, 'Teaser is less than 200 characters long.'); $this->drupalSetContent(drupal_render($content)); $this->assertText($node->label()); diff --git a/core/modules/node/tests/modules/node_test/node_test.module b/core/modules/node/tests/modules/node_test/node_test.module index 1f2f679..398f132 100644 --- a/core/modules/node/tests/modules/node_test/node_test.module +++ b/core/modules/node/tests/modules/node_test/node_test.module @@ -21,7 +21,6 @@ function node_test_node_view(NodeInterface $node, EntityViewDisplayInterface $di 'key' => 'testElement', 'value' => t('Value of testElement RSS element for node !nid.', array('!nid' => $node->id())), ); - $node->rss_namespaces['xmlns:drupaltest'] = 'http://example.com/test-namespace'; // Add content that should be displayed only in the RSS feed. $node->content['extra_feed_content'] = array( @@ -39,6 +38,15 @@ function node_test_node_view(NodeInterface $node, EntityViewDisplayInterface $di } /** + * Implements hook_node_defaults_alter(). + */ +function node_test_node_defaults_alter(array &$build, NodeInterface &$node, $view_mode = 'full', $langcode = NULL) { + if ($view_mode == 'rss') { + $node->rss_namespaces['xmlns:drupaltest'] = 'http://example.com/test-namespace'; + } +} + +/** * Implements hook_node_grants(). */ function node_test_node_grants($account, $op) { diff --git a/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php b/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php index 61c54d1..db2fefd 100644 --- a/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php +++ b/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php @@ -336,6 +336,32 @@ protected function drupalCreateContentType(array $values = array()) { } /** + * @needsdoc + */ + protected function drupalBuildView($entity, $view_mode = 'full', $langcode = NULL, $reset = FALSE) { + $render_controller = $this->container->get('entity.manager')->getViewBuilder($entity->getEntityTypeId()); + if ($reset) { + $render_controller->resetCache(array($entity->id())); + } + $elements = $render_controller->view($entity, $view_mode, $langcode); + // If the default values for this element have not been loaded yet, populate + // them. + if (isset($elements['#type']) && empty($elements['#defaults_loaded'])) { + $elements += element_info($elements['#type']); + } + + // Make any final changes to the element before it is rendered. This means + // that the $element or the children can be altered or corrected before the + // element is rendered into the final text. + if (isset($elements['#pre_render'])) { + foreach ($elements['#pre_render'] as $callable) { + $elements = call_user_func($callable, $elements); + } + } + return $elements; + } + + /** * Creates a block instance based on default settings. * * @param string $plugin_id diff --git a/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php b/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php index 690bbaf..eb70804 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php @@ -10,6 +10,7 @@ use Drupal\Component\Utility\Html; use Drupal\Component\Utility\Json; use Drupal\simpletest\DrupalUnitTestBase; +use Drupal\Component\Utility\Crypt; /** * Tests drupal_render(). @@ -471,7 +472,6 @@ function testDrupalRenderPostRenderCache() { $output = drupal_render($element); $this->assertIdentical($output, '
overridden
', 'Output is overridden.'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $context, '#attached is modified; JavaScript setting is added to page.'); @@ -489,7 +489,6 @@ function testDrupalRenderPostRenderCache() { $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertTrue(isset($element['#printed']), 'No cache hit'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $context, '#attached is modified; JavaScript setting is added to page.'); @@ -513,7 +512,6 @@ function testDrupalRenderPostRenderCache() { $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertFalse(isset($element['#printed']), 'Cache hit'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $context, '#attached is modified; JavaScript setting is added to page.'); @@ -531,7 +529,6 @@ function testDrupalRenderPostRenderCache() { $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertTrue(isset($element['#printed']), 'No cache hit'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $context, '#attached is modified; JavaScript setting is added to page.'); @@ -546,6 +543,249 @@ function testDrupalRenderPostRenderCache() { } /** + * Tests post-render cache-integrated 'render_cache_placeholder' element. + */ + function testDrupalRenderRenderCachePlaceholder() { + $context = array( + 'bar' => $this->randomContextValue(), + 'token' => Crypt::randomBytesBase64(55), + ); + $callback = 'common_test_post_render_cache_placeholder'; + $test_element = array( + '#post_render_cache' => array( + $callback => array( + $context + ), + ), + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), + '#prefix' => 'overridden
', 'Output is overridden.'); $this->assertTrue(isset($element['#printed']), 'No cache hit'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $expected_settings = $context_1 + $context_2 + $context_3; $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); @@ -641,7 +880,6 @@ function testDrupalRenderChildrenPostRenderCache() { $output = drupal_render($element); $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertFalse(isset($element['#printed']), 'Cache hit'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $expected_settings, '#attached is modified; JavaScript settings for each #post_render_cache callback are added to page.'); @@ -654,7 +892,6 @@ function testDrupalRenderChildrenPostRenderCache() { $output = drupal_render($element); $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $expected_settings = $context_1 + $context_2 + $context_3; $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); @@ -676,7 +913,6 @@ function testDrupalRenderChildrenPostRenderCache() { $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertTrue(isset($element['#printed']), 'No cache hit'); $this->assertIdentical($element['#markup'], 'overridden
', '#markup is overridden.'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $expected_settings = $context_1 + $context_2 + $context_3; $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); @@ -751,7 +987,6 @@ function testDrupalRenderChildrenPostRenderCache() { $output = drupal_render($element); $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertFalse(isset($element['#printed']), 'Cache hit'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $this->assertIdentical($settings['foo'], 'bar', 'Original JavaScript setting is added to the page.'); $this->assertIdentical($settings['common_test'], $expected_settings, '#attached is modified; JavaScript settings for each #post_render_cache callback are added to page.'); @@ -764,7 +999,6 @@ function testDrupalRenderChildrenPostRenderCache() { $output = drupal_render($element); $this->assertIdentical($output, 'overridden
', 'Output is overridden.'); $this->assertFalse(isset($element['#printed']), 'Cache hit'); - $this->assertTrue(!isset($element['#context_test']), '#context_test is not set: impossible to modify $element itself, only possible to modify its #markup and #attached properties.'); $settings = $this->parseDrupalSettings(drupal_get_js()); $expected_settings = $context_2 + $context_3; $this->assertTrue(!isset($settings['foo']), 'Parent JavaScript setting is not added to the page.'); @@ -774,235 +1008,6 @@ function testDrupalRenderChildrenPostRenderCache() { \Drupal::request()->setMethod($request_method); } - - /** - * Tests post-render cache-integrated 'render_cache_placeholder' element. - */ - function testDrupalRenderRenderCachePlaceholder() { - $context = array('bar' => $this->randomContextValue()); - $test_element = array( - '#type' => 'render_cache_placeholder', - '#context' => $context, - '#callback' => 'common_test_post_render_cache_placeholder', - '#prefix' => '