terminal42 / contao-url-rewrite
URL Rewrite bundle for Contao Open Source CMS
Fund package maintenance!
terminal42
Other
Installs: 67 682
Dependents: 2
Suggesters: 0
Security: 0
Stars: 15
Watchers: 9
Forks: 4
Open Issues: 1
Type:contao-bundle
Requires
- php: ^7.2 || ^8.0
- bacon/bacon-qr-code: ^2.0
- contao/core-bundle: ^4.13 || ^5.0
- doctrine/dbal: ^2.11 || ^3
- symfony/config: ^5.0 || ^6.0
- symfony/dependency-injection: ^5.0 || ^6.0
- symfony/expression-language: ^5.0 || ^6.0
- symfony/filesystem: ^5.0 || ^6.0
- symfony/http-foundation: ^5.0 || ^6.0
- symfony/http-kernel: ^5.0 || ^6.0
- symfony/routing: ^5.0 || ^6.0
Requires (Dev)
- contao/calendar-bundle: ^4.4
- contao/faq-bundle: ^4.4
- contao/manager-plugin: ^2.0
- contao/news-bundle: ^4.4
- contao/test-case: ^4.0
- symfony-cmf/routing: ^2.1
Conflicts
- contao/manager-plugin: <2.0 || >=3.0
README
The extension provides a new way for Contao to set various URL rewrites. The available config providers are:
- Bundle config provider – the entries are taken from
config.yml
file - Database provider – the entries are taken from backend module
Behind the scenes the rules are added as routes to the internal application router which allows to use all the features provided by the Symfony Routing component.
Installation
Install the bundle via Composer:
composer require terminal42/contao-url-rewrite
Migration of short URLs
Since the extension fritzmg/contao-short-urls has been abandoned, you can migrate short URLs to URL rewrites with the extension bwein-net/contao-migrate-short-urls.
Configuration
Bundle configuration
The bundle configuration is optional. Here you can define the entries and disable the backend management module.
Note: if you want to use the %
character, make sure it is properly escaped by doubling it %%
.
# config/config.yml terminal42_url_rewrite: backend_management: false # Disable backend management of entries (true by default) entries: # Optional entries - request: { path: 'find/{address}' } response: { code: 303, uri: 'https://www.google.com/maps?q={address}' } - request: path: 'news/{news}' requirements: {news: '\d+'} response: code: 301 uri: '{{news_url::{news}|absolute}}' - request: path: 'home.php' hosts: ['localhost'] condition: "context.getMethod() == 'GET' and request.query.has('page')" response: uri: '{{link_url::{page}|absolute}}'
Running under non Contao managed edition
If you are running the Contao Managed Edition then the extension should work out of the box. For all the other systems you have to additionally register the routing configuration in the config files:
# config/routing.yml imports: - { resource: '@Terminal42UrlRewriteBundle/Resources/config/routing.yml' }
Examples
- Find address on Google Maps:
Type: basic
Path restriction: find/{address}
Response code: 303 See Other
Response URI: https://www.google.com/maps?q={address}
---
Result: domain.tld/find/Switzerland → https://www.google.com/maps?q=Switzerland
- Redirect to a specific news entry:
Type: basic
Path restriction: news/{news}
Requirements: [news => \d+]
Response code: 301 Moved Permanently
Response URI: {{news_url::{news}|absolute}}
---
Result: domain.tld/news/123 → domain.tld/news-reader/foobar-123.html
Result: domain.tld/news/foobar → 404 Page Not Found
- Rewrite legacy URLs with query string:
Type: expert
Path restriction: home.php
Request condition: context.getMethod() == 'GET' and request.query.has('page')
Response code: 301 Moved Permanently
Response URI: {{link_url::{page}|absolute}}
---
Result: domain.tld/home.php?page=123 → domain.tld/foobar-123.html
- Rewrite URLs including slashes (without query string) to new domain:
Type: basic
Hosts restriction: [domain.com]
Path restriction: /{wildcard}
Requirements: [wildcard => .*]
Response code: 301 Moved Permanently
Response redirect URL: https://domain.tld/{wildcard}
---
Result: domain.com/blog/test → https://domain.tld/blog/test
Create a custom config provider
In addition to the existing providers you can create your own class that provides the rewrite configurations. The new service must implement the Terminal42\UrlRewriteBundle\ConfigProvider\ConfigProviderInterface interface and be registered with the appropriate tag:
services: app.my_rewrite_provider: class: AppBundle\RewriteProvider\MyRewriteProvider public: false tags: - { name: terminal42_url_rewrite.provider, priority: 128 }