Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samsonasik/redirecthandlermodule
:leftwards_arrow_with_hook: Zend Framework/Laminas Module for Redirect with Handling against url
https://github.com/samsonasik/redirecthandlermodule
handler laminas redirect redirect-plugin redirector zf2 zf3
Last synced: 2 days ago
JSON representation
:leftwards_arrow_with_hook: Zend Framework/Laminas Module for Redirect with Handling against url
- Host: GitHub
- URL: https://github.com/samsonasik/redirecthandlermodule
- Owner: samsonasik
- License: mit
- Created: 2015-10-22T20:35:00.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T17:04:41.000Z (over 4 years ago)
- Last Synced: 2024-05-01T23:55:27.428Z (5 months ago)
- Topics: handler, laminas, redirect, redirect-plugin, redirector, zf2, zf3
- Language: PHP
- Homepage:
- Size: 420 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
RedirectHandlerModule
=====================
[](https://badge.fury.io/ph/samsonasik%2Fredirect-handler-module)
[](LICENSE)
[](https://travis-ci.org/samsonasik/RedirectHandlerModule)
[](https://coveralls.io/r/samsonasik/RedirectHandlerModule)
[](https://packagist.org/packages/samsonasik/redirect-handler-module)
*RedirectHandlerModule* is a module for handling redirect when the given url to redirect plugin is not registered in your Laminas application. It simply override existing Laminas redirect plugin, so we can just use it.
> This is README for version ^3.0 which only support Laminas 3 with php ^7.1.
> For version 2, you can read at [version 2 readme](https://github.com/samsonasik/RedirectHandlerModule/tree/2.x.x) which still support ZF3 with php ^7.1 support.
> For version 1, you can read at [version 1 readme](https://github.com/samsonasik/RedirectHandlerModule/tree/1.x.x) which still support ZF2 with php ^5.6|^7.0 support.
For example, we use `redirect()` plugin in your controller:
```php
$redirect = '/foo'; // may be a variable from GET
return $this->redirect()->toUrl($redirect);
```
if the passed `$redirect` as url is a valid and registered in the routes, it uses default `redirect()` implementation, otherwise, it will redirect to default `default_url` registered in `config/autoload/redirect-handler-module.local.php`:
For example, we define:
```php
return [
'redirect_handler_module' => [
'allow_not_routed_url' => false,
'default_url' => '/',
'options' => [
'exclude_urls' => [
// 'https://www.github.com/samsonasik/RedirectHandlerModule',
], // to allow excluded urls to always be redirected
'exclude_hosts' => [
// 'www.github.com'
],
],
],
];
```
It means, we can't allow to make redirect to outside registered routes, whenever found un-registered url in routes, then we will be redirected to default_url. It also disable redirect to self, so you can't redirect to self.
For specific urls that exceptional ( allowed to be redirected even not registered in routes), you can register at `exclude_urls`/`exclude_hosts` options.
> if you define exclude_urls/exclude_hosts options, which one of them is your own current url/host/domain, its your risk to still get "infinite" redirection loops. so, make sure exclude_urls/exclude_hosts is not your current own.
While default implementation of redirect to self will silently, you can trigger your listener to handle redirect to self in your `Module::onBootstrap($e)`:
```php
class Module
{
public function onBootstrap($e)
{
$app = $e->getApplication();
$eventManager = $app->getEventManager();
$sharedManager = $eventManager->getSharedManager();
$sharedManager->attach('RedirectHandlerModule\Controller\Plugin\Redirect', 'redirect-same-url', function() {
die('You need to use different URL for Redirect');
});
$plugin = $app->getServiceManager()->get('ControllerPluginManager')->get('redirect');
$plugin->setEventManager($eventManager);
}
}
```
Installation
------------
Require via composer
```bash
composer require samsonasik/redirect-handler-module
```
After composer require done, you can copy `vendor/samsonasik/redirect-handler-module/config/redirect-handler-module.local.php.dist` to `config/autoload/redirect-handler-module.local.php` and modify on your needs.
Last, register to `config/application.config.php`:
```php
return [
'modules' => [
// ...
'RedirectHandlerModule',
],
];
```
Contributing
------------
Contributions are very welcome. Please read [CONTRIBUTING.md](https://github.com/samsonasik/RedirectHandlerModule/blob/master/CONTRIBUTING.md)
Credit
------
- [Abdul Malik Ikhsan](https://github.com/samsonasik)
- [All RedirectHandlerModule contributors](https://github.com/samsonasik/RedirectHandlerModule/contributors)