bn8/eesyphp
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Tpl: add display_ajax_error() helper method

Browse source
This commit is contained in:
Benjamin Renard 2023-11-20 18:45:50 +01:00
parent 85544a36b8
commit 945bf76d7d
Signed by: bn8
GPG key ID: 3E2E1CE1907115BC
1 changed files with 33 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
src/Tpl.php
View file

@ -524,16 +524,21 @@ class Tpl {
/** /**
* Display AJAX return * Display AJAX return
* @param array|null $data AJAX returned data (optional) * @param array|null $data AJAX returned data (optional)
* @param int|null $error_code HTTP error code (optional, default: 400 if not $data['success'])
* @param bool $pretty AJAX returned data * @param bool $pretty AJAX returned data
* (optional, default: true if $_REQUEST['pretty'] is set, False otherwise) * (optional, default: true if $_REQUEST['pretty'] is set, False otherwise)
* @return never * @return never
*/ */
public static function display_ajax_return($data=null, $pretty=false) { public static function display_ajax_return($data=null, $error_code=null, $pretty=false) {
if (!is_array($data)) if (!is_array($data))
$data = array(); $data = array();
// Adjust HTTP error code on unsuccessfull request
elseif (isset($data['success']) && !$data['success'] && http_response_code() == 200) // Adjust HTTP error code on unsuccessfull request (or if custom error code is provided)
http_response_code(400); if (
$error_code
|| (isset($data['success']) && !$data['success'] && http_response_code() == 200)
)
http_response_code($error_code ? $error_code : 400);
$data['messages'] = self :: get_messages(); $data['messages'] = self :: get_messages();
if (!$data['messages']) unset($data['messages']); if (!$data['messages']) unset($data['messages']);
@ -550,6 +555,29 @@ class Tpl {
exit(); exit();
} }
/**
* Display AJAX error
* @param string|null $error Error message (optional)
* @param int|null $error_code HTTP error code (optional, default: 400)
* @param bool $pretty AJAX returned data
* (optional, default: true if $_REQUEST['pretty'] is set, False otherwise)
* @return never
*/
public static function display_ajax_error($error=null, $error_code=null, $pretty=false) {
self :: display_ajax_return(
array(
'success' => false,
'error' => (
$error?
$error:
I18n::_("Unexpected error occured. If problem persist, please contact support.")
),
),
$error_code,
$pretty
);
}
/** /**
* Handle a fatal error * Handle a fatal error
* @param string $error The error message * @param string $error The error message
@ -576,7 +604,7 @@ class Tpl {
// Handle API mode // Handle API mode
if (Url :: api_mode()) if (Url :: api_mode())
self :: display_ajax_return(array('success' => false, 'error' => $error)); self :: display_ajax_error($error);
self :: assign('fatal_error', $error); self :: assign('fatal_error', $error);
self :: display('fatal_error.tpl'); self :: display('fatal_error.tpl');