wieni/wmpathauto

Dynamic path aliases, pathauto patterns & automatic updating of aliases

3.0.2 2023-12-18 05:35 UTC

Requires

• php: >=7.1.0
• drupal/core: ^9.4 || ^10.0
• drupal/pathauto: ^1.6

Requires (Dev)

• ergebnis/composer-normalize: ^2.0
• wieni/wmcodestyle: ^1.3

MIT

• Wieni

README

Dynamic path aliases, pathauto patterns & automatic updating of aliases

Why?

• Create dynamic path aliases and pathauto patterns, for the cases where tokens are too limited
• Automatically update an entity alias when other entities that were used to build this alias are updated

Installation

This package requires PHP 7.1 and Drupal 8 or higher. It can be installed using Composer:

 composer require wieni/wmpathauto

How does it work?

Dynamic path aliases

Sometimes when defining pathauto patterns, you'll notice the token system is just too limited. This module supports building patterns and aliases in code using plugins with annotations, respectively @AliasBuilder and @PatternBuilder.

Dependencies

When updating an entity with a path alias, all entities, configs and other path aliases that were used to build that alias are stored in the database. In the future, when one of those path aliases, entities or configs are updated, the path alias that depends on them will be automatically regenerated.

There are multiple ways to define dependencies:

Automatic dependencies with tokens

When your pathauto pattern uses supported tokens, dependencies will be automatically added based on those tokens. For example, if your pattern contains the [site:name] token, the aliases using this pattern will be regenerated when the site name is changed.

Support for more token types can be added by creating plugins with the @PatternTokenDependencyProvider annotation, defining the token type in the type parameter and implementing the PatternTokenDependencyProviderInterface interface.

Manual dependencies using plugins

Dependencies can also be added manually by creating plugins with the @EntityAliasDependencyProvider annotation, implementing the EntityAliasDependencyProviderInterface interface. Plugins with AliasBuilder or PatternBuilder annotations implementing the same interface are also considered.

Changelog

All notable changes to this project will be documented in the CHANGELOG file.

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

License

Distributed under the MIT License. See the LICENSE file for more information.