Generic HTTP exception. More...
Inheritance diagram for Elgg\Exceptions\HttpException:
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
Member Function Documentation
◆ getParam()
| Elgg\Exceptions\HttpException::getParam | ( | $name | ) |
Get a parameter value.
- Parameters
-
string $name Parameter name
- Returns
- mixed|null
Definition at line 46 of file HttpException.php.
◆ getParams()
| Elgg\Exceptions\HttpException::getParams | ( | ) |
◆ getRedirectUrl()
| Elgg\Exceptions\HttpException::getRedirectUrl | ( | ) |
◆ setParams()
| Elgg\Exceptions\HttpException::setParams | ( | array | $params = [] | ) |
Set params to provide context about the exception.
- Parameters
-
array $params Payload
- Returns
- void
Definition at line 29 of file HttpException.php.
◆ setRedirectUrl()
| Elgg\Exceptions\HttpException::setRedirectUrl | ( | $url | ) |
Set preferred redirect URL If set, a redirect response will be issued.
- Parameters
-
string $url URL
- Returns
- void
Definition at line 57 of file HttpException.php.
Member Data Documentation
◆ $params
|
protected |
Definition at line 15 of file HttpException.php.
◆ $url
|
protected |
Definition at line 20 of file HttpException.php.
The documentation for this class was generated from the following file:
- engine/classes/Elgg/Exceptions/HttpException.php
