mirror of
https://github.com/FH-Complete/FHC-Core.git
synced 2026-06-18 04:29:28 +00:00
Paolo
2d7cc09d02
- Moved logic from controllers system/Messages and ViewMessage to CL/Messages_model - Better code - MessageLib and PersonLogLib methods do not use anymore show_error and return success/error object - helpers/hlp_message_helper: hasData function changed
112 lines
2.2 KiB
PHP
112 lines
2.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* FH-Complete
|
|
*
|
|
* @package FHC-Helper
|
|
* @author FHC-Team
|
|
* @copyright Copyright (c) 2016 fhcomplete.org
|
|
* @license GPLv3
|
|
* @since Version 1.0.0
|
|
*/
|
|
|
|
/**
|
|
* Message Helper
|
|
*
|
|
* @subpackage Helpers
|
|
* @category Helpers
|
|
*/
|
|
|
|
if (! defined('BASEPATH')) exit('No direct script access allowed');
|
|
|
|
// -------------------------------------------------------------------------------------------------------
|
|
// Collection of functions to handle successful and error messages that methods and functions can return
|
|
// -------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* Success
|
|
*
|
|
* @return array
|
|
*/
|
|
function success($retval, $code = null, $msg_indx_prefix = 'fhc_')
|
|
{
|
|
$success = new stdClass();
|
|
$success->error = EXIT_SUCCESS;
|
|
$success->fhcCode = $code;
|
|
if (!is_null($code)) $success->msg = lang($msg_indx_prefix . $code);
|
|
$success->retval = $retval;
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* Error
|
|
*
|
|
* @return array
|
|
*/
|
|
function error($retval = '', $code = null, $msg_indx_prefix = 'fhc_')
|
|
{
|
|
$error = new stdClass();
|
|
$error->error = EXIT_ERROR;
|
|
$error->fhcCode = $code;
|
|
if (!is_null($code)) $error->msg = lang($msg_indx_prefix . $code);
|
|
$error->retval = $retval;
|
|
|
|
return $error;
|
|
}
|
|
|
|
/**
|
|
* Checks if the result represents a success
|
|
*/
|
|
function isSuccess($result)
|
|
{
|
|
if (is_object($result) && isset($result->error) && $result->error == EXIT_SUCCESS)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks if the result represents a success and also if it contains valid data
|
|
*/
|
|
function hasData($result)
|
|
{
|
|
if (isSuccess($result) && isset($result->retval)
|
|
&& (!isEmptyArray($result->retval)
|
|
|| !isEmptyString($result->retval)
|
|
|| is_numeric($result->retval)
|
|
|| is_object($result->retval)))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the property retval if $result contains data
|
|
*/
|
|
function getData($result)
|
|
{
|
|
$data = null;
|
|
|
|
if (hasData($result))
|
|
{
|
|
$data = $result->retval;
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Checks if the result represents an error
|
|
* Wrapper function of isSuccess, more readable code
|
|
* Bob Dylan: ...there's no success like failure. And that failure's no success at all.
|
|
*/
|
|
function isError($result)
|
|
{
|
|
return !isSuccess($result);
|
|
}
|