Redirecting Users
Use redirection to keep your application user friendly.
Last updated
Was this helpful?
2.5.0
Use redirection to keep your application user friendly.
Last updated
Was this helpful?
When a user submits a form, you do not want to show any content on the page that handles the form submission! Why? Because if you do, and the user hits refresh in their browser, the form handling code could be triggered again, possibly causing duplicate entries in your database, multiple emails being sent, etc.
To avoid the above problem, it is recommended to always redirect the user after submitting a form. In CFWheels this is done with the function. It is basically a wrapper around the cflocation tag in CFML.
Being that is a CFWheels function, it can accept the route, controller, action, and key arguments so that you can easily redirect
to other actions in your application.
Let's look at the three ways you can redirect in CFWheels.
You can redirect the user to another action in your application simply by passing in the controller, action, and key arguments. You can also pass in any other arguments that are accepted by the function, like host, params, etc. (The function is what CFWheels uses internally to produce the URL to redirect to.)
If you have configured any routes in config/routes.cfm, you can use them when redirecting as well. Just pass in the route's name to the route argument together with any additional arguments needed for the route in question. You can read more about routing in the chapter.
It's very common that all you want to do when a user submits a form is send them back to where they came from. (Think of a user posting a comment on a blog post and then being redirected back to view the post with their new comment visible as well.) For this, we have the back argument. Simply pass in back=true to , and the user will be redirected back to the page they came from.
The referring URL is retrieved from the cgi.http_referer value. If this value is blank or comes from a different domain than the current one, CFWheels will redirect the visitor to the root of your website instead.
Sometimes it's useful to be able to send the visitor back to the same URL they came from but with extra parameters added to it. You can do this by using the params argument. Note that CFWheels will append to the URL and not replace it in this case.
addToken and statusCode ArgumentsYou can also set the type of redirect to something other than the default 302 redirect, by passing in statusCode=3xx. For example, 301 indicates a permanent redirect.
If you want to specify exactly where to send the visitor when the referring domain is blank/foreign, you can pass in the normal arguments like route, controller, action, etc. These will be used only when CFWheels can't redirect to the referrer because it's invalid.
The function uses <cflocation> under the hood; if you need to pass client variable information automatically in the URL for client management purposes, simply set addToken=true.