diff --git a/core/includes/common.inc b/core/includes/common.inc index 107e515..8a88f66 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -3266,7 +3266,7 @@ function drupal_pre_render_link($element) { * A typical example comes from node links, which are stored in a renderable * array similar to this: * @code - * $node->content['links'] = array( + * $build['links'] = array( * '#theme' => 'links__node', * '#pre_render' => array('drupal_pre_render_links'), * 'comment' => array( @@ -3301,7 +3301,7 @@ function drupal_pre_render_link($element) { * {{ content.links.comment }} * @endcode * - * (where $node->content has been transformed into $content before handing + * (where a node's content has been transformed into $content before handing * control to the node.html.twig template). * * The pre_render function defined here allows the above flexibility, but also @@ -3637,16 +3637,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); @@ -3750,6 +3740,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'])) { @@ -3828,6 +3827,10 @@ function render(&$element) { return NULL; } if (is_array($element)) { + // Early return if this element was pre-rendered (no need to re-render). + if (isset($element['#printed']) && $element['#printed'] == TRUE && strlen($element['#markup']) > 0) { + return $element['#markup']; + } show($element); return drupal_render($element, TRUE); } @@ -3988,6 +3991,9 @@ function drupal_render_cache_set(&$markup, array $elements) { * @param string $token * A unique token to uniquely identify the placeholder. * + * @return string + * The generated placeholder HTML. + * * @see drupal_render_cache_get() */ function drupal_render_cache_generate_placeholder($callback, array $context, $token) { @@ -4000,37 +4006,10 @@ function drupal_render_cache_generate_placeholder($callback, array $context, $to } /** - * Pre-render callback: Renders a render cache placeholder into #markup. - * - * @param $elements - * A structured array whose keys form the arguments to l(): - * - #callback: The #post_render_cache callback that will replace the - * placeholder with its eventual markup. - * - #context: An array providing context for the #post_render_cache callback. - * - * @return - * The passed-in element containing a render cache placeholder in '#markup' - * and a callback with context, keyed by a generated unique token in - * '#post_render_cache'. - * - * @see drupal_render_cache_generate_placeholder() + * Generates a unique token for use in a #post_render_cache placeholder. */ -function drupal_pre_render_render_cache_placeholder($element) { - $callback = $element['#callback']; - if (!is_callable($callback)) { - throw new Exception(t('#callback must be a callable function.')); - } - $context = $element['#context']; - if (!is_array($context)) { - throw new Exception(t('#context must be an array.')); - } - $token = \Drupal\Component\Utility\Crypt::randomBytesBase64(55); - - // Generate placeholder markup and store #post_render_cache callback. - $element['#markup'] = drupal_render_cache_generate_placeholder($callback, $context, $token); - $element['#post_render_cache'][$callback][$token] = $context; - - return $element; +function drupal_render_cache_generate_token() { + return \Drupal\Component\Utility\Crypt::randomBytesBase64(55); } /** @@ -4056,42 +4035,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'])) { @@ -4148,13 +4096,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/Display/EntityViewDisplayInterface.php b/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php index 8d86a6b..69ecb78 100644 --- a/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php +++ b/core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php @@ -34,7 +34,7 @@ public function build(ContentEntityInterface $entity); * * This only includes the components handled by the Display object, but * excludes 'extra fields', that are typically rendered through specific, - * ad-hoc code in EntityViewBuilderInterface::buildContent() or in + * ad-hoc code in EntityViewBuilderInterface::buildComponents() or in * hook_entity_view() implementations. * * hook_entity_display_build_alter() is invoked on each entity, allowing 3rd diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php index a0b8154..9154dcd 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php @@ -10,11 +10,13 @@ use Drupal\Component\Utility\NestedArray; use Drupal\Core\Cache\Cache; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; +use Drupal\Core\Entity\ContentEntityInterface; use Drupal\Core\Field\FieldItemInterface; use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Language\Language; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\Core\TypedData\TranslatableInterface; +use Drupal\Core\Render\Element; use Drupal\entity\Entity\EntityViewDisplay; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -89,13 +91,9 @@ public static function createInstance(ContainerInterface $container, EntityTypeI /** * {@inheritdoc} */ - public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) { + public function buildComponents(array &$build, 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( - '#view_mode' => $view_mode, - ); // Initialize the field item attributes for the fields being displayed. // The entity can include fields that are not displayed, and the display // can include components that are not fields, so we want to act on the @@ -114,13 +112,13 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang } // Invoke hook_entity_prepare_view(). - \Drupal::moduleHandler()->invokeAll('entity_prepare_view', array($this->entityTypeId, $entities, $displays, $view_mode)); + $this->moduleHandler()->invokeAll('entity_prepare_view', array($this->entityTypeId, $entities, $displays, $view_mode)); // Let the displays build their render arrays. foreach ($entities_by_bundle as $bundle => $bundle_entities) { - $build = $displays[$bundle]->buildMultiple($bundle_entities); + $display_build = $displays[$bundle]->buildMultiple($bundle_entities); foreach ($bundle_entities as $id => $entity) { - $entity->content += $build[$id]; + $build[$id] += $display_build[$id]; } } } @@ -133,26 +131,31 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang * @param string $view_mode * The view mode that should be used. * @param string $langcode - * (optional) For which language the entity should be prepared, defaults to + * For which language the entity should be prepared, defaults to * the current content language. * * @return array */ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langcode) { - $return = array( + // Allow modules to change the view mode. + $context = array('langcode' => $langcode); + $this->moduleHandler()->alter('entity_view_mode', $view_mode, $entity, $context); + + $build = array( '#theme' => $this->entityTypeId, "#{$this->entityTypeId}" => $entity, '#view_mode' => $view_mode, '#langcode' => $langcode, + // Collect cache defaults for this entity. '#cache' => array( - 'tags' => NestedArray::mergeDeep($this->getCacheTag(), $entity->getCacheTag()), + 'tags' => NestedArray::mergeDeep($this->getCacheTag(), $entity->getCacheTag()), ), ); // Cache the rendered output if permitted by the view mode and global entity // type configuration. if ($this->isViewModeCacheable($view_mode) && !$entity->isNew() && $entity->isDefaultRevision() && $this->entityType->isRenderCacheable()) { - $return['#cache'] += array( + $build['#cache'] += array( 'keys' => array( 'entity_view', $this->entityTypeId, @@ -165,11 +168,11 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco ); if ($entity instanceof TranslatableInterface && count($entity->getTranslationLanguages()) > 1) { - $return['#cache']['keys'][] = $langcode; + $build['#cache']['keys'][] = $langcode; } } - return $return; + return $build; } /** @@ -194,8 +197,16 @@ protected function alterBuild(array &$build, EntityInterface $entity, EntityView * {@inheritdoc} */ public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { - $buildList = $this->viewMultiple(array($entity), $view_mode, $langcode); - return $buildList[0]; + $build_list = $this->viewMultiple(array($entity), $view_mode, $langcode); + + // The default ::buildMultiple() #pre_render callback won't run, because we + // extract a child element of the default renderable array. Thus we must + // assign an alternative #pre_render callback that applies the necessary + // transformations and then still calls ::buildMultiple(). + $build = $build_list[0]; + $build['#pre_render'][] = array($this, 'build'); + + return $build; } /** @@ -206,62 +217,122 @@ public function viewMultiple(array $entities = array(), $view_mode = 'full', $la $langcode = $this->languageManager->getCurrentLanguage(Language::TYPE_CONTENT)->id; } - // Build the view modes and display objects. - $view_modes = array(); - $context = array('langcode' => $langcode); + $build_list = array( + '#sorted' => TRUE, + '#pre_render' => array(array($this, 'buildMultiple')), + '#langcode' => $langcode, + ); + $weight = 0; foreach ($entities as $key => $entity) { - $bundle = $entity->bundle(); - // 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; - } + // Set build defaults. + $build_list[$key] = $this->getBuildDefaults($entity, $view_mode, $langcode); + $entityType = $this->entityTypeId; + $this->moduleHandler()->alter(array($entityType . '_build_defaults', 'entity_build_defaults'), $build_list[$key], $entity, $view_mode, $langcode); - 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); + $build_list[$key]['#weight'] = $weight++; } + return $build_list; + } + + /** + * Builds an entity's view; augments entity defaults. + * + * This function is assigned as a #pre_render callback in ::view(). + * + * It transforms the renderable array for a single entity to the same + * structure as if we were rendering multiple entities, and then calls the + * default ::buildMultiple() #pre_render callback. + * + * @param array $build + * A renderable array containing build information and context for an entity + * view. + * + * @return array + * The updated renderable array. + * + * @see drupal_render() + */ + public function build(array $build) { + $build_list = array( + '#langcode' => $build['#langcode'], + ); + $build_list[] = $build; + $build_list = $this->buildMultiple($build_list); + return $build_list[0]; + } + + /** + * Builds multiple entities' views; augments entity defaults. + * + * This function is assigned as a #pre_render callback in ::viewMultiple(). + * + * By delaying the building of an entity until the #pre_render processing in + * drupal_render(), the processing cost of assembling an entity's renderable + * array is saved on cache-hit requests. + * + * @param array $build_list + * A renderable array containing build information and context for an + * entity view. + * + * @return array + * The updated renderable array. + * + * @see drupal_render() + */ + public function buildMultiple(array $build_list) { + // Build the view modes and display objects. + $view_modes = array(); + $langcode = $build_list['#langcode']; + $entity_type_key = "#{$this->entityTypeId}"; $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']; + + // Find the keys for the ContentEntities in the build; Store entities for + // rendering by view_mode. + $children = Element::children($build_list); + foreach ($children as $key) { + if (isset($build_list[$key][$entity_type_key])) { + $entity = $build_list[$key][$entity_type_key]; + if ($entity instanceof ContentEntityInterface) { + $view_modes[$build_list[$key]['#view_mode']][$key] = $entity; } } + } - $build[$key]['#weight'] = $weight++; + // Build content for the displays represented by the entities. + foreach ($view_modes as $view_mode => $view_mode_entities) { + $displays = EntityViewDisplay::collectRenderDisplays($view_mode_entities, $view_mode); + $this->buildComponents($build_list, $view_mode_entities, $displays, $view_mode, $langcode); + foreach (array_keys($view_mode_entities) as $key) { + // Allow for alterations while building, before rendering. + $entity = $build_list[$key][$entity_type_key]; + $display = $displays[$entity->bundle()]; + + $this->moduleHandler()->invokeAll($view_hook, array(&$build_list[$key], $entity, $display, $view_mode, $langcode)); + $this->moduleHandler()->invokeAll('entity_view', array(&$build_list[$key], $entity, $display, $view_mode, $langcode)); + + $this->alterBuild($build_list[$key], $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_list[$key][$name])) { + $build_list[$key]['#weight'] = $options['weight']; + } + } - // Allow modules to modify the render array. - $this->moduleHandler->alter(array($view_hook, 'entity_view'), $build[$key], $entity, $display); + // Allow modules to modify the render array. + $this->moduleHandler()->alter(array($view_hook, 'entity_view'), $build_list[$key], $entity, $display); + } } - return $build; + return $build_list; } /** diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php b/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php index aee9588..ee1c193 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilderInterface.php @@ -16,8 +16,10 @@ interface EntityViewBuilderInterface { /** - * Build the structured $content property on the entity. + * Builds the component fields and properties of a set of entities. * + * @param &$build + * The renderable array representing the entity content. * @param \Drupal\Core\Entity\EntityInterface[] $entities * The entities whose content is being built. * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface[] $displays @@ -28,11 +30,8 @@ * @param string $langcode * (optional) For which language the entity should be build, defaults to * the current content language. - * - * @return array - * The content array. */ - public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL); + public function buildComponents(array &$build, array $entities, array $displays, $view_mode, $langcode = NULL); /** * Returns the render array for the provided entity. diff --git a/core/lib/Drupal/Core/Field/FormatterBase.php b/core/lib/Drupal/Core/Field/FormatterBase.php index e1646ff..eeb94a3 100644 --- a/core/lib/Drupal/Core/Field/FormatterBase.php +++ b/core/lib/Drupal/Core/Field/FormatterBase.php @@ -90,21 +90,8 @@ 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); } diff --git a/core/modules/block/block.api.php b/core/modules/block/block.api.php index 065a1cd..9210f82 100644 --- a/core/modules/block/block.api.php +++ b/core/modules/block/block.api.php @@ -27,7 +27,7 @@ * is hook_block_view_BASE_BLOCK_ID_alter(), which can be used to target a * specific block or set of similar blocks. * - * @param array $build + * @param array &$build * A renderable array of data, as returned from the build() implementation of * the plugin that defined the block: * - #title: The default localized title of the block. diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php deleted file mode 100644 index cee6ce8..0000000 --- a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockBuildContentTest.php +++ /dev/null @@ -1,41 +0,0 @@ - 'Rebuild content', - 'description' => 'Test the rebuilding of content for full view modes.', - 'group' => 'Custom Block', - ); - } - - /** - * Ensures that content is rebuilt in calls to custom_block_build_content(). - */ - public function testCustomBlockRebuildContent() { - $block = $this->createCustomBlock(); - - // Set a property in the content array so we can test for its existence later on. - $block->content['test_content_property'] = array( - '#value' => $this->randomString(), - ); - $content = entity_view_multiple(array($block), 'full'); - - // If the property doesn't exist it means the block->content was rebuilt. - $this->assertFalse(isset($content['test_content_property']), 'Custom block content was emptied prior to being built.'); - } -} diff --git a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCacheTagsTest.php b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCacheTagsTest.php index ccd51dd..cfd87a9 100644 --- a/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCacheTagsTest.php +++ b/core/modules/block/custom_block/lib/Drupal/custom_block/Tests/CustomBlockCacheTagsTest.php @@ -7,6 +7,7 @@ namespace Drupal\custom_block\Tests; +use Drupal\Core\Entity\EntityInterface; use Drupal\system\Tests\Entity\EntityCacheTagsTestBase; /** @@ -34,11 +35,23 @@ protected function createEntity() { $custom_block = entity_create('custom_block', array( 'info' => 'Llama', 'type' => 'basic', - 'body' => 'The name "llama" was adopted by European settlers from native Peruvians.', + 'body' => array( + 'value' => 'The name "llama" was adopted by European settlers from native Peruvians.', + 'format' => 'plain_text', + ), )); $custom_block->save(); return $custom_block; } + /** + * {@inheritdoc} + * + * Each comment must have a comment body, which always has a text format. + */ + protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) { + return array('filter_format:plain_text'); + } + } diff --git a/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module index 8c53053..65e9c56 100644 --- a/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module +++ b/core/modules/block/custom_block/tests/modules/custom_block_test/custom_block_test.module @@ -13,9 +13,9 @@ /** * Implements hook_custom_block_view(). */ -function custom_block_test_custom_block_view(CustomBlock $custom_block, $view_mode) { +function custom_block_test_custom_block_view(array &$build, CustomBlock $custom_block, $view_mode) { // Add extra content. - $custom_block->content['extra_content'] = array( + $build['extra_content'] = array( '#markup' => '', ); } diff --git a/core/modules/block/lib/Drupal/block/BlockViewBuilder.php b/core/modules/block/lib/Drupal/block/BlockViewBuilder.php index 7db7b70..9e3b1b5 100644 --- a/core/modules/block/lib/Drupal/block/BlockViewBuilder.php +++ b/core/modules/block/lib/Drupal/block/BlockViewBuilder.php @@ -22,8 +22,7 @@ class BlockViewBuilder extends EntityViewBuilder { /** * {@inheritdoc} */ - public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) { - return array(); + public function buildComponents(array &$build, array $entities, array $displays, $view_mode, $langcode = NULL) { } /** diff --git a/core/modules/book/book.module b/core/modules/book/book.module index 8c52221..e5bb818 100644 --- a/core/modules/book/book.module +++ b/core/modules/book/book.module @@ -247,11 +247,11 @@ function book_node_load($nodes) { /** * Implements hook_node_view(). */ -function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { +function book_node_view(array &$build, EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { if ($view_mode == 'full') { if (!empty($node->book['bid']) && empty($node->in_preview)) { $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book); - $node->content['book_navigation'] = array( + $build['book_navigation'] = array( '#markup' => drupal_render($book_navigation), '#weight' => 100, '#attached' => array( diff --git a/core/modules/comment/comment.api.php b/core/modules/comment/comment.api.php index 8507f13..9d77557 100644 --- a/core/modules/comment/comment.api.php +++ b/core/modules/comment/comment.api.php @@ -84,6 +84,8 @@ function hook_comment_load(Drupal\comment\Comment $comments) { /** * Act on a comment that is being assembled before rendering. * + * @param array &$build + * A renderable array representing the comment content. * @param \Drupal\comment\Entity\Comment $comment $comment * Passes in the comment the action is being performed on. * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display @@ -96,12 +98,12 @@ function hook_comment_load(Drupal\comment\Comment $comments) { * * @see hook_entity_view() */ -function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { +function hook_comment_view(array &$build, \Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // node type in hook_entity_extra_field_info(). if ($display->getComponent('mymodule_addition')) { - $comment->content['mymodule_addition'] = array( + $build['mymodule_addition'] = array( '#markup' => mymodule_addition($comment), '#theme' => 'mymodule_my_additional_field', ); @@ -120,7 +122,7 @@ function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\Core * callback. Alternatively, it could also implement hook_preprocess_HOOK() for * comment.html.twig. See drupal_render() documentation for details. * - * @param $build + * @param array &$build * A renderable array representing the comment. * @param \Drupal\comment\Entity\Comment $comment * The comment being rendered. @@ -131,7 +133,7 @@ function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\Core * @see comment_view() * @see hook_entity_view_alter() */ -function hook_comment_view_alter(&$build, \Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { +function hook_comment_view_alter(array &$build, \Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { // Check for the existence of a field added by another module. if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index 4115444..4d35ff5 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\Render\Element; use Drupal\Core\Url; @@ -359,20 +360,22 @@ function comment_new_page_count($num_comments, $new_replies, EntityInterface $en } /** - * Implements hook_entity_view_alter(). + * Implements hook_entity_build_defaults_alter(). */ -function comment_entity_view_alter(&$build, EntityInterface $entity, EntityViewDisplayInterface $display) { +function comment_entity_build_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; } /** @@ -534,7 +537,7 @@ function comment_node_links_alter(array &$node_links, NodeInterface $node, array /** * Implements hook_node_view_alter(). */ -function comment_node_view_alter(&$build, EntityInterface $node, EntityViewDisplayInterface $display) { +function comment_node_view_alter(array &$build, EntityInterface $node, EntityViewDisplayInterface $display) { if (\Drupal::moduleHandler()->moduleExists('history')) { $build['#attributes']['data-history-node-id'] = $node->id(); } @@ -1242,16 +1245,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; @@ -1282,7 +1282,7 @@ function comment_preprocess_block(&$variables) { * A user account, for use with theme_username() or the user_picture template. */ function comment_prepare_author(CommentInterface $comment) { - // The account has been pre-loaded by CommentViewBuilder::buildContent(). + // The account has been pre-loaded by CommentViewBuilder::buildComponents(). $account = $comment->getOwner(); if (empty($account->uid->value)) { // @todo Avoid creating a new entity by just creating a new instance diff --git a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php index da28f7b..02e427f 100644 --- a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php +++ b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php @@ -14,6 +14,8 @@ use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\EntityViewBuilder; +use Drupal\entity\Entity\EntityViewDisplay; +use Drupal\Core\Language\Language; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\field\FieldInfo; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -78,7 +80,7 @@ public function __construct(EntityTypeInterface $entity_type, EntityManagerInter } /** - * Overrides Drupal\Core\Entity\EntityViewBuilder::buildContent(). + * Overrides Drupal\Core\Entity\EntityViewBuilder::buildComponents(). * * In addition to modifying the content key on entities, this implementation * will also set the comment entity key which all comments carry. @@ -86,11 +88,10 @@ public function __construct(EntityTypeInterface $entity_type, EntityManagerInter * @throws \InvalidArgumentException * Thrown when a comment is attached to an entity that no longer exists. */ - public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) { + public function buildComponents(array &$build, array $entities, array $displays, $view_mode, $langcode = NULL) { /** @var \Drupal\comment\CommentInterface[] $entities */ - $return = array(); if (empty($entities)) { - return $return; + return; } // Pre-load associated users into cache to leverage multiple loading. @@ -100,7 +101,7 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang } $this->entityManager->getStorage('user')->loadMultiple(array_unique($uids)); - parent::buildContent($entities, $displays, $view_mode, $langcode); + parent::buildComponents($build, $entities, $displays, $view_mode, $langcode); // Load all the entities that have comments attached. $commented_entity_ids = array(); @@ -114,37 +115,43 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang $commented_entities[$entity_type] = $this->entityManager->getStorage($entity_type)->loadMultiple($entity_ids); } - foreach ($entities as $entity) { + foreach ($entities as $id => $entity) { if (isset($commented_entities[$entity->getCommentedEntityTypeId()][$entity->getCommentedEntityId()])) { $commented_entity = $commented_entities[$entity->getCommentedEntityTypeId()][$entity->getCommentedEntityId()]; } else { throw new \InvalidArgumentException(t('Invalid entity for comment.')); } - $entity->content['#entity'] = $entity; - $entity->content['#theme'] = 'comment__' . $entity->getFieldId() . '__' . $commented_entity->bundle(); - $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), + $build[$id]['#entity'] = $entity; + $build[$id]['#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(), + ); + $build[$id]['links'] = array( + '#post_render_cache' => array( + $callback => array( + $context, + ), ), + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), ); - if (!isset($entity->content['#attached'])) { - $entity->content['#attached'] = array(); + if (!isset($build[$id]['#attached'])) { + $build[$id]['#attached'] = array(); } - $entity->content['#attached']['library'][] = 'comment/drupal.comment-by-viewer'; + $build[$id]['#attached']['library'][] = 'comment/drupal.comment-by-viewer'; if ($this->moduleHandler->moduleExists('history') && \Drupal::currentUser()->isAuthenticated()) { - $entity->content['#attached']['library'][] = 'comment/drupal.comment-new-indicator'; + $build[$id]['#attached']['library'][] = 'comment/drupal.comment-new-indicator'; // Embed the metadata for the comment "new" indicators on this node. - $entity->content['#post_render_cache']['history_attach_timestamp'] = array( + $build[$id]['#post_render_cache']['history_attach_timestamp'] = array( array('node_id' => $commented_entity->id()), ); } @@ -156,6 +163,8 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang * * Renders the links on a comment. * + * @param array $element + * The renderable array that contains the to be replaced placeholder. * @param array $context * An array with the following keys: * - comment_entity_id: a comment entity ID @@ -168,7 +177,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 +200,10 @@ public static function renderLinks(array $context) { ); \Drupal::moduleHandler()->alter('comment_links', $links, $entity, $hook_context); } + $markup = drupal_render($links); + $element['#markup'] = str_replace($placeholder, $markup, $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 639cbb0..154edf6 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']), ); } } @@ -190,6 +196,8 @@ public function viewElements(FieldItemListInterface $items) { /** * #post_render_cache callback; replaces placeholder with comment form. * + * @param array $element + * The renderable array that contains the to be replaced placeholder. * @param array $context * An array with the following keys: * - entity_type: an entity type @@ -199,9 +207,17 @@ 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: This only works as long as assets are still tracked in a global + // static variable, see https://drupal.org/node/2238835 + $markup = drupal_render($form, TRUE); + $element['#markup'] = str_replace($placeholder, $markup, $element['#markup']); + + return $element; } /** diff --git a/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php b/core/modules/comment/lib/Drupal/comment/Tests/CommentCacheTagsTest.php index 07cac6e..d12c6bb 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; /** @@ -57,10 +58,13 @@ protected function createEntity() { )); $entity_test->save(); - // Create a "Llama" taxonomy term. + // Create a "Llama" comment. $comment = entity_create('comment', array( 'subject' => 'Llama', - 'comment_body' => 'The name "llama" was adopted by European settlers from native Peruvians.', + 'comment_body' => array( + 'value' => 'The name "llama" was adopted by European settlers from native Peruvians.', + 'format' => 'plain_text', + ), 'entity_id' => $entity_test->id(), 'entity_type' => 'entity_test', 'field_name' => 'comment', @@ -71,4 +75,13 @@ protected function createEntity() { return $comment; } + /** + * {@inheritdoc} + * + * Each comment must have a comment body, which always has a text format. + */ + protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) { + return array('filter_format:plain_text'); + } + } diff --git a/core/modules/comment/lib/Drupal/comment/Tests/CommentContentRebuildTest.php b/core/modules/comment/lib/Drupal/comment/Tests/CommentContentRebuildTest.php deleted file mode 100644 index c467a09..0000000 --- a/core/modules/comment/lib/Drupal/comment/Tests/CommentContentRebuildTest.php +++ /dev/null @@ -1,46 +0,0 @@ - 'Comment Rebuild', - 'description' => 'Test to make sure the comment content is rebuilt.', - 'group' => 'Comment', - ); - } - - /** - * Tests the rebuilding of comment's content arrays on calling comment_view(). - */ - function testCommentRebuild() { - // Update the comment settings so preview isn't required. - $this->drupalLogin($this->admin_user); - $this->setCommentSubject(TRUE); - $this->setCommentPreview(DRUPAL_OPTIONAL); - $this->drupalLogout(); - - // Log in as the web user and add the comment. - $this->drupalLogin($this->web_user); - $subject_text = $this->randomName(); - $comment_text = $this->randomName(); - $comment = $this->postComment($this->node, $comment_text, $subject_text, TRUE); - $this->assertTrue($this->commentExists($comment), 'Comment found.'); - - // Add the property to the content array and then see if it still exists on build. - $comment->content['test_property'] = array('#value' => $this->randomString()); - $built_content = comment_view($comment); - - // This means that the content was rebuilt as the added test property no longer exists. - $this->assertFalse(isset($built_content['test_property']), 'Comment content was emptied before being built.'); - } -} diff --git a/core/modules/contact/lib/Drupal/contact/MessageViewBuilder.php b/core/modules/contact/lib/Drupal/contact/MessageViewBuilder.php index f5eedb7..4cbbd2c 100644 --- a/core/modules/contact/lib/Drupal/contact/MessageViewBuilder.php +++ b/core/modules/contact/lib/Drupal/contact/MessageViewBuilder.php @@ -20,14 +20,14 @@ class MessageViewBuilder extends EntityViewBuilder { /** * {@inheritdoc} */ - public function buildContent(array $entities, array $displays, $view_mode, $langcode = NULL) { - parent::buildContent($entities, $displays, $view_mode, $langcode); + public function buildComponents(array &$build, array $entities, array $displays, $view_mode, $langcode = NULL) { + parent::buildComponents($build, $entities, $displays, $view_mode, $langcode); - foreach ($entities as $entity) { + foreach ($entities as $id => $entity) { // Add the message extra field, if enabled. $display = $displays[$entity->bundle()]; if ($entity->getMessage() && $display->getComponent('message')) { - $entity->content['message'] = array( + $build[$id]['message'] = array( '#type' => 'item', '#title' => t('Message'), '#markup' => String::checkPlain($entity->getMessage()), diff --git a/core/modules/datetime/lib/Drupal/datetime/Tests/DateTimeFieldTest.php b/core/modules/datetime/lib/Drupal/datetime/Tests/DateTimeFieldTest.php index 76b4cb9..dc28adf 100644 --- a/core/modules/datetime/lib/Drupal/datetime/Tests/DateTimeFieldTest.php +++ b/core/modules/datetime/lib/Drupal/datetime/Tests/DateTimeFieldTest.php @@ -457,8 +457,8 @@ protected function renderTestEntity($id, $view_mode = 'full', $reset = TRUE) { } $entity = entity_load('entity_test', $id); $display = EntityViewDisplay::collectRenderDisplay($entity, $view_mode); - $entity->content = $display->build($entity); - $output = drupal_render($entity->content); + $build = $display->build($entity); + $output = drupal_render($build); $this->drupalSetContent($output); $this->verbose($output); } diff --git a/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php b/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php index e77c440..3dcc55d 100644 --- a/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php +++ b/core/modules/entity/lib/Drupal/entity/Entity/EntityViewDisplay.php @@ -209,9 +209,9 @@ public function build(ContentEntityInterface $entity) { * {@inheritdoc} */ public function buildMultiple(array $entities) { - $build = array(); + $build_list = array(); foreach ($entities as $key => $entity) { - $build[$key] = array(); + $build_list[$key] = array(); } // Run field formatters. @@ -230,8 +230,8 @@ 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); - $build[$key][$field_name]['#access'] = $items->access('view'); + $build_list[$key][$field_name] = $formatter->view($items); + $build_list[$key][$field_name]['#access'] = $items->access('view'); } } } @@ -239,8 +239,8 @@ public function buildMultiple(array $entities) { foreach ($entities as $key => $entity) { // Assign the configured weights. foreach ($this->getComponents() as $name => $options) { - if (isset($build[$key][$name])) { - $build[$key][$name]['#weight'] = $options['weight']; + if (isset($build_list[$key][$name])) { + $build_list[$key][$name]['#weight'] = $options['weight']; } } @@ -250,10 +250,10 @@ public function buildMultiple(array $entities) { 'view_mode' => $this->originalMode, 'display' => $this, ); - \Drupal::moduleHandler()->alter('entity_display_build', $build[$key], $context); + \Drupal::moduleHandler()->alter('entity_display_build', $build_list[$key], $context); } - return $build; + return $build_list; } } diff --git a/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php b/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php index dd1bfa0..4b25e76 100644 --- a/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php +++ b/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php @@ -365,16 +365,23 @@ protected function getFieldDefinitions() { if (!isset($this->fieldDefinitions)) { $definitions = \Drupal::entityManager()->getFieldDefinitions($this->targetEntityType, $this->bundle); - - // The display only cares about fields that specify display options. - // Discard base fields that are not rendered through formatters / widgets. - $display_context = $this->displayContext; - $this->fieldDefinitions = array_filter($definitions, function (FieldDefinitionInterface $definition) use ($display_context) { - return $definition->getDisplayOptions($display_context); - }); + $this->fieldDefinitions = array_filter($definitions, array($this, 'fieldHasDisplayOptions')); } return $this->fieldDefinitions; } + /** + * Determines if a field has options for a given display. + * + * @param FieldDefinitionInterface $definition + * A field instance definition. + * @return array|null + */ + private function fieldHasDisplayOptions(FieldDefinitionInterface $definition) { + // The display only cares about fields that specify display options. + // Discard base fields that are not rendered through formatters / widgets. + return $definition->getDisplayOptions($this->displayContext); + } + } diff --git a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php index 623140f..d8d9d41 100644 --- a/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php +++ b/core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/Field/FieldFormatter/EntityReferenceEntityFormatter.php @@ -93,9 +93,24 @@ public function viewElements(FieldItemListInterface $items) { } if (!empty($item->target_id)) { - $entity = clone $item->entity; - unset($entity->content); - $elements[$delta] = entity_view($entity, $view_mode, $item->getLangcode()); + $elements[$delta] = entity_view($item->entity, $view_mode, $item->getLangcode()); + + // Entity field formatters are run during the #pre_render phase of + // rendering an entity. Therefore, that is the time when this function + // runs. After that #pre_render callback, all cache tags must be + // available. However, this field formatter is highly exceptional: it + // renders *another* entity (i.e. an entity within an entity). That + // other entity comes with its own #pre_render callback that must be + // called in order for the cache tags associated with that other entity + // to be included with those of the main entity. Hence we must run the + // other entity's #pre_render callbacks *immediately*, otherwise its + // associated cache tags won't bubble up correctly. + if (isset($elements[$delta]['#pre_render'])) { + foreach ($elements[$delta]['#pre_render'] as $callable) { + $elements[$delta] = call_user_func($callable, $elements[$delta]); + } + } + unset($elements[$delta]['#pre_render']); if (empty($links) && isset($result[$delta][$target_type][$item->target_id]['links'])) { // Hide the element links. 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..6d4c28d 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 @@ -8,6 +8,7 @@ namespace Drupal\entity_reference\Plugin\Field\FieldFormatter; use Drupal\Core\Field\FieldItemListInterface; +use Drupal\Component\Utility\String; /** * Plugin implementation of the 'entity reference ID' formatter. @@ -35,7 +36,17 @@ public function viewElements(FieldItemListInterface $items) { continue; } if (!empty($item->entity) && !empty($item->target_id)) { - $elements[$delta] = array('#markup' => check_plain($item->target_id)); + /** @var $referenced_entity \Drupal\Core\Entity\EntityInterface */ + $referenced_entity = $item->entity; + $elements[$delta] = array( + '#markup' => String::checkPlain($item->target_id), + // Create a cache tag entry for the referenced entity. In the case + // that the referenced entity is deleted, the cache for referring + // entities must be cleared. + '#cache' => array( + 'tags' => $referenced_entity->getCacheTag(), + ), + ); } } 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..bc305cd 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,7 @@ public function viewElements(FieldItemListInterface $items) { else { $elements[$delta] = array('#markup' => check_plain($label)); } + $elements[$delta]['#cache']['tags'] = $referenced_entity->getCacheTag(); } } diff --git a/core/modules/entity_reference/lib/Drupal/entity_reference/Tests/EntityReferenceFormatterTest.php b/core/modules/entity_reference/lib/Drupal/entity_reference/Tests/EntityReferenceFormatterTest.php index 44bcca1..478c506 100644 --- a/core/modules/entity_reference/lib/Drupal/entity_reference/Tests/EntityReferenceFormatterTest.php +++ b/core/modules/entity_reference/lib/Drupal/entity_reference/Tests/EntityReferenceFormatterTest.php @@ -9,8 +9,6 @@ use Drupal\system\Tests\Entity\EntityUnitTestBase; -use Symfony\Component\HttpFoundation\Request; - /** * Tests Entity Reference formatters. */ @@ -38,6 +36,13 @@ class EntityReferenceFormatterTest extends EntityUnitTestBase { protected $fieldName = 'field_test'; /** + * The entity to be referenced in this test. + * + * @var \Drupal\Core\Entity\EntityInterface + */ + protected $referencedEntity = NULL; + + /** * Modules to enable. * * @var array @@ -55,7 +60,41 @@ public static function getInfo() { public function setUp() { parent::setUp(); + $this->installConfig(array('filter')); + entity_reference_create_instance($this->entityType, $this->bundle, $this->fieldName, 'Field test', $this->entityType); + + // Set up a field, so that the entity that'll be referenced bubbles up a + // cache tag when rendering it entirely. + entity_create('field_config', array( + 'name' => 'body', + 'entity_type' => $this->entityType, + 'type' => 'text', + 'settings' => array(), + ))->save(); + entity_create('field_instance_config', array( + 'entity_type' => $this->entityType, + 'bundle' => $this->bundle, + 'field_name' => 'body', + 'label' => 'Body', + 'settings' => array( + 'text_processing' => TRUE, + ), + ))->save(); + entity_get_display($this->entityType, $this->bundle, 'default') + ->setComponent('body', array( + 'type' => 'text_default', + 'settings' => array(), + )) + ->save(); + + // Create the entity to be referenced. + $this->referencedEntity = entity_create($this->entityType, array('name' => $this->randomName())); + $this->referencedEntity->body = array( + 'value' => '
Hello, world!
', + 'format' => 'full_html', + ); + $this->referencedEntity->save(); } /** @@ -64,15 +103,12 @@ public function setUp() { public function testAccess() { $field_name = $this->fieldName; - $entity_1 = entity_create($this->entityType, array('name' => $this->randomName())); - $entity_1->save(); - - $entity_2 = entity_create($this->entityType, array('name' => $this->randomName())); - $entity_2->save(); - $entity_2->{$field_name}->entity = $entity_1; + $referencing_entity = entity_create($this->entityType, array('name' => $this->randomName())); + $referencing_entity->save(); + $referencing_entity->{$field_name}->entity = $this->referencedEntity; // Assert user doesn't have access to the entity. - $this->assertFalse($entity_1->access('view'), 'Current user does not have access to view the referenced entity.'); + $this->assertFalse($this->referencedEntity->access('view'), 'Current user does not have access to view the referenced entity.'); $formatter_manager = $this->container->get('plugin.manager.field.formatter'); @@ -86,10 +122,69 @@ public function testAccess() { ->save(); // Invoke entity view. - entity_view($entity_2, 'default'); + entity_view($referencing_entity, 'default'); // Verify the un-accessible item still exists. - $this->assertEqual($entity_2->{$field_name}->value, $entity_1->id(), format_string('The un-accessible item still exists after @name formatter was executed.', array('@name' => $name))); + $this->assertEqual($referencing_entity->{$field_name}->value, $this->referencedEntity->id(), format_string('The un-accessible item still exists after @name formatter was executed.', array('@name' => $name))); } } + + /** + * Tests the ID formatter. + */ + public function testIdFormatter() { + $formatter = 'entity_reference_entity_id'; + $field_name = $this->fieldName; + + // Create the entity that will have the entity reference field. + $referencing_entity = entity_create($this->entityType, array('name' => $this->randomName())); + $referencing_entity->save(); + $referencing_entity->{$field_name}->entity = $this->referencedEntity; + $referencing_entity->{$field_name}->access = TRUE; + + // Build the renderable array for the entity reference field. + $items = $referencing_entity->get($field_name); + $build = $items->view(array('type' => $formatter)); + + $this->assertEqual($build[0]['#markup'], $this->referencedEntity->id(), format_string('The markup returned by the @formatter formatter is correct.', array('@formatter' => $formatter))); + $expected_cache_tags = array( + $this->entityType => array($this->referencedEntity->id()), + ); + $this->assertEqual($build[0]['#cache']['tags'], $expected_cache_tags, format_string('The @formatter formatter has the expected cache tags.', array('@formatter' => $formatter))); + + } + + /** + * Tests the entity formatter. + */ + public function testEntityFormatter() { + $formatter = 'entity_reference_entity_view'; + $field_name = $this->fieldName; + + // Create the entity that will have the entity reference field. + $referencing_entity = entity_create($this->entityType, array('name' => $this->randomName())); + $referencing_entity->save(); + $referencing_entity->{$field_name}->entity = $this->referencedEntity; + $referencing_entity->{$field_name}->access = TRUE; + + // Build the renderable array for the entity reference field. + $items = $referencing_entity->get($field_name); + $build = $items->view(array('type' => $formatter)); + + $expected_rendered_body_field = '' . t('Extra data that should appear only in the RSS feed for node !nid.', array('!nid' => $node->id())) . '
', '#weight' => 10, ); @@ -33,13 +32,22 @@ function node_test_node_view(NodeInterface $node, EntityViewDisplayInterface $di if ($view_mode != 'rss') { // Add content that should NOT be displayed in the RSS feed. - $node->content['extra_non_feed_content'] = array( + $build['extra_non_feed_content'] = array( '#markup' => '' . t('Extra data that should appear everywhere except the RSS feed for node !nid.', array('!nid' => $node->id())) . '
', ); } } /** + * Implements hook_ENTITY_TYPE_build_defaults_alter(). + */ +function node_test_node_build_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(AccountInterface $account, $op) { diff --git a/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php b/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php index 50ba5c3..bf603d3 100644 --- a/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php +++ b/core/modules/simpletest/lib/Drupal/simpletest/WebTestBase.php @@ -15,6 +15,7 @@ use Drupal\Core\DrupalKernel; use Drupal\Core\Database\Database; use Drupal\Core\Database\ConnectionNotDefinedException; +use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Language\Language; use Drupal\Core\Session\AccountInterface; use Drupal\Core\Session\AnonymousUserSession; @@ -342,6 +343,53 @@ protected function drupalCreateContentType(array $values = array()) { } /** + * Builds the renderable view of an entity. + * + * Entities postpone the composition of their renderable arrays to #pre_render + * functions in order to maximize cache efficacy. This means that the full + * rendable array for an entity is constructed in drupal_render(). Some tests + * require the complete renderable array for an entity outside of the + * drupal_render process in order to verify the presence of specific values. + * This method isolates the steps in the render process that produce an + * entity's renderable array. + * + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity to prepare a renderable array for. + * @param string $view_mode + * (optional) The view mode that should be used to build the entity. + * @param null $langcode + * (optional) For which language the entity should be prepared, defaults to + * the current content language. + * @param bool $reset + * (optional) Whether to clear the cache for this entity. + * @return array + * + * @see drupal_render() + */ + protected function drupalBuildEntityView(EntityInterface $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/statistics/statistics.module b/core/modules/statistics/statistics.module index 8877181..4b2110c 100644 --- a/core/modules/statistics/statistics.module +++ b/core/modules/statistics/statistics.module @@ -48,11 +48,11 @@ function statistics_permission() { /** * Implements hook_node_view(). */ -function statistics_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { +function statistics_node_view(array &$build, EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { if (!$node->isNew() && $view_mode == 'full' && node_is_page($node) && empty($node->in_preview)) { - $node->content['statistics_content_counter']['#attached']['library'][] = 'statistics/drupal.statistics'; + $build['statistics_content_counter']['#attached']['library'][] = 'statistics/drupal.statistics'; $settings = array('data' => array('nid' => $node->id()), 'url' => url(drupal_get_path('module', 'statistics') . '/statistics.php')); - $node->content['statistics_content_counter']['#attached']['js'][] = array( + $build['statistics_content_counter']['#attached']['js'][] = array( 'data' => array('statistics' => $settings), 'type' => 'setting', ); diff --git a/core/modules/system/entity.api.php b/core/modules/system/entity.api.php index c53444b..f2e989c 100644 --- a/core/modules/system/entity.api.php +++ b/core/modules/system/entity.api.php @@ -436,6 +436,8 @@ function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query /** * Act on entities being assembled before rendering. * + * @param &$build + * A renderable array representing the entity content. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity object. * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display @@ -446,8 +448,8 @@ function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query * @param $langcode * The language code used for rendering. * - * The module may add elements to $entity->content prior to rendering. The - * structure of $entity->content is a renderable array as expected by + * The module may add elements to $build prior to rendering. The + * structure of $build is a renderable array as expected by * drupal_render(). * * @see hook_entity_view_alter() @@ -455,12 +457,12 @@ function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query * @see hook_node_view() * @see hook_user_view() */ -function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { +function hook_entity_view(array &$build, \Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // entity bundle in hook_entity_extra_field_info(). if ($display->getComponent('mymodule_addition')) { - $entity->content['mymodule_addition'] = array( + $build['mymodule_addition'] = array( '#markup' => mymodule_addition($entity), '#theme' => 'mymodule_my_additional_field', ); @@ -480,7 +482,7 @@ function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\C * the particular entity type template, if there is one (e.g., node.html.twig). * See drupal_render() and _theme() for details. * - * @param $build + * @param array &$build * A renderable array representing the entity content. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity object being rendered. @@ -494,7 +496,7 @@ function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\C * @see hook_taxonomy_term_view_alter() * @see hook_user_view_alter() */ -function hook_entity_view_alter(&$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { +function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. $build['an_additional_field']['#weight'] = -10; @@ -561,6 +563,54 @@ function hook_entity_view_mode_alter(&$view_mode, Drupal\Core\Entity\EntityInter } /** + * Alters entity renderable values before cache checking in drupal_render(). + * + * Invoked for a specific entity type. + * + * The values in the #cache key of the renderable array are used to determine if + * a cache entry exists for the entity's rendered output. Ideally only values + * that pertain to caching should be altered in this hook. + * + * @param array &$build + * A renderable array containing the entity's caching and view mode values. + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity that is being viewed. + * @param string $view_mode + * The view_mode that is to be used to display the entity. + * @param string $langcode + * The code of the language $entity is accessed in. + * + * @see drupal_render() + * @see \Drupal\Core\Entity\EntityViewBuilder + */ +function hook_ENTITY_TYPE_build_defaults_alter(array &$build, \Drupal\Core\Entity\EntityInterface $entity, $view_mode, $langcode) { + +} + +/** + * Alters entity renderable values before cache checking in drupal_render(). + * + * The values in the #cache key of the renderable array are used to determine if + * a cache entry exists for the entity's rendered output. Ideally only values + * that pertain to caching should be altered in this hook. + * + * @param array &$build + * A renderable array containing the entity's caching and view mode values. + * @param \Drupal\Core\Entity\EntityInterface $entity + * The entity that is being viewed. + * @param string $view_mode + * The view_mode that is to be used to display the entity. + * @param string $langcode + * The code of the language $entity is accessed in. + * + * @see drupal_render() + * @see \Drupal\Core\Entity\EntityViewBuilder + */ +function hook_entity_build_defaults_alter(array &$build, \Drupal\Core\Entity\EntityInterface $entity, $view_mode, $langcode) { + +} + +/** * Alters the settings used for displaying an entity. * * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display 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 349a14e..caa80a2 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Common/RenderTest.php @@ -472,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.'); @@ -490,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.'); @@ -514,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.'); @@ -532,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.'); @@ -596,7 +592,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.'); @@ -642,7 +637,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.'); @@ -655,7 +649,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.'); @@ -677,7 +670,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.'); @@ -752,7 +744,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.'); @@ -765,7 +756,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.'); @@ -775,16 +765,22 @@ function testDrupalRenderChildrenPostRenderCache() { \Drupal::request()->setMethod($request_method); } - /** * Tests post-render cache-integrated 'render_cache_placeholder' element. */ function testDrupalRenderRenderCachePlaceholder() { - $context = array('bar' => $this->randomContextValue()); + $context = array( + 'bar' => $this->randomContextValue(), + 'token' => drupal_render_cache_generate_token(), + ); + $callback = 'common_test_post_render_cache_placeholder'; $test_element = array( - '#type' => 'render_cache_placeholder', - '#context' => $context, - '#callback' => 'common_test_post_render_cache_placeholder', + '#post_render_cache' => array( + $callback => array( + $context + ), + ), + '#markup' => drupal_render_cache_generate_placeholder($callback, $context, $context['token']), '#prefix' => '