You are here

interface CachedDiscoveryInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Component/Plugin/Discovery/CachedDiscoveryInterface.php \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface

Interface for discovery components holding a cache of plugin definitions.

Hierarchy

Expanded class hierarchy of CachedDiscoveryInterface

All classes that implement CachedDiscoveryInterface

5 files declare their use of CachedDiscoveryInterface
CachedDiscoveryClearer.php in core/lib/Drupal/Core/Plugin/CachedDiscoveryClearer.php
Contains \Drupal\Core\Plugin\CachedDiscoveryClearer.
CachedDiscoveryClearerInterface.php in core/lib/Drupal/Core/Plugin/CachedDiscoveryClearerInterface.php
Contains \Drupal\Core\Plugin\CachedDiscoveryClearerInterface.
DefaultPluginManager.php in core/lib/Drupal/Core/Plugin/DefaultPluginManager.php
Contains \Drupal\Core\Plugin\DefaultPluginManager.
EntityTypeManagerInterface.php in core/lib/Drupal/Core/Entity/EntityTypeManagerInterface.php
Contains \Drupal\Core\Entity\EntityTypeManagerInterface.
TypedDataManagerInterface.php in core/lib/Drupal/Core/TypedData/TypedDataManagerInterface.php
Contains \Drupal\Core\TypedData\TypedDataManagerInterface.

File

core/lib/Drupal/Component/Plugin/Discovery/CachedDiscoveryInterface.php, line 13
Contains \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface.

Namespace

Drupal\Component\Plugin\Discovery
View source
interface CachedDiscoveryInterface extends DiscoveryInterface {

  /**
   * Clears static and persistent plugin definition caches.
   *
   * Don't resort to calling \Drupal::cache()->delete() and friends to make
   * Drupal detect new or updated plugin definitions. Always use this method on
   * the appropriate plugin type's plugin manager!
   */
  public function clearCachedDefinitions();

  /**
   * Disable the use of caches.
   *
   * Can be used to ensure that uncached plugin definitions are returned,
   * without invalidating all cached information.
   *
   * This will also remove all local/static caches.
   *
   * @param bool $use_caches
   *   FALSE to not use any caches.
   */
  public function useCaches($use_caches = FALSE);

}

Members

Namesort descending Modifiers Type Description Overrides
CachedDiscoveryInterface::clearCachedDefinitions public function Clears static and persistent plugin definition caches. 2
CachedDiscoveryInterface::useCaches public function Disable the use of caches. 2
DiscoveryInterface::getDefinition public function Gets a specific plugin definition. 3
DiscoveryInterface::getDefinitions public function Gets the definition of all plugins for this type. 2
DiscoveryInterface::hasDefinition public function Indicates if a specific plugin definition exists. 2