markshust/magento2-module-specialrouter

The SpecialRouter module adds the ability to use special characters in URLs.

Maintainers

Details

github.com/markshust/magento2-module-specialrouter

Source

Issues

Installs: 754

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 3

Forks: 2

Open Issues: 0

Type:magento2-module

2.0.0 2024-04-13 14:38 UTC

Requires

  • php: ^8
  • magento/framework: >=103

Requires (Dev)

MIT d363c6acff3be5b0dfc22fa97dd57add99e850db

This package is auto-updated.

Last update: 2024-07-13 15:24:32 UTC

README

Adds the ability to use special characters in URLs.

Supported Magento Versions Latest Stable Version Composer Downloads Maintained - Yes

Table of contents

Summary

Magento does not provide the ability to set special characters on controller or action names. This module fixes that by providing the ability to use -, ., ~, _ within a URL.

Installation

composer require markshust/magento2-module-specialrouter
bin/magento module:enable MarkShust_SpecialRouter
bin/magento setup:upgrade

Usage

This module is really simple to use. All you need to do is use the appropriate "name" that matches the symbol you'd like to use in the URL.

  • Symbol: -, Name: Dash
  • Symbol: ., Name: Period
  • Symbol: ~, Name: Tilda
  • Symbol: _, Name: Underscore

For example, to respond to a request with a frontName of foo at the following location:

/foo/alpha-beta/charlie-delta

Use a PHP class named:

Controller/AlphaDashBeta/CharlieDashDelta.php

The - in the URL will be translated to dash in the actionPath and actionName, so if we create files using Dash in the controller and action name, they will respond to these requests.

Credits

M.academy

This course is sponsored by M.academy, the simplest way to learn Magento.

M.academy

Mark Shust

My name is Mark Shust and I'm the creator of this repo. I'm a 6X Adobe Commerce Certified Developer and have been involved with Magento since the early days (v0.8!). I create technical education courses full-time for my company, M.academy.

License

MIT