Adds the ability to use special characters in URLs.
5 |
6 | 
7 | 
9 | 
10 | Adds the ability to use special characters in URLs.
5 |
6 |
7 |
9 |
10 | 
62 |
63 | ### Mark Shust
64 |
65 | 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.
66 |
67 | - 🖥️ See my Magento lessons & courses
68 | - 📖 Read my technical articles
69 | - 🎥 Watch my YouTube videos
70 | - 🔗 Connect on LinkedIn
71 | - 🐦 Follow me on X
72 | - 💌 Contact me
73 |
74 | ## License
75 |
76 | [MIT](https://opensource.org/licenses/MIT)
77 |
--------------------------------------------------------------------------------
/Router/SpecialRouter.php:
--------------------------------------------------------------------------------
1 | '-',
15 | 'name' => 'dash',
16 | ],
17 | [
18 | 'symbol' => '.',
19 | 'name' => 'period',
20 | ],
21 | [
22 | 'symbol' => '~',
23 | 'name' => 'tilda',
24 | ],
25 | [
26 | 'symbol' => '_',
27 | 'name' => 'underscore',
28 | ],
29 | ];
30 |
31 | /**
32 | * Match a route to this router.
33 | *
34 | * If there is a match, replace the path with the new path.
35 | * Ex. /front-name/foo-bar/baz_qux -> /front-name/foodashbar/bazunderscorequx
36 | *
37 | * @param RequestInterface $request
38 | * @return void
39 | */
40 | public function match(
41 | RequestInterface $request,
42 | ): void {
43 | $identifier = trim($request->getPathInfo(), '/');
44 | $pathParts = explode('/', $identifier);
45 | $moduleName = array_shift($pathParts);
46 | $pathInfo = implode('/', $pathParts);
47 |
48 | if ($this->isMatch($pathInfo)) {
49 | $newPathInfo = sprintf('/%s/%s', $moduleName, $this->replacePath($pathInfo));
50 | $request->setPathInfo($newPathInfo);
51 | }
52 |
53 | // Return void to allow the next router to match (void vs. null for PHP <=8.1 compatibility).
54 | }
55 |
56 | /**
57 | * Does the path contain a character in the symbol to name map?
58 | *
59 | * @param string $pathInfo
60 | * @return bool
61 | */
62 | private function isMatch(
63 | string $pathInfo,
64 | ): bool {
65 | foreach (self::SYMBOL_TO_NAME_MAP as $item) {
66 | if (str_contains($pathInfo, $item['symbol'])) {
67 | return true;
68 | }
69 | }
70 |
71 | return false;
72 | }
73 |
74 | /**
75 | * Replace special characters in the path with their names.
76 | *
77 | * @param string $pathInfo
78 | * @return string
79 | */
80 | private function replacePath(
81 | string $pathInfo,
82 | ): string {
83 | foreach (self::SYMBOL_TO_NAME_MAP as $item) {
84 | $pathInfo = str_replace($item['symbol'], $item['name'], $pathInfo);
85 | }
86 |
87 | return $pathInfo;
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "markshust/magento2-module-specialrouter",
3 | "description": "The SpecialRouter module adds the ability to use special characters in URLs.",
4 | "require": {
5 | "php": "^8",
6 | "magento/framework": ">=103"
7 | },
8 | "require-dev": {
9 | "roave/security-advisories": "dev-latest"
10 | },
11 | "type": "magento2-module",
12 | "version": "2.0.0",
13 | "license": [
14 | "MIT"
15 | ],
16 | "autoload": {
17 | "files": [
18 | "registration.php"
19 | ],
20 | "psr-4": {
21 | "MarkShust\\SpecialRouter\\": ""
22 | }
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/etc/frontend/di.xml:
--------------------------------------------------------------------------------
1 |
2 |