1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Path
  7. \
  8. AliasRepositoryInterface

AliasRepositoryInterface deprecated

interface AliasRepositoryInterface (View source)

deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. Use \Drupal\path_alias\AliasRepositoryInterface.

Provides an interface for path alias lookup operations.

Methods

string[]
preloadPathAlias(array $preloaded, string $langcode)

Pre-loads path alias information for a given list of system paths.

array|null
lookupBySystemPath(string $path, string $langcode)

Searches a path alias for a given Drupal system path.

array|null
lookupByAlias(string $alias, string $langcode)

Searches a path alias for a given alias.

bool
pathHasMatchingAlias(string $initial_substring)

Check if any alias exists starting with $initial_substring.

Details

at line 27
string[] preloadPathAlias(array $preloaded, string $langcode)

Pre-loads path alias information for a given list of system paths.

Parameters

array $preloaded

System paths that need preloading of aliases.
string $langcode

Language code to search the path with. If there's no path defined for that language it will search paths without language.

Return Value

string[]

System paths (keys) to alias (values) mapping.

at line 45
array|null lookupBySystemPath(string $path, string $langcode)

Searches a path alias for a given Drupal system path.

The default implementation performs case-insensitive matching on the 'path' and 'alias' strings.

Parameters

string $path

The system path to investigate for corresponding path aliases.
string $langcode

Language code to search the path with. If there's no path defined for that language it will search paths without language.

Return Value

array|null

An array containing the 'id', 'path', 'alias' and 'langcode' properties of a path alias, or NULL if none was found.

at line 63
array|null lookupByAlias(string $alias, string $langcode)

Searches a path alias for a given alias.

The default implementation performs case-insensitive matching on the 'path' and 'alias' strings.

Parameters

string $alias

The alias to investigate for corresponding system paths.
string $langcode

Language code to search the alias with. If there's no alias defined for that language it will search aliases without language.

Return Value

array|null

An array containing the 'id', 'path', 'alias' and 'langcode' properties of a path alias, or NULL if none was found.

at line 74
bool pathHasMatchingAlias(string $initial_substring)

Check if any alias exists starting with $initial_substring.

Parameters

string $initial_substring

Initial system path substring to test against.

Return Value

bool

TRUE if any alias exists, FALSE otherwise.