added comments to redirect class.
This commit is contained in:
parent
72aaf60241
commit
5178de900e
|
@ -5,6 +5,17 @@ class Redirect extends Response {
|
||||||
/**
|
/**
|
||||||
* Create a redirect 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 string $url
|
||||||
* @param int $status
|
* @param int $status
|
||||||
* @param bool $https
|
* @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.
|
* 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 string $key
|
||||||
* @param mixed $value
|
* @param mixed $value
|
||||||
* @return Response
|
* @return Response
|
||||||
|
@ -52,6 +68,14 @@ public function with($key, $value)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Magic Method to handle creation of redirects to named routes.
|
* 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)
|
public static function __callStatic($method, $parameters)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue