phpBB

Development Wiki

Difference between revisions of "Function.trigger error"

From phpBB Development Wiki

(trigger_error)
 
Line 1: Line 1:
 
trigger_error –– Generates a user-level error/warning/notice message or page.
 
trigger_error –– Generates a user-level error/warning/notice message or page.
  
===Description===
+
==Description==
 
<code>bool '''trigger_error''' ( string $error_msg [, int $error_type ] )</code>
 
<code>bool '''trigger_error''' ( string $error_msg [, int $error_type ] )</code>
 
Used to trigger a user error condition and exiting the script. This function is useful when you need to generate a particular response to an exception at runtime. trigger_error() utilises the template: '''message_body.html''' in phpBB3.
 
Used to trigger a user error condition and exiting the script. This function is useful when you need to generate a particular response to an exception at runtime. trigger_error() utilises the template: '''message_body.html''' in phpBB3.
 
<br>
 
<br>
===Parameters===
+
==Parameters==
<code>error_msg</code>
+
'''error_msg'''<br>
 
The designated error message for this error. You can specify this message as simply the language key of a language variable, or a combination of text or language variables.
 
The designated error message for this error. You can specify this message as simply the language key of a language variable, or a combination of text or language variables.
<hr>
+
<br><br>
<code>error_type</code>
+
'''error_type'''<br>
 
The designated error type for this error. It only works with the E_USER family of constants, and will default to E_USER_NOTICE. There are three error types that can be used: E_USER_NOTICE, E_USER_WARNING, and E_USER_ERROR.<br>
 
The designated error type for this error. It only works with the E_USER family of constants, and will default to E_USER_NOTICE. There are three error types that can be used: E_USER_NOTICE, E_USER_WARNING, and E_USER_ERROR.<br>
 
:'''E_USER_NOTICE''' (the default setting) is an "information" page. It's used for situations such as the message you receive upon completion of a post or logging in to phpBB3. In the ACP, E_USER_NOTICE displays a green information box.<br>
 
:'''E_USER_NOTICE''' (the default setting) is an "information" page. It's used for situations such as the message you receive upon completion of a post or logging in to phpBB3. In the ACP, E_USER_NOTICE displays a green information box.<br>
Line 15: Line 15:
 
:'''E_USER_ERROR''' should only be used for very severe errors, for example if sessions are unavailable. E_USER_ERROR is used for SQL Errors as an example. E_USER_ERROR displays a hard-coded error page for both user facing pages and within the ACP.
 
:'''E_USER_ERROR''' should only be used for very severe errors, for example if sessions are unavailable. E_USER_ERROR is used for SQL Errors as an example. E_USER_ERROR displays a hard-coded error page for both user facing pages and within the ACP.
 
<br>
 
<br>
===Examples===
+
==Examples==
====Example #1: Single language key example====
+
===Example #1: Single language key example===
 
<php>if (!$result)
 
<php>if (!$result)
 
{
 
{
Line 22: Line 22:
 
}</php>
 
}</php>
  
====Example #2: Combined message and specified error type====
+
===Example #2: Combined message and specified error type===
 
<php>$switch ($mode)
 
<php>$switch ($mode)
 
{
 
{

Revision as of 07:44, 7 September 2008

trigger_error –– Generates a user-level error/warning/notice message or page.

Description

bool trigger_error ( string $error_msg [, int $error_type ] ) Used to trigger a user error condition and exiting the script. This function is useful when you need to generate a particular response to an exception at runtime. trigger_error() utilises the template: message_body.html in phpBB3.

Parameters

error_msg
The designated error message for this error. You can specify this message as simply the language key of a language variable, or a combination of text or language variables.

error_type
The designated error type for this error. It only works with the E_USER family of constants, and will default to E_USER_NOTICE. There are three error types that can be used: E_USER_NOTICE, E_USER_WARNING, and E_USER_ERROR.

E_USER_NOTICE (the default setting) is an "information" page. It's used for situations such as the message you receive upon completion of a post or logging in to phpBB3. In the ACP, E_USER_NOTICE displays a green information box.
E_USER_WARNING is used for warnings. On user-facing pages in the default phpBB3 styles, there is no visible difference between E_USER_NOTICE and E_USER_WARNING. In the ACP, E_USER_WARNING displays as a red “Error” box.
E_USER_ERROR should only be used for very severe errors, for example if sessions are unavailable. E_USER_ERROR is used for SQL Errors as an example. E_USER_ERROR displays a hard-coded error page for both user facing pages and within the ACP.


Examples

Example #1: Single language key example

if (!$result)
{
    
trigger_error('NO_RESULTS');
}

Example #2: Combined message and specified error type

$switch ($mode)
{
    
// [..]
    
default:
        
trigger_error($user->lang['NO_MODE'] . adm_back_link($this->u_action), E_USER_ERROR);
    break;
}