render_cache.api.php in Render cache 7.2

File

render_cache.api.php

<?php

/**
 * Hook to alter the entity hash.
 *
 * @param array $hash
 * @param object $entity
 * @param array $cache_info
 * @param array $context
 */
function hook_render_cache_entity_hash_alter(&$hash, $entity, $cache_info, $context) {

  // @todo Add example implementation.
}

/**
 * Hook to alter the cid.
 *
 * @param array $cid_parts
 * @param array $block
 * @param array $cache_info
 * @param array $context
 */
function hook_render_cache_block_cid_alter(&$cid_parts, $block, $cache_info, $context) {

  // @todo Add example implementation.
}

/**
 * @param array $cache_info
 * @param array $block
 * @param array $context
 */
function hook_render_cache_block_cache_info_alter(&$cache_info, $block, $context) {

  // @todo Add example implementation.
}

/**
 * @param array $cache_info_default
 * @param array $default_alter_context
 */
function hook_render_cache_block_default_cache_info_alter(&$cache_info_default, $default_alter_context) {

  // @todo Add example implementation.
}

/**
 * Allows to alter the container definition.
 *
 * @param array $container_definition
 *   An associative array with the following keys:
 *     - parameters: Simple key-value store of container parameters.
 *     - services: Services like defined in services.yml
 *     - tags: Associative array keyed by tag names with
 *             array('service_name' => $tag_args) as values.
 *
 * @see ServiceProviderInterface::getContainerDefinition()
 * @see ServiceProviderInterface::alterContainerDefinition()
 */
function hook_render_cache_container_build_alter(&$container_definition) {
  $tagged_services = array();
  foreach ($container_definition['tags']['some-tag'] as $service => $tags) {
    $tagged_services[] = $service;
  }
  $container_definition['parameters']['some_service_tagged_services'] = implode(',', $tagged_services);
}

Functions

Name	Description
hook_render_cache_block_cache_info_alter
hook_render_cache_block_cid_alter	Hook to alter the cid.
hook_render_cache_block_default_cache_info_alter
hook_render_cache_container_build_alter	Allows to alter the container definition.
hook_render_cache_entity_hash_alter	Hook to alter the entity hash.