class SearchApiTagCache in Search API 8

Defines a tag-based cache plugin for use with Search API views.

This cache plugin basically sets an unlimited cache life time for the view, but the view will be refreshed when any of its cache tags are invalidated.

Use this for search results views that are fully controlled by a single Drupal instance. A common use case is a website that uses the default database search backend and does not index any external datasources.

Plugin annotation


@ViewsCache(
  id = "search_api_tag",
  title = @Translation("Search API (tag-based)"),
  help = @Translation("Cache results until the associated cache tags are invalidated. Useful for small sites that use the database search backend. <strong>Caution:</strong> Can lead to stale results and might harm performance for complex search pages.")
)

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\cache\CachePluginBase
    class \Drupal\views\Plugin\views\cache\Tag
    class \Drupal\search_api\Plugin\views\cache\SearchApiTagCache uses SearchApiCachePluginTrait

Expanded class hierarchy of SearchApiTagCache

File

src/Plugin/views/cache/SearchApiTagCache.php, line 31

Namespace

Drupal\search_api\Plugin\views\cache

View source

class SearchApiTagCache extends Tag {
  use SearchApiCachePluginTrait;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|null
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var static $cache */
    $cache = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $cache
      ->setEntityTypeManager($container
      ->get('entity_type.manager'));
    return $cache;
  }

  /**
   * Retrieves the entity type manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity type manager.
   */
  public function getEntityTypeManager() {
    return $this->entityTypeManager ?: \Drupal::service('entity_type.manager');
  }

  /**
   * Sets the entity type manager.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The new entity type manager.
   *
   * @return $this
   */
  public function setEntityTypeManager(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $tags = $this->view->storage
      ->getCacheTags();

    // Add the list cache tag of the search index, so that the view will be
    // invalidated whenever the index is updated.
    $tag = 'search_api_list:' . $this
      ->getQuery()
      ->getIndex()
      ->id();
    $tags = Cache::mergeTags([
      $tag,
    ], $tags);

    // Also add the cache tags of the index itself, so that the view will be
    // invalidated if the configuration of the index changes.
    $index_tags = $this
      ->getQuery()
      ->getIndex()
      ->getCacheTagsToInvalidate();
    $tags = Cache::mergeTags($index_tags, $tags);
    return $tags;
  }

  /**
   * {@inheritdoc}
   */
  public function getRowId(ResultRow $row) {
    return $row->search_api_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getRowCacheTags(ResultRow $row) {
    $tags = [];
    foreach ($row->_relationship_objects as $objects) {

      /** @var \Drupal\Core\TypedData\ComplexDataInterface $object */
      foreach ($objects as $object) {
        $entity = $object
          ->getValue();
        if ($entity instanceof EntityInterface) {
          $tags = Cache::mergeTags($tags, $entity
            ->getCacheTags());
        }
      }
    }
    return $tags;
  }

  /**
   * {@inheritdoc}
   */
  public function alterCacheMetadata(CacheableMetadata $cache_metadata) {

    // Allow modules that alter the query to add their cache metadata to the
    // view.
    $query = $this
      ->getQuery()
      ->getSearchApiQuery();
    $query
      ->preExecute();
    $cache_metadata
      ->addCacheableDependency($query);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CachePluginBase::$resultsBin	protected	property	Which cache bin to store query results in.
CachePluginBase::$resultsKey	protected	property	Stores the cache ID used for the results cache.
CachePluginBase::$storage	public	property	Contains all data that should be written/read from cache.
CachePluginBase::cacheFlush	public	function	Clear out cached data for a view.
CachePluginBase::cacheSetMaxAge	protected	function	Determine expiration time in the cache table of the cache type or CACHE_PERMANENT if item shouldn't be removed automatically from cache.	1
CachePluginBase::getCacheMaxAge	public	function	Gets the max age for the current view.
CachePluginBase::getResultsKey	public	function	Returns the resultsKey property.
CachePluginBase::getRowCacheKeys	public	function	Returns the row cache keys.
CachePluginBase::postRender	public	function	Post process any rendered data.
CachePluginBase::prepareViewResult	protected	function	Prepares the view result before putting it into cache.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides ViewsPluginInterface::buildOptionsForm	16
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::defineOptions	protected	function	Information about options for all kinds of purposes will be held here.	18
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
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	Initialize the plugin. Overrides ViewsPluginInterface::init	8
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	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query	public	function	Add anything to the query that we might need to. Overrides ViewsPluginInterface::query	8
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	Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate	6
PluginBase::validateOptionsForm	public	function	Validate the options form. Overrides ViewsPluginInterface::validateOptionsForm	15
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
SearchApiCachePluginTrait::$cacheBackend	protected	property	The cache backend.
SearchApiCachePluginTrait::$cacheContextsManager	protected	property	The cache contexts manager.
SearchApiCachePluginTrait::$queryHelper	protected	property	The query helper.
SearchApiCachePluginTrait::cacheGet	public	function
SearchApiCachePluginTrait::cacheSet	public	function
SearchApiCachePluginTrait::generateResultsKey	public	function
SearchApiCachePluginTrait::getCacheBackend	public	function	Retrieves the cache backend.
SearchApiCachePluginTrait::getCacheContextsManager	public	function	Retrieves the cache contexts manager.
SearchApiCachePluginTrait::getQuery	protected	function	Retrieves the Search API Views query for the current view.
SearchApiCachePluginTrait::getQueryHelper	public	function	Retrieves the query helper.
SearchApiCachePluginTrait::getView	protected	function	Retrieves the view to which this plugin belongs.
SearchApiCachePluginTrait::setCacheBackend	public	function	Sets the cache backend.
SearchApiCachePluginTrait::setCacheContextsManager	public	function	Sets the cache contexts manager.
SearchApiCachePluginTrait::setQueryHelper	public	function	Sets the query helper.
SearchApiTagCache::$entityTypeManager	protected	property	The entity type manager service.
SearchApiTagCache::alterCacheMetadata	public	function	Alters the cache metadata of a display upon saving a view. Overrides CachePluginBase::alterCacheMetadata
SearchApiTagCache::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
SearchApiTagCache::getCacheTags	public	function	Gets an array of cache tags for the current view. Overrides CachePluginBase::getCacheTags
SearchApiTagCache::getEntityTypeManager	public	function	Retrieves the entity type manager.
SearchApiTagCache::getRowCacheTags	public	function	Returns the row cache tags. Overrides CachePluginBase::getRowCacheTags
SearchApiTagCache::getRowId	public	function	Returns a unique identifier for the specified row. Overrides CachePluginBase::getRowId
SearchApiTagCache::setEntityTypeManager	public	function	Sets the entity type manager.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
Tag::cacheExpire	protected	function	Determine the expiration time of the cache type, or NULL if no expire. Overrides CachePluginBase::cacheExpire
Tag::getDefaultCacheMaxAge	protected	function	Returns the default cache max age. Overrides CachePluginBase::getDefaultCacheMaxAge
Tag::summaryTitle	public	function	Return a string to display as the clickable title for the access control. Overrides CachePluginBase::summaryTitle
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.

You are here