class CachedContainerBuilder in Service Container 7.2

CachedContainerBuilder retrieves the container definition from cache or builds it.

The reason is to skip invoking all the ctools_* functions via the discovery interface, which needs all modules loaded.

This is especially useful to use the ServiceContainer safely within hook_boot() or even earlier.

Hierarchy

• class \Drupal\service_container\DependencyInjection\ContainerBuilder implements ContainerBuilderInterface
  • class \Drupal\service_container\DependencyInjection\CachedContainerBuilder

1 file declares its use of CachedContainerBuilder

ServiceContainer.php in lib/ServiceContainer.php

Contains ServiceContainer

File

src/DependencyInjection/CachedContainerBuilder.php, line 25

Contains \Drupal\service_container\DependencyInjection\CachedContainerBuilder

Namespace

Drupal\service_container\DependencyInjection

class CachedContainerBuilder extends ContainerBuilder {

  /**
   * The Drupal core cache bin.
   *
   * @var \DrupalCacheInterface
   */
  protected $cache;

  /**
   * The cached definition.
   *
   * @var array
   */
  protected $cachedDefinition;

  /**
   * Constructs a ContainerBuilder object.
   *
   * @param PluginManagerInterface $service_provider_manager
   *   The service provider manager that provides the service providers,
   *   which define the services used in the container.
   * @param \DrupalCacheInterface $cache
   *   The cache bin used to store retrieve the container to/from.
   *   To get a cache object use e.g.: $cache = _cache_get_object('cache');
   */
  public function __construct(PluginManagerInterface $service_provider_manager, DrupalCacheInterface $cache) {
    $this->cache = $cache;
    parent::__construct($service_provider_manager);
  }

  /**
   * {@inheritdoc}
   */
  public function getContainerDefinition() {
    $definition = $this
      ->getCache();
    if (!$definition) {
      $definition = parent::getContainerDefinition();
      $this
        ->setCache($definition);
    }
    return $definition;
  }

  /**
   * Determines if the container is cached.
   *
   * @return bool
   *   Returns TRUE if the container definition is cached, FALSE otherwise.
   */
  public function isCached() {
    $definition = $this
      ->getCache();
    return (bool) $definition;
  }

  /**
   * Returns the cache id of the container definition.
   *
   * @return string
   *   The hardcoded cache id or via variable_get() if defined.
   *
   * @codeCoverageIgnore
   */
  protected function getCacheId() {
    return variable_get('service_container_container_cid', 'service_container:container_definition');
  }

  /**
   * Retrieves the cache id of the container definition.
   *
   * @return string
   *   The hardcoded cache id or via variable_get() if defined.
   */
  protected function getCache() {
    if (isset($this->cachedDefinition)) {
      return $this->cachedDefinition;
    }
    $cache = $this->cache
      ->get($this
      ->getCacheId());
    $this->cachedDefinition = FALSE;
    if (!empty($cache->data)) {
      $this->cachedDefinition = $cache->data;
    }
    return $this->cachedDefinition;
  }

  /**
   * Caches the builded container definition.
   *
   * @param array
   *   The container definition array.
   */
  protected function setCache(array $definition) {
    $this->cache
      ->set($this
      ->getCacheId(), $definition);
    $this->cachedDefinition = $definition;
  }

  /**
   * Reset the internal cache.
   *
   * Note: This is just thought for tests.
   */
  public function reset() {
    $this->cachedDefinition = NULL;
    $this->cache
      ->clear($this
      ->getCacheId());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CachedContainerBuilder::$cache	protected	property	The Drupal core cache bin.
CachedContainerBuilder::$cachedDefinition	protected	property	The cached definition.
CachedContainerBuilder::getCache	protected	function	Retrieves the cache id of the container definition.
CachedContainerBuilder::getCacheId	protected	function	Returns the cache id of the container definition.
CachedContainerBuilder::getContainerDefinition	public	function	Returns the fully build container definition. Overrides ContainerBuilder::getContainerDefinition
CachedContainerBuilder::isCached	public	function	Determines if the container is cached.
CachedContainerBuilder::reset	public	function	Reset the internal cache.
CachedContainerBuilder::setCache	protected	function	Caches the builded container definition.
CachedContainerBuilder::__construct	public	function	Constructs a ContainerBuilder object. Overrides ContainerBuilder::__construct
ContainerBuilder::$containerClass	protected	property	The container class to instantiate.
ContainerBuilder::$serviceProviderManager	protected	property	The plugin manager that provides the service definition providers.
ContainerBuilder::compile	public	function	Compiles the container builder to a new container. Overrides ContainerBuilderInterface::compile
ContainerBuilder::moduleAlter	protected	function	Provides class based version of drupal_alter() to allow testing.