Download the PHP package mrmilu/alias_subpaths without Composer

Alias Subpaths

Drupal module to allow route aliases to recieve additional URL arguments. This module defines a new Drupal plugin system to allow developers which routes can recieve arguments.

Arguments are stored into a Drupal service alias_subpaths.context_manager. This service has 2 arrays (called bags) that stores raw arguments and the processed arguments, and it is available to use it anywhere.

Installation

To install this module as mrmilu module inside modules/mrmilu folder following composer commands should be executed:

• Install packages to avoid that the module will be installed in vendor folder.
• Before installer-paths section in composer.json file, add this section:
• Tell composer.json project file where the module repository is located and this section will be added automatically to repositories section in composer file.
• Install as other contrib modules

Usage

There is an example into alias_subpath_node submodule that enable argument processor for node routes:

To create a new one we only have to create a plugin like this with the route_name that we want to enable, and implement getId() function to identify each route into your ArgumentResolverHandler.

ArgumentResolverHandler is a class that defines for each route id what argument types are allowed. By default, this module provides an argument resolver handler based on settings . php variables, but it can be changed for a custom one overriding this settings . php variable:

Ensure that your custom class implements ArgumentResolverHandlerInterface.

SettingsArgumentResolver

To set up what argument types are available for each route you have to override alias_subpaths__allowed_arguments_types variable in settings . php. This variable is an array like this:

If we use alias_subpaths_node module, route ids are segmented by bundle like this: entity:node:{bundle}.

Then you have to set up a new array variable called alias_subpaths__argument_resolver_class in settings . php to map each argument type with a class to resolve it which has to implement ArgumentResolverInterface:

If there is not defined an argument resolver, module provides one by default (DefaultArgumentResolver) that does nothing with received value.

Example

We have a content type called Filtered Page (filtered_page) and we want to enable alias subpaths for it. We want to be able to recieve nodes of type page or article, or taxonomy terms of vocabulary tags.

Also, we want to enable alias subpaths for taxonomy terms of vocabulary tags to process arguments of type node page.

To resolve arguments we want to use this fields for each argument type:

• Node of type Page: a field called field_url_key
• Node of type Article: node title
• Taxonomy term of tags vocabulary: name of the term

Once we have installed alias_subpaths_node and alias_subpaths_taxonomy_term modules, we have to fill this configuration on settings . php:

Then, you have to implement the argument resolvers in your proyect with your custom logic. For this example all of them are into a custom module called my_project and are like this:

• Node of type Page: search by field called field_url_key

• Node of type Article: search by node title

• Taxonomy term of vocabulary tags: search by taxonomy name

IMPORTANT: Argument Resolvers should return NULL or FALSE if there is any error during argument resolve function like the entity doesn't exist. It is needed to show an HTTP 404 error

Usage of arguments

To illustrate this there is a submodule called alias_subpaths_examples that uses arguments into hook_preprocess_node: