class AliasWhitelist
Extends CacheCollector to build the path alias whitelist over time.
Hierarchy
- class \Drupal\Core\Cache\CacheCollector implements \Drupal\Core\Cache\CacheCollectorInterface, \Drupal\Core\DestructableInterface
- class \Drupal\path_alias\AliasWhitelist implements \Drupal\path_alias\AliasWhitelistInterface extends \Drupal\Core\Cache\CacheCollector
 
 
Expanded class hierarchy of AliasWhitelist
1 file declares its use of AliasWhitelist
- AliasTest.php in core/
modules/ path_alias/ tests/ src/ Kernel/ AliasTest.php  
1 string reference to 'AliasWhitelist'
- path_alias.services.yml in core/
modules/ path_alias/ path_alias.services.yml  - core/modules/path_alias/path_alias.services.yml
 
1 service uses AliasWhitelist
- path_alias.whitelist in core/
modules/ path_alias/ path_alias.services.yml  - Drupal\path_alias\AliasWhitelist
 
File
- 
              core/
modules/ path_alias/ src/ AliasWhitelist.php, line 13  
Namespace
Drupal\path_aliasView source
class AliasWhitelist extends CacheCollector implements AliasWhitelistInterface {
  
  /**
   * The Key/Value Store to use for state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;
  
  /**
   * The path alias repository.
   *
   * @var \Drupal\path_alias\AliasRepositoryInterface
   */
  protected $pathAliasRepository;
  
  /**
   * Constructs an AliasWhitelist object.
   *
   * @param string $cid
   *   The cache id to use.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend.
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock backend.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state keyvalue store.
   * @param \Drupal\path_alias\AliasRepositoryInterface $alias_repository
   *   The path alias repository.
   */
  public function __construct($cid, CacheBackendInterface $cache, LockBackendInterface $lock, StateInterface $state, AliasRepositoryInterface $alias_repository) {
    parent::__construct($cid, $cache, $lock);
    $this->state = $state;
    $this->pathAliasRepository = $alias_repository;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function lazyLoadCache() {
    parent::lazyLoadCache();
    // On a cold start $this->storage will be empty and the whitelist will
    // need to be rebuilt from scratch. The whitelist is initialized from the
    // list of all valid path roots stored in the 'router.path_roots' state,
    // with values initialized to NULL. During the request, each path requested
    // that matches one of these keys will be looked up and the array value set
    // to either TRUE or FALSE. This ensures that paths which do not exist in
    // the router are not looked up, and that paths that do exist in the router
    // are only looked up once.
    if (empty($this->storage)) {
      $this->loadMenuPathRoots();
    }
  }
  
  /**
   * Loads menu path roots to prepopulate cache.
   */
  protected function loadMenuPathRoots() {
    if ($roots = $this->state
      ->get('router.path_roots')) {
      foreach ($roots as $root) {
        $this->storage[$root] = NULL;
        $this->persist($root);
      }
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function get($offset) {
    $this->lazyLoadCache();
    // This may be called with paths that are not represented by menu router
    // items such as paths that will be rewritten by hook_url_outbound_alter().
    // Therefore internally TRUE is used to indicate whitelisted paths. FALSE is
    // used to indicate paths that have already been checked but are not
    // whitelisted, and NULL indicates paths that have not been checked yet.
    if (isset($this->storage[$offset])) {
      if ($this->storage[$offset]) {
        return TRUE;
      }
    }
    elseif (array_key_exists($offset, $this->storage)) {
      return $this->resolveCacheMiss($offset);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function resolveCacheMiss($root) {
    $exists = $this->pathAliasRepository
      ->pathHasMatchingAlias('/' . $root);
    $this->storage[$root] = $exists;
    $this->persist($root);
    if ($exists) {
      return TRUE;
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function clear() {
    parent::clear();
    $this->loadMenuPathRoots();
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| AliasWhitelist::$pathAliasRepository | protected | property | The path alias repository. | ||
| AliasWhitelist::$state | protected | property | The Key/Value Store to use for state. | ||
| AliasWhitelist::clear | public | function | Clears the collected cache entry. | Overrides CacheCollector::clear | |
| AliasWhitelist::get | public | function | Gets value from the cache. | Overrides CacheCollector::get | |
| AliasWhitelist::lazyLoadCache | protected | function | Loads the cache if not already done. | Overrides CacheCollector::lazyLoadCache | |
| AliasWhitelist::loadMenuPathRoots | protected | function | Loads menu path roots to prepopulate cache. | ||
| AliasWhitelist::resolveCacheMiss | public | function | Resolves a cache miss. | Overrides CacheCollector::resolveCacheMiss | |
| AliasWhitelist::__construct | public | function | Constructs an AliasWhitelist object. | Overrides CacheCollector::__construct | |
| CacheCollector::$cache | protected | property | The cache backend that should be used. | 1 | |
| CacheCollector::$cacheCreated | protected | property | Stores the cache creation time. | ||
| CacheCollector::$cacheInvalidated | protected | property | Flag that indicates of the cache has been invalidated. | ||
| CacheCollector::$cacheLoaded | protected | property | Indicates if the collected cache was already loaded. | ||
| CacheCollector::$cid | protected | property | The cache id that is used for the cache entry. | ||
| CacheCollector::$keysToPersist | protected | property | An array of keys to add to the cache on service termination. | ||
| CacheCollector::$keysToRemove | protected | property | An array of keys to remove from the cache on service termination. | ||
| CacheCollector::$lock | protected | property | The lock backend that should be used. | 1 | |
| CacheCollector::$storage | protected | property | Storage for the data itself. | ||
| CacheCollector::$tags | protected | property | A list of tags that are used for the cache entry. | ||
| CacheCollector::delete | public | function | Deletes the element. | Overrides CacheCollectorInterface::delete | 1 | 
| CacheCollector::destruct | public | function | Performs destruct operations. | Overrides DestructableInterface::destruct | |
| CacheCollector::getCid | protected | function | Gets the cache ID. | 3 | |
| CacheCollector::has | public | function | Returns whether data exists for this key. | Overrides CacheCollectorInterface::has | 1 | 
| CacheCollector::invalidateCache | protected | function | Invalidate the cache. | 1 | |
| CacheCollector::normalizeLockName | protected | function | Normalizes a cache ID in order to comply with database limitations. | 1 | |
| CacheCollector::persist | protected | function | Flags an offset value to be written to the persistent cache. | ||
| CacheCollector::reset | public | function | Resets the local cache. | Overrides CacheCollectorInterface::reset | 1 | 
| CacheCollector::set | public | function | Implements \Drupal\Core\Cache\CacheCollectorInterface::set(). | Overrides CacheCollectorInterface::set | 2 | 
| CacheCollector::updateCache | protected | function | Writes a value to the persistent cache immediately. | 2 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.