Yii2 ReturnUrl ¶

1. Features
2. Installation
3. Usage
4. License
5. Links

ReturnUrl helper for tab-aware nested redirection in Yii2.

You might be saying, Yii2 already handles a returnUrl perfectly fine with the Url::remember() and Url::previous() methods. Why not use those?

These methods store the returnUrl into a single variable in the users session. This becomes a flaw when we have multiple tabs open. Take the following scenario:

• A user navigates to a page that sets a returnUrl. The page is for a form they have to complete.
• The phone rings, and they are required to fill in a different form. They achieve this by opening another tab.
• As they navigate to the new page, their old returnUrl is overwritten by the new one, they complete the second form and everything seems normal.
• They then return to their first form, and after submission they get taken to the second returnUrl and their navigation path appears broken.

The solution is to pass the returnUrl into the GET and POST request by embedding it into your links and forms. This extension makes it very easy to do and solves many common problems including the maximum length of a GET request.

Features ¶

• Allows a URL to be consistent with the page the user is viewing, even if they open other tabs.
• Easily embed return URLs into your links or forms.
• Handles very long returnUrl values by passing a key in the GET params.

Installation ¶

The preferred way to install this extension is through composer.

Either run

$ composer require cornernote/yii2-returnurl "*"

or add

"cornernote/yii2-returnurl": "*"

to the require section of your composer.json file.

Usage ¶

Your user is on a search results page, and you have a link to an update form. After filling in the form you want the user to be returned to the page they started from.

On the start page, add a ReturnUrl to your link, for example in views/post/index.php: `php // generate a returnUrl link value Html::a('edit post', ['post/update', 'id' => $post->id, 'ru' => ReturnUrl::getToken()]); `

On the update page, add a returnUrl to your form, for example in views/post/update.php: `php // generate a returnUrl form value Html::hiddenInput('ru', ReturnUrl::getRequestToken()); `

In the controller action that handles the form, change the call to $this->redirect(), for example in Post::actionUpdate() `php // this is where we used to redirect to, we use it as a fail-back // (if not provided then we redirect to the home page) $altUrl = ['post/index']; return $this->redirect(ReturnUrl::getUrl($altUrl)); `

License ¶

• Author: Brett O'Donnell cornernote@gmail.com
• Source Code: https://github.com/cornernote/yii2-return-url
• Copyright © 2015 Mr PHP info@mrphp.com.au
• License: BSD-3-Clause https://raw.github.com/cornernote/yii2-return-url/master/LICENSE

Links ¶

• Github Project
• Composer Package
• MrPHP