axRedirectException Class Reference

Redirect Exception Class. More...

Public Member Functions
	__construct ($url, $method=self::REDIRECT_PERMANENT)
	Constructor.
	getUrl ()
	Get the redirection URL.
	getMethod ()
	Get the redirection method.
	getHeaderString ()
	Get the proper header string to send to the browser.
	__toString ()
	Get the header from this exception as string.
Data Fields
const	REDIRECT_PERMANENT = 1
const	REDIRECT_REFRESH = 2
const	REFRESH_DELAY = 5
Protected Attributes
	$_url
	URL to redirect to.
	$_method
	Redirect method.

---

Detailed Description

Redirect Exception Class.

Todo:

Redirect Exception long description

Author:

Delespierre

Copyright:

Copyright 2010-2011, Benjamin Delespierre (http://bdelespierre.fr)

License:

http://www.gnu.org/licenses/lgpl.html Lesser General Public Licence version 3

Definition at line 17 of file axRedirectException.class.php.

---

Constructor & Destructor Documentation

axRedirectException::__construct	(	$	url,
		$	method = self::REDIRECT_PERMANENT
	)

Constructor.

Parameters:

string	$url
integer	$method	axRedirectException::REDIRECT_PERMANENT or axRedirectException::REDIRECT_REFRESH

Definition at line 49 of file axRedirectException.class.php.

---

Member Function Documentation

axRedirectException::__toString

(

)

Get the header from this exception as string.

Returns:

string

Definition at line 90 of file axRedirectException.class.php.

axRedirectException::getHeaderString

(

)

Get the proper header string to send to the browser.

Will return false if the redirect method is not set.

Returns:

string

Definition at line 78 of file axRedirectException.class.php.

axRedirectException::getMethod

(

)

Get the redirection method.

Returns:

integer

Definition at line 67 of file axRedirectException.class.php.

axRedirectException::getUrl

(

)

Get the redirection URL.

Returns:

string

Definition at line 59 of file axRedirectException.class.php.

---

Field Documentation

integer axRedirectException::$_method [protected]

Redirect method.

Definition at line 42 of file axRedirectException.class.php.

string axRedirectException::$_url [protected]

URL to redirect to.

Definition at line 36 of file axRedirectException.class.php.

const axRedirectException::REDIRECT_PERMANENT = 1

Definition at line 23 of file axRedirectException.class.php.

const axRedirectException::REDIRECT_REFRESH = 2

Definition at line 24 of file axRedirectException.class.php.

const axRedirectException::REFRESH_DELAY = 5

Definition at line 30 of file axRedirectException.class.php.

---

The documentation for this class was generated from the following file:

• H:/Workspace/php-axiom/www/php-axiom/libraries/axiom/axRedirectException.class.php