class RenderCachePlaceholder in Render cache 7.2

Provides placeholder utility functions.

Hierarchy

• class \Drupal\render_cache\Cache\RenderCachePlaceholder implements RenderCachePlaceholderInterface

3 files declare their use of RenderCachePlaceholder

BaseController.php in src/RenderCache/Controller/BaseController.php

Contains \Drupal\render_cache\RenderCache\Controller\BaseController

RenderCachePlaceholderTest.php in tests/src/Cache/RenderCachePlaceholderTest.php

Contains \Drupal\render_cache\Tests\Cache\RenderCachePlaceholderTest

render_cache_comment.module in modules/utility/render_cache_comment/render_cache_comment.module

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

File

src/Cache/RenderCachePlaceholder.php, line 16

Contains \Drupal\render_cache\Cache\RenderCachePlaceholder

Namespace

Drupal\render_cache\Cache

class RenderCachePlaceholder implements RenderCachePlaceholderInterface {

  /**
   * {@inheritdoc}
   */
  public static function getPlaceholder($function, array $args = array(), $multiple = FALSE) {

    // Add the classname to the front.
    $callback = get_called_class();
    $callback .= $multiple ? '::postRenderCacheMultiCallback' : '::postRenderCacheCallback';
    $context = array(
      'function' => $function,
      'args' => $args,
    );
    $placeholder = static::generatePlaceholder($context['function'], $context);
    $context = array(
      $context,
    );
    if ($multiple) {
      $context = array(
        $function => $context,
      );
    }
    return array(
      '#post_render_cache' => array(
        $callback => $context,
      ),
      '#markup' => $placeholder,
    );
  }

  /**
   * {@inheritdoc}
   */
  public static function postRenderCacheMultiCallback(array $element, array $contexts) {

    // Check this is really a multi placeholder.
    if (isset($contexts['function']) || !isset($contexts[0]['function'])) {
      return $element;
    }
    $function = $contexts[0]['function'];
    $args = array();
    foreach ($contexts as $context) {
      $placeholder = static::generatePlaceholder($context['function'], $context);

      // Check if the placeholder is present at all.
      if (strpos($element['#markup'], $placeholder) === FALSE) {
        continue;
      }
      $args[$placeholder] = static::loadPlaceholderFunctionArgs($context);
    }

    // This expects an array keyed by placeholder with the build as value.
    $placeholders = call_user_func($function, $args);
    foreach ($placeholders as $placeholder => $new_element) {
      $markup = static::drupalRender($new_element);
      $element['#markup'] = str_replace($placeholder, $markup, $element['#markup']);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function postRenderCacheCallback(array $element, array $context) {
    $placeholder = static::generatePlaceholder($context['function'], $context);

    // Check if the placeholder is present at all.
    if (strpos($element['#markup'], $placeholder) === FALSE) {
      return $element;
    }
    $function = $context['function'];
    $args = static::loadPlaceholderFunctionArgs($context);
    $new_element = call_user_func_array($function, $args);
    $markup = static::drupalRender($new_element);
    $element['#markup'] = str_replace($placeholder, $markup, $element['#markup']);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function loadPlaceholderFunctionArgs(array $context) {
    $args = array();
    foreach ($context['args'] as $key => $arg) {

      // In case a dynamic argument has been passed, load it with the loader.
      if (strpos($key, '%') !== 0) {
        $args[$key] = $arg;
        continue;
      }
      $prefix = substr($key, 1);
      $loader_functions = array(
        $prefix . '_load',
        $prefix . 'Load',
      );
      foreach ($loader_functions as $loader_function) {
        if (is_callable($loader_function)) {
          $arg = call_user_func($loader_function, $arg);
        }
      }
      $args[$key] = $arg;
    }
    return $args;
  }

  /**
   * Generates a render cache placeholder.
   *
   * @param string $callback
   *   The #post_render_cache callback that will replace the placeholder with its
   *   eventual markup.
   * @param array $context
   *   An array providing context for the #post_render_cache callback. This array
   *   will be altered to provide a 'token' key/value pair, if not already
   *   provided, to uniquely identify the generated placeholder.
   *
   * @return string
   *   The generated placeholder HTML.
   *
   * @codeCoverageIgnore
   */
  protected static function generatePlaceholder($callback, array &$context) {
    return drupal_render_cache_generate_placeholder($callback, $context);
  }

  /**
   * Overrides drupal_render().
   *
   * @param array $elements
   *   The elements to render.
   *
   * @return string
   *   The rendered HTML string.
   *
   * @codeCoverageIgnore
   */
  protected static function drupalRender(array &$elements) {
    return RenderCache::drupalRender($elements);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RenderCachePlaceholder::drupalRender	protected static	function	Overrides drupal_render().	1
RenderCachePlaceholder::generatePlaceholder	protected static	function	Generates a render cache placeholder.	1
RenderCachePlaceholder::getPlaceholder	public static	function	Gets a #post_render_cache placeholder for a given function. Overrides RenderCachePlaceholderInterface::getPlaceholder
RenderCachePlaceholder::loadPlaceholderFunctionArgs	public static	function	Loads the %load arguments within $context['args']. Overrides RenderCachePlaceholderInterface::loadPlaceholderFunctionArgs
RenderCachePlaceholder::postRenderCacheCallback	public static	function	Generic #post_render_cache callback for getPlaceholder(). Overrides RenderCachePlaceholderInterface::postRenderCacheCallback
RenderCachePlaceholder::postRenderCacheMultiCallback	public static	function	Generic #post_render_cache callback for getPlaceholder() with multi=TRUE. Overrides RenderCachePlaceholderInterface::postRenderCacheMultiCallback