From 5178de900e24928c11e60736c2602c64dbce4fa2 Mon Sep 17 00:00:00 2001
From: Taylor Otwell <taylorotwell@gmail.com>
Date: Thu, 22 Sep 2011 00:16:14 -0500
Subject: [PATCH] added comments to redirect class.

---
 laravel/redirect.php | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/laravel/redirect.php b/laravel/redirect.php
index 06d38c8a..20cf75ec 100644
--- a/laravel/redirect.php
+++ b/laravel/redirect.php
@@ -5,6 +5,17 @@ class Redirect extends Response {
 	/**
 	 * Create a redirect response.
 	 *
+	 * <code>
+	 *		// Create a redirect response to a location within the application
+	 *		return Redirect::to('user/profile');
+	 *
+	 *		// Create a redirect with a 301 status code
+	 *		return Redirect::to('user/profile', 301);
+	 *
+	 *		// Create a redirect response to a location outside of the application
+	 *		return Redirect::to('http://google.com');
+	 * </code>
+	 *
 	 * @param  string    $url
 	 * @param  int       $status
 	 * @param  bool      $https
@@ -34,6 +45,11 @@ public static function to_secure($url, $status = 302)
 	 *
 	 * This is useful for passing status messages or other temporary data to the next request.
 	 *
+	 * <code>
+	 *		// Create a redirect response and flash something to the session
+	 *		return Redirect::to('user/profile')->with('message', 'Welcome Back!');
+	 * </code>
+	 *
 	 * @param  string          $key
 	 * @param  mixed           $value
 	 * @return Response
@@ -52,6 +68,14 @@ public function with($key, $value)
 
 	/**
 	 * Magic Method to handle creation of redirects to named routes.
+	 *
+	 * <code>
+	 *		// Create a redirect response to the "profile" named route
+	 *		return Redirect::to_profile();
+	 *
+	 *		// Create a redirect response to a named route using HTTPS
+	 *		return Redirect::to_secure_profile();
+	 * </code>
 	 */
 	public static function __callStatic($method, $parameters)
 	{