interface CachedDiscoveryInterface in Drupal 9

Interface for discovery components holding a cache of plugin definitions.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface
  • interface \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface

6 files declare their use of CachedDiscoveryInterface

Block.php in core/modules/views/src/Plugin/views/display/Block.php

CachedDiscoveryClearer.php in core/lib/Drupal/Core/Plugin/CachedDiscoveryClearer.php

CachedDiscoveryClearerInterface.php in core/lib/Drupal/Core/Plugin/CachedDiscoveryClearerInterface.php

DefaultPluginManager.php in core/lib/Drupal/Core/Plugin/DefaultPluginManager.php

EntityTypeManagerInterface.php in core/lib/Drupal/Core/Entity/EntityTypeManagerInterface.php

... See full list

File

core/lib/Drupal/Component/Plugin/Discovery/CachedDiscoveryInterface.php, line 8

Namespace

Drupal\Component\Plugin\Discovery

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

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