AliasManagerInterface.php
Same filename in this branch
Same filename in other branches
Namespace
Drupal\Core\PathFile
-
core/
lib/ Drupal/ Core/ Path/ AliasManagerInterface.php
View source
<?php
namespace Drupal\Core\Path;
/**
* Find an alias for a path and vice versa.
*
* @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0.
* Use \Drupal\path_alias\AliasManagerInterface.
*
* @see https://www.drupal.org/node/3092086
*/
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);
/**
* Clear internal caches in alias manager.
*
* @param $source
* Source path of the alias that is being inserted/updated. Can be omitted
* if entire cache needs to be flushed.
*/
public function cacheClear($source = NULL);
}
Interfaces
Title | Deprecated | Summary |
---|---|---|
AliasManagerInterface | in drupal:8.8.0 and is removed from drupal:9.0.0. Use \Drupal\path_alias\AliasManagerInterface. |
Find an alias for a path and vice versa. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.