1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Render
  7. \
  8. RenderCacheInterface

RenderCacheInterface

interface RenderCacheInterface (View source)

internal  
 

Defines an interface for caching rendered render arrays.

Methods

array
getCacheableRenderArray(array $elements)

Gets a cacheable render array for a render array and its rendered output.

array|false
get(array $elements)

Gets the cached, pre-rendered element of a renderable element from cache.

bool|null
set(array $elements, array $pre_bubbling_elements)

Caches the rendered output of a renderable array.

Details

at line 33
array getCacheableRenderArray(array $elements)

Gets a cacheable render array for a render array and its rendered output.

Given a render array and its rendered output (HTML string), return an array data structure that allows the render array and its associated metadata to be cached reliably (and is serialization-safe).

If Drupal needs additional rendering metadata to be cached at some point, consumers of this method will continue to work. Those who only cache certain parts of a render array will cease to work.

Parameters

array $elements

A render array, on which \Drupal\Core\Render\RendererInterface::render() has already been invoked.

Return Value

array

An array representing the cacheable data for this render array.

at line 48
array|false get(array $elements)

Gets the cached, pre-rendered element of a renderable element from cache.

Parameters

array $elements

A renderable array.

Return Value

array|false

A renderable array, with the original element and all its children pre- rendered, or FALSE if no cached copy of the element is available.

See also

RendererInterface::render
\Drupal\Core\Render\::set()

at line 71
bool|null set(array $elements, array $pre_bubbling_elements)

Caches the rendered output of a renderable array.

May be called by an implementation of \Drupal\Core\Render\RendererInterface while rendering, if the #cache property is set.

Parameters

array $elements

A renderable array.
array $pre_bubbling_elements

A renderable array corresponding to the state (in particular, the cacheability metadata) of $elements prior to the beginning of its rendering process, and therefore before any bubbling of child information has taken place. Only the #cache property is used by this function, so the caller may omit all other properties and children from this array.

Return Value

bool|null

Returns FALSE if no cache item could be created, NULL otherwise.

See also

\Drupal\Core\Render\::get()