Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Path/AliasManagerInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Path/AliasManagerInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,53 @@ +<?php + +namespace Drupal\Core\Path; + +/** + * Find an alias for a path and vice versa. + * + * @see \Drupal\Core\Path\AliasStorageInterface + */ +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); + +}