integer-net / magento2-rewritemap
integer-net/magento2-rewritemap
Generate RewriteMap files for Apache from Magento URL rewrites
IntegerNet_RewriteMap Magento Module
Generate RewriteMap files for Apache from custom Magento URL rewrites (redirects). This can be useful to re-use the rewrites in a different frontend.
For example, to use the redirects in Vue Storefront, a reverse proxy that uses the generated rewrite maps can be configured.
Installation
-
Install it into your Magento 2 project with composer:
composer require integer-net/magento2-rewritemap -
Enable module
bin/magento setup:upgrade
Configuration
In your store configuration navigate to Catalog > SEO:
- Enable Rewrite Maps Generation: set to "yes" to enable (Default: no)
- Rewrite Maps Generation Cron Schedule: configure, when rewrite maps are regenerated (Default: every hour)
Usage
Rewrite maps are stored in var/rewrite_maps as one text file per store and redirect type (301, 302).
See http://httpd.apache.org/docs/current/rewrite/rewritemap.html for details how to use those files.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Testing
Unit Tests
vendor/bin/phpunit tests/unit
Magento Integration Tests
-
Configure test database in
dev/tests/integration/etc/install-config-mysql.php. Read more in the Magento docs. -
Copy
tests/integration/phpunit.xml.distfrom the package todev/tests/integration/phpunit.xmlin your Magento installation. -
In that directory, run
../../../vendor/bin/phpunit
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
[Unreleased]
Added
- Cronjob that generates rewrite map files for each store and redirect type
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.0.0-alpha | alpha | Pass | Not yet tested Details | 2020-09-05 15:41:18 |
Requires 4
| Package | Constraint |
|---|---|
| php | ~7.2||~7.3||~7.4 |
| magento/framework | ^102.0.0||^103.0.0 |
| magento/module-store | ^100.0.2||^101.0 |
| magento/module-url-rewrite | ^100.0.2||^101.0.0||^102.0.0 |
Requires-dev 7
| Package | Constraint |
|---|---|
| roave/security-advisories | dev-master |
| phpunit/phpunit | ^6.0|^9.0 |
| pds/skeleton | ^1.0 |
| phpro/grumphp | ^v0.21.0 |
| phpstan/phpstan | ^0.12.0 |
| squizlabs/php_codesniffer | ^3.5 |
| magento/magento-coding-standard | @dev |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | not tested | ||
| 2.4.8 | not tested | not tested | ||
| 2.4.9 | not tested | not tested |
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from integer-net
View vendorMagento 2 Health Check
Create an "is_sale" product attribute and update it automatically from the "price" and "special_price" attributes
N/A
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.