class CacheInvalidator in Decoupled Router 8

Invalidates decoupled router cache entries based on path events.

Hierarchy

• class \Drupal\decoupled_router\CacheInvalidator

1 string reference to 'CacheInvalidator'

decoupled_router.services.yml in ./decoupled_router.services.yml

decoupled_router.services.yml

1 service uses CacheInvalidator

decoupled_router.cache_invalidation in ./decoupled_router.services.yml

Drupal\decoupled_router\CacheInvalidator

File

src/CacheInvalidator.php, line 13

Namespace

Drupal\decoupled_router

class CacheInvalidator {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * The invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  private $invalidator;

  /**
   * CacheInvalidator constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manger.
   */
  public function __construct(CacheTagsInvalidatorInterface $invalidator, EntityTypeManagerInterface $entity_type_manager) {
    $this->invalidator = $invalidator;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * Invalidate cached responses associated with the given path.
   *
   * This is called whenever an URL alias is created, updated or deleted and makes
   * sure the relevant Decoupled Router responses are invalidated.
   *
   * @param array $path
   *   The path array.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @see https://www.drupal.org/project/drupal/issues/2480077
   */
  public function invalidateByPath($path) {

    // Derive cache tags by source path.
    $tags = $this
      ->getTagsBySourcePath($path['source']);

    // Path changes may change a cached 403 or 404 response.
    $tags = Cache::mergeTags($tags, [
      '4xx-response',
    ]);
    $this->invalidator
      ->invalidateTags($tags);
  }

  /**
   * Invalidates cache for an entity based on its internal system path.
   *
   * Derives the entity associated with the given path (if any) and collects the
   * cache tags associated with it.
   *
   * @param string $source_path
   *   An internal system path.
   *
   * @return string[]
   *   The merged array of cache tags, if any.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  private function getTagsBySourcePath($source_path) {
    $tags = [];
    try {
      $parameters = Url::fromUri('internal:' . $source_path)
        ->getRouteParameters();
    } catch (\UnexpectedValueException $exception) {
      $parameters = [];
    }
    if (empty($parameters)) {
      return $tags;
    }
    $entity_type_id = key($parameters);
    $entity_id = reset($parameters);
    if (empty($entity_type_id) || empty($entity_id)) {
      return $tags;
    }
    $entity_type = $this->entityTypeManager
      ->getDefinition($entity_type_id, FALSE);
    if (!$entity_type) {
      return $tags;
    }
    $entity = $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->load($entity_id);
    if (!$entity) {
      return $tags;
    }
    $tags = Cache::mergeTags($entity_type
      ->getListCacheTags(), $entity
      ->getCacheTagsToInvalidate());
    return $tags;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheInvalidator::$entityTypeManager	private	property	The entity type manager.
CacheInvalidator::$invalidator	private	property	The invalidator.
CacheInvalidator::getTagsBySourcePath	private	function	Invalidates cache for an entity based on its internal system path.
CacheInvalidator::invalidateByPath	public	function	Invalidate cached responses associated with the given path.
CacheInvalidator::__construct	public	function	CacheInvalidator constructor.