Function __global->_generic_exit
Definitions
sources/failure.php
- Do a terminal execution on a defined page type.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $text | mixed | No | No | required parameter | N/A | N/A | The error message, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode) |
| $template | ID_TEXT | No | No | required parameter | INFORM_SCREEN WARN_SCREEN FATAL_SCREEN | N/A | Name of the terminal page template |
| $support_match_key_messages | ?boolean | No | No | False | N/A | N/A | Whether match key messages / redirects should be supported (null: detect) |
| $log_error | boolean | No | No | False | N/A | N/A | Whether to log the error |
| $http_status | ?integer | No | No | Null | N/A | N/A | HTTP status to set (null: none, unless it's a missing resource error in which case 404) |
| $title | ?Tempcode | No | No | Null | N/A | N/A | Title to use show (null: default) |
| $image_url | ?URLPATH | No | No | Null | N/A | N/A | Image to show (only works for INFORM_SCREEN and WARN_SCREEN) (null: default) |
Preview
Code (PHP)
/**
* Do a terminal execution on a defined page type.
*
* @param mixed $text The error message, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
* @param ID_TEXT $template Name of the terminal page template
* @set INFORM_SCREEN WARN_SCREEN FATAL_SCREEN
* @param ?boolean $support_match_key_messages Whether match key messages / redirects should be supported (null: detect)
* @param boolean $log_error Whether to log the error
* @param ?integer $http_status HTTP status to set (null: none, unless it's a missing resource error in which case 404)
* @param ?Tempcode $title Title to use show (null: default)
* @param ?URLPATH $image_url Image to show (only works for INFORM_SCREEN and WARN_SCREEN) (null: default)
*/
function _generic_exit($text, string $template, ?bool $support_match_key_messages = false, bool $log_error = false, ?int $http_status = null, ?object $title = null, ?string $image_url = null)
* Do a terminal execution on a defined page type.
*
* @param mixed $text The error message, provided in plain-text format or as HTML via do_lang_tempcode/protect_from_escaping (string or Tempcode)
* @param ID_TEXT $template Name of the terminal page template
* @set INFORM_SCREEN WARN_SCREEN FATAL_SCREEN
* @param ?boolean $support_match_key_messages Whether match key messages / redirects should be supported (null: detect)
* @param boolean $log_error Whether to log the error
* @param ?integer $http_status HTTP status to set (null: none, unless it's a missing resource error in which case 404)
* @param ?Tempcode $title Title to use show (null: default)
* @param ?URLPATH $image_url Image to show (only works for INFORM_SCREEN and WARN_SCREEN) (null: default)
*/
function _generic_exit($text, string $template, ?bool $support_match_key_messages = false, bool $log_error = false, ?int $http_status = null, ?object $title = null, ?string $image_url = null)