Back to BaseController class

Method setRedirect

public static
setRedirect
(mixed $url, mixed $msg = null, mixed $type = null)
Set a URL for browser redirection.
Parameters
  • string $url URL to redirect to.
  • string $msg Message to display on redirect. Optional, defaults to value set internally by controller, if any.
  • string $type Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.
Returns
  • static This object to support chaining.
Since
  • 3.0

Method setRedirect - Source code

/**
 * Set a URL for browser redirection.
 *
 * @param   string  $url   URL to redirect to.
 * @param   string  $msg   Message to display on redirect. Optional, defaults to value set internally by controller, if any.
 * @param   string  $type  Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.
 *
 * @return  static  This object to support chaining.
 *
 * @since   3.0
 */
public function setRedirect($url, $msg = null, $type = null)
{
    $this->redirect = $url;
    if ($msg !== null) {
        // Controller may have set this directly
        $this->message = $msg;
    }
    // Ensure the type is not overwritten by a previous call to setMessage.
    if (empty($type)) {
        if (empty($this->messageType)) {
            $this->messageType = 'message';
        }
    } else {
        $this->messageType = $type;
    }
    return $this;
}