1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 <?php
/**
* TfLogger class file.
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package core
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Provides a custom error handler which writes to a logfile.
*
* Custom error handler functions such as this one should return FALSE; otherwise calls to
* trigger_error($msg, E_USER_ERROR) will not cause a script to stop execution!
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package core
* @var TfValidator $validator Instance of the Tuskfish data validator class.
*/
class TfLogger
{
protected $validator;
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
*/
public function __construct(TfValidator $validator)
{
if (is_a($validator, 'TfValidator')) {
$this->validator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_VALIDATOR, E_USER_ERROR);
}
}
/**
* Tuskfish custom error logger class.
*
* Errors are logged to TFISH_ERROR_LOG_PATH (default is /trust_path/log/tuskfish_log.txt). For
* debugging purpose you can reverse the comment status of the last two lines to display errors
* on screen. Be aware, however, that this will prevent script execution from halting when an
* error is triggered, which has security implications. You must therefore CLOSE your site via
* the admin preferences before doing this. Comment the lines back out before re-opening your
* site.
*
* @param int $errno The level of the error raised.
* @param string $error The error message.
* @param string $file Name of the file where the error occurred.
* @param int $line Line number the error was raised at.
* @return bool Returns false to halt script execution.
*/
public function logError(int $errno = null, string $error = '',
string $file = '', int $line = null)
{
$errno = isset($errno) ? $this->validator->trimString($errno) : TFISH_ERROR_UNSPECIFIED;
$error = !empty($error) ? $this->validator->trimString($error) : TFISH_ERROR_UNSPECIFIED;
$file = !empty($file) ? $this->validator->trimString($file) : TFISH_ERROR_UNSPECIFIED;
$line = isset($line) ? $this->validator->trimString($line) : TFISH_ERROR_UNSPECIFIED;
$message = date("Y-m-d, H:i:s", time()) . ": [ERROR][$errno][$error]";
$message .= "[$file:$line]\r\n";
error_log($message, 3, TFISH_ERROR_LOG_PATH);
// Debug only - comment OUT in production site to display errors on screen.
// echo '<p>' . print($message) . '</p>';
// Debug only - UNCOMMENT in production site.
return false;
}
}