class MockAliasManager in Drupal 9

An easily configurable mock alias manager.

Hierarchy

• class \Drupal\system\Tests\Routing\MockAliasManager implements AliasManagerInterface

1 file declares its use of MockAliasManager

RequestPathTest.php in core/tests/Drupal/KernelTests/Core/Plugin/Condition/RequestPathTest.php

File

core/modules/system/src/Tests/Routing/MockAliasManager.php, line 10

Namespace

Drupal\system\Tests\Routing

class MockAliasManager implements AliasManagerInterface {

  /**
   * Array of mocked aliases. Keys are system paths, followed by language.
   *
   * @var array
   */
  protected $aliases = [];

  /**
   * Array of mocked aliases. Keys are aliases, followed by language.
   *
   * @var array
   */
  protected $systemPaths = [];

  /**
   * An index of aliases that have been requested.
   *
   * @var array
   */
  protected $lookedUp = [];

  /**
   * The language to assume a path alias is for if not specified.
   *
   * @var string
   */
  public $defaultLanguage = 'en';

  /**
   * Adds an alias to the in-memory alias table for this object.
   *
   * @param string $path
   *   The system path of the alias.
   * @param string $alias
   *   The alias of the system path.
   * @param string $path_language
   *   The language of this alias.
   */
  public function addAlias($path, $alias, $path_language = NULL) {
    $language = $path_language ?: $this->defaultLanguage;
    if ($path[0] !== '/') {
      throw new \InvalidArgumentException('The path needs to start with a slash.');
    }
    if ($alias[0] !== '/') {
      throw new \InvalidArgumentException('The alias needs to start with a slash.');
    }
    $this->aliases[$path][$language] = $alias;
    $this->systemPaths[$alias][$language] = $path;
  }

  /**
   * {@inheritdoc}
   */
  public function getPathByAlias($alias, $langcode = NULL) {
    $langcode = $langcode ?: $this->defaultLanguage;
    return $this->systemPaths[$alias][$langcode];
  }

  /**
   * {@inheritdoc}
   * @param $path
   * @param null $langcode
   *
   * @return
   */
  public function getAliasByPath($path, $langcode = NULL) {
    if ($path[0] !== '/') {
      throw new \InvalidArgumentException(sprintf('Source path %s has to start with a slash.', $path));
    }
    $langcode = $langcode ?: $this->defaultLanguage;
    $this->lookedUp[$path] = 1;
    return $this->aliases[$path][$langcode];
  }

  /**
   * {@inheritdoc}
   */
  public function cacheClear($source = NULL) {

    // Not needed.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MockAliasManager::$aliases	protected	property	Array of mocked aliases. Keys are system paths, followed by language.
MockAliasManager::$defaultLanguage	public	property	The language to assume a path alias is for if not specified.
MockAliasManager::$lookedUp	protected	property	An index of aliases that have been requested.
MockAliasManager::$systemPaths	protected	property	Array of mocked aliases. Keys are aliases, followed by language.
MockAliasManager::addAlias	public	function	Adds an alias to the in-memory alias table for this object.
MockAliasManager::cacheClear	public	function	Clears the static caches in alias manager and rebuilds the whitelist. Overrides AliasManagerInterface::cacheClear
MockAliasManager::getAliasByPath	public	function	Overrides AliasManagerInterface::getAliasByPath
MockAliasManager::getPathByAlias	public	function	Given the alias, return the path it represents. Overrides AliasManagerInterface::getPathByAlias