1. interface
  2. Drupal
  3. \
  4. path_alias
  5. \
  6. AliasRepositoryInterface

AliasRepositoryInterface

interface AliasRepositoryInterface (View source)

Provides an interface for path alias lookup operations.

The path alias repository service is only used internally in order to optimize alias lookup queries needed in the critical path of each request. However, it is not marked as an internal service because alternative storage backends still need to override it if they provide a different storage class for the PathAlias entity type.

Whenever you need to determine whether an alias exists for a system path, or whether a system path has an alias, the 'path_alias.manager' service should be used instead.

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 32
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 50
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 68
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 79
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.