render_cache_comment.module in Render cache 7.2

Hijacks comment.module's implementation of hook_node_view() to enable entity caching.

File

modules/utility/render_cache_comment/render_cache_comment.module

<?php

/**
 * @file
 * Hijacks comment.module's implementation of hook_node_view() to enable entity caching.
 */
use Drupal\render_cache\Cache\RenderCachePlaceholder;

/**
 * Implements hook_module_implements_alter().
 *
 * @param array $implementations
 *   Format: $[$module] = string|false
 * @param string $hook
 */
function render_cache_comment_module_implements_alter(&$implementations, $hook) {
  if ($hook == 'node_view') {
    unset($implementations['comment']);
  }
}

/**
 * Implements hook_node_view()
 *
 * Runs instead of comment_node_view(), but not necessarily in the same position
 * in the order of hook_node_view() implementations.
 *
 * @param object $node
 * @param string $view_mode
 */
function render_cache_comment_node_view($node, $view_mode) {

  // Save original preview state.
  $in_preview = !empty($node->in_preview);

  // Call the original function, but set the preview bit, so that the comments
  // are not rendered.
  $node->in_preview = TRUE;
  comment_node_view($node, $view_mode);

  // Restore previous value.
  $node->in_preview = $in_preview;

  // Now do the rest of comment_node_view() that was skipped, but using our own
  // render function.  This if-clause was copied from comment_node_view().
  if ($node->comment && $view_mode == 'full' && node_is_page($node) && empty($node->in_preview)) {

    // Use a placeholder to make the containing node cache-eable - if we are not called at the top-level.
    if (variable_get('render_cache_comment_use_placeholder', TRUE) && RenderCache::isRecursive()) {
      $node->content['comments'] = RenderCachePlaceholder::getPlaceholder('render_cache_comment_node_page_additions', array(
        '%node' => $node->nid,
      ));
    }
    else {
      $node->content['comments'] = render_cache_comment_node_page_additions($node);
    }
  }
}

/**
 * Replaces comment_node_page_additions(), with added entity caching.
 *
 * This uses @see entity_view() instead of @see comment_view_multiple(), to
 * enable entity_view() render caching.
 *
 * @param object $node
 *
 * @return array
 */
function render_cache_comment_node_page_additions($node) {
  $additions = array();

  // Only attempt to render comments if the node has visible comments.
  // Unpublished comments are not included in $node->comment_count, so show
  // comments unconditionally if the user is an administrator.
  if ($node->comment_count && user_access('access comments') || user_access('administer comments')) {
    $mode = variable_get('comment_default_mode_' . $node->type, COMMENT_MODE_THREADED);
    $comments_per_page = variable_get('comment_default_per_page_' . $node->type, 50);
    if ($cids = comment_get_thread($node, $mode, $comments_per_page)) {
      $comments = comment_load_multiple($cids);
      comment_prepare_thread($comments);

      // CHANGED: Use entity_view() here to ensure caching is possible.
      $build = entity_view('comment', $comments);
      $build['pager']['#theme'] = 'pager';
      $additions['comments'] = $build;
    }
  }

  // Append comment form if needed.
  if (user_access('post comments') && $node->comment == COMMENT_NODE_OPEN && variable_get('comment_form_location_' . $node->type, COMMENT_FORM_BELOW) == COMMENT_FORM_BELOW) {
    $build = drupal_get_form("comment_node_{$node->type}_form", (object) array(
      'nid' => $node->nid,
    ));
    $additions['comment_form'] = $build;
  }
  if ($additions) {
    $additions += array(
      '#theme' => 'comment_wrapper__node_' . $node->type,
      '#node' => $node,
      'comments' => array(),
      'comment_form' => array(),
    );
  }
  return $additions;
}

Functions

Name	Description
render_cache_comment_module_implements_alter	Implements hook_module_implements_alter().
render_cache_comment_node_page_additions	Replaces comment_node_page_additions(), with added entity caching.
render_cache_comment_node_view	Implements hook_node_view()