↩️ ZF2 & ZF3 Module for Redirect with Handling against url
Clone or download

README.md

RedirectHandlerModule

PHP version Software License Build Status Coverage Status Downloads

RedirectHandlerModule is a module for handling redirect when the given url to redirect plugin is not registered in your ZF application. It simply override existing ZF redirect plugin, so we can just use it.

This is README for version ^2.0 which only support ZF3 with php ^7.1.

For version 1, you can read at version 1 readme which still support ZF2 with php ^5.6|^7.0 support.

For example, we use redirect() plugin in your controller:

$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:

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):

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

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:

return [
    'modules' => [
        // ...
        'RedirectHandlerModule',
    ],
];

Contributing

Contributions are very welcome. Please read CONTRIBUTING.md

Credit