interface AliasManagerInterface
Same name in other branches
- 9 core/modules/path_alias/src/AliasManagerInterface.php \Drupal\path_alias\AliasManagerInterface
- 8.9.x core/modules/path_alias/src/AliasManagerInterface.php \Drupal\path_alias\AliasManagerInterface
- 8.9.x core/lib/Drupal/Core/Path/AliasManagerInterface.php \Drupal\Core\Path\AliasManagerInterface
- 10 core/modules/path_alias/src/AliasManagerInterface.php \Drupal\path_alias\AliasManagerInterface
Find an alias for a path and vice versa.
Hierarchy
- interface \Drupal\path_alias\AliasManagerInterface
Expanded class hierarchy of AliasManagerInterface
All classes that implement AliasManagerInterface
See also
\Drupal\path_alias\AliasStorageInterface
10 files declare their use of AliasManagerInterface
- AliasPathProcessor.php in core/
modules/ path_alias/ src/ PathProcessor/ AliasPathProcessor.php - MockAliasManager.php in core/
modules/ system/ src/ Tests/ Routing/ MockAliasManager.php - PathAliasListBuilder.php in core/
modules/ path/ src/ PathAliasListBuilder.php - PathAliasSubscriber.php in core/
modules/ path_alias/ src/ EventSubscriber/ PathAliasSubscriber.php - PathHooksTest.php in core/
modules/ path_alias/ tests/ src/ Kernel/ PathHooksTest.php
File
-
core/
modules/ path_alias/ src/ AliasManagerInterface.php, line 10
Namespace
Drupal\path_aliasView source
interface AliasManagerInterface {
/**
* Given the alias, return the path it represents.
*
* @param string $alias
* An alias.
* @param string $langcode
* An optional language code to look up the path in.
*
* @return string
* The path represented by alias, or the alias if no path was found.
*
* @throws \InvalidArgumentException
* Thrown when the path does not start with a slash.
*/
public function getPathByAlias($alias, $langcode = NULL);
/**
* Given a path, return the alias.
*
* @param string $path
* A path.
* @param string $langcode
* An optional language code to look up the path in.
*
* @return string
* An alias that represents the path, or path if no alias was found.
*
* @throws \InvalidArgumentException
* Thrown when the path does not start with a slash.
*/
public function getAliasByPath($path, $langcode = NULL);
/**
* Clears the static caches in alias manager and rebuilds the prefix list.
*
* @param $source
* Source path of the alias that is being inserted/updated. If omitted, the
* entire lookup static cache will be cleared and the prefix list will be
* rebuilt.
*/
public function cacheClear($source = NULL);
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
AliasManagerInterface::cacheClear | public | function | Clears the static caches in alias manager and rebuilds the prefix list. |
AliasManagerInterface::getAliasByPath | public | function | Given a path, return the alias. |
AliasManagerInterface::getPathByAlias | public | function | Given the alias, return the path it represents. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.