jidoka1902/redirecting-fallbacks

The redirecting-fallbacks project aims to provide an standardized way to configure your http redirects. e.g.: instead of showing an 404 page, redirect to the start page.

v1.0.1 2018-05-18 21:37 UTC

Requires

• php: ^7

Requires (Dev)

• phpunit/phpunit: ^6.3

BSD-3-Clause

• Anton Sylvester Zoffmann

• redirect
• 404
• redirects
• redirecting
• fallback

README

Goals

The "redirecting-fallbacks" project aims to give developers a standard framework to configure redirects. But this needs some Integration work into your Framework of choice.

Therefore this is just a very lean backend for further integrations.

Audience

This library is for developers.

If you have any proposals for enhancements or just found a bug, please let me know via github-issues or even create a pull-request ;)

Symfony

For the Symfony ecosystem, there is already an integration provided. If you need some inspiration how this library could work within a framework, please have a look there.

Parts explained

RedirectResolver

RedirectResolvers are the brain of this tiny project. They need a configuration to find out if they can give you a redirect target for an url path.

• The SingleRedirectResolver implementation just needs one redirect path configured and every requested route will return that target.
• The MultipleRedirectResolver takes a list of "paths" and "targets". So you can specify a hierarchy of redirects. E.g. the request to /posts will give you another target than the request to "/".
• If you have long lists of Redirect Configurations or another RedirectResolver which takes quiet a bit time to resolve the request-path - there is a CachedRedirectResolver implementation. This just caches your RedirectResolver::resolve() for the case you need to call it twice of more often within your integration.

But wait - this lib just resolves configurations? Yes - what event you want to listen to is your integration stuff.

RedirectResolverCache

The RedirectResolverCache is just the extracted Caching behaviour from the CachedRedirectResolver. The default behaviour is an ArrayCache so time consuming resolves will be reduced. But feel free to create your own implementations to whatever seems important to you ;)

UrlGenerator

The UrlGenerator provides exchangeable behaviour for what your configured "targets" will be as result of the RedirectResolver::resolve() method. So you could replace the PassthroughUrlGenerator (wich just returns the resolved targets one-to-one). So within the Symfony Integration that could just be changed to an Symfony Router Adapter.