Elgg  Version 3.0
Public Member Functions | Protected Attributes | List of all members
Elgg\HttpException Class Reference

Generic HTTP exception. More...

Inheritance diagram for Elgg\HttpException:
Elgg\BadRequestException Elgg\CsrfException Elgg\EntityNotFoundException Elgg\EntityPermissionsException Elgg\GatekeeperException Elgg\GroupGatekeeperException Elgg\PageNotFoundException Elgg\ValidationException PluginException

Public Member Functions

 setParams (array $params=[])
 Set params to provide context about the exception. More...
 
 getParams ()
 Retrieve exception parameters. More...
 
 getParam ($name)
 Get a parameter value. More...
 
 setRedirectUrl ($url)
 Set preferred redirect URL If set, a redirect response will be issued. More...
 
 getRedirectUrl ()
 Get preferred redirect URL. More...
 

Protected Attributes

 $params = []
 
 $url
 

Detailed Description

Generic HTTP exception.

Definition at line 8 of file HttpException.php.

Member Function Documentation

Elgg\HttpException::getParam (   $name)

Get a parameter value.

Parameters
string$nameParameter name
Returns
mixed|null

Definition at line 44 of file HttpException.php.

Elgg\HttpException::getParams ( )

Retrieve exception parameters.

Returns
array

Definition at line 35 of file HttpException.php.

Elgg\HttpException::getRedirectUrl ( )

Get preferred redirect URL.

Returns
string

Definition at line 63 of file HttpException.php.

Elgg\HttpException::setParams ( array  $params = [])

Set params to provide context about the exception.

Parameters
array$paramsPayload
Returns
void

Definition at line 27 of file HttpException.php.

Elgg\HttpException::setRedirectUrl (   $url)

Set preferred redirect URL If set, a redirect response will be issued.

Parameters
string$urlURL
Returns
void

Definition at line 55 of file HttpException.php.

Member Data Documentation

Elgg\HttpException::$params = []
protected

Definition at line 13 of file HttpException.php.

Elgg\HttpException::$url
protected

Definition at line 18 of file HttpException.php.


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