class CacheableMetadataCalculationTest in Drupal 10

Tests plugin that reports when cacheable metadata is being calculated.

Plugin annotation

@ViewsAccess(
  id = "test_cacheable_metadata_access",
  title = @Translation("Cacheable metadata calculation test access plugin"),
  help = @Translation("Provides a test access plugin that reports when cacheable metadata is being calculated.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
      • class \Drupal\views\Plugin\views\access\AccessPluginBase
        • class \Drupal\views_test_cacheable_metadata_calculation\Plugin\views\access\CacheableMetadataCalculationTest implements CacheableDependencyInterface

File

core/modules/views/tests/modules/views_test_cacheable_metadata_calculation/src/Plugin/views/access/CacheableMetadataCalculationTest.php, line 22

Namespace

Drupal\views_test_cacheable_metadata_calculation\Plugin\views\access

class CacheableMetadataCalculationTest extends AccessPluginBase implements CacheableDependencyInterface {

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Constructs a CacheableMetadataCalculationTest access plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, StateInterface $state) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->state = $state;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('state'));
  }

  /**
   * {@inheritdoc}
   */
  public function access(AccountInterface $account) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function alterRouteDefinition(Route $route) {
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $this
      ->cacheableMetadataHasBeenAccessed();
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $this
      ->cacheableMetadataHasBeenAccessed();
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    $this
      ->cacheableMetadataHasBeenAccessed();
    return Cache::PERMANENT;
  }

  /**
   * Sets a flag to inform tests that cacheable metadata has been accessed.
   */
  protected function cacheableMetadataHasBeenAccessed() {
    $this->state
      ->set('views_test_cacheable_metadata_has_been_accessed', TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccessPluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle	3
CacheableMetadataCalculationTest::$state	protected	property	The state service.
CacheableMetadataCalculationTest::access	public	function	Determine if the current user has access or not. Overrides AccessPluginBase::access
CacheableMetadataCalculationTest::alterRouteDefinition	public	function	Allows access plugins to alter the route definition of a view. Overrides AccessPluginBase::alterRouteDefinition
CacheableMetadataCalculationTest::cacheableMetadataHasBeenAccessed	protected	function	Sets a flag to inform tests that cacheable metadata has been accessed.
CacheableMetadataCalculationTest::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
CacheableMetadataCalculationTest::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
CacheableMetadataCalculationTest::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
CacheableMetadataCalculationTest::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
CacheableMetadataCalculationTest::__construct	public	function	Constructs a CacheableMetadataCalculationTest access plugin. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	6
PluginBase::$view	public	property	The top object of a view.
PluginBase::buildOptionsForm	public	function		9
PluginBase::calculateDependencies	public	function		4
PluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here.	10
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function		1
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function
PluginBase::getAvailableGlobalTokens	public	function
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::getProvider	public	function
PluginBase::getRenderer	protected	function	Returns the render API renderer.
PluginBase::globalTokenForm	public	function
PluginBase::globalTokenReplace	public	function
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::init	public	function		2
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function
PluginBase::preRenderAddFieldsetMarkup	public static	function
PluginBase::preRenderFlattenData	public static	function
PluginBase::query	public	function		4
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm	public	function		4
PluginBase::themeFunctions	public	function
PluginBase::trustedCallbacks	public static	function		1
PluginBase::unpackOptions	public	function
PluginBase::usesOptions	public	function		6
PluginBase::validate	public	function		2
PluginBase::validateOptionsForm	public	function		5
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.