Clean code

This commit is contained in:
Laurent Destailleur 2024-04-25 11:13:34 +02:00
parent cb4f5d90fc
commit 0ceacfdc6a
5 changed files with 36 additions and 101 deletions

View File

@ -1178,8 +1178,8 @@ class Conf extends stdClass
require_once $handler_file_found;
$loghandlerinstance = new $handler();
if (!$loghandlerinstance instanceof LogHandlerInterface) {
throw new Exception('Log handler does not extend LogHandlerInterface');
if (!$loghandlerinstance instanceof LogHandler) {
throw new Exception('Log handler does not extend LogHandler');
}
if (empty($this->loghandlers[$handler])) {

View File

@ -18,12 +18,10 @@
* or see https://www.gnu.org/
*/
require_once DOL_DOCUMENT_ROOT.'/core/modules/syslog/logHandlerInterface.php';
/**
* Parent class for log handlers
*/
abstract class LogHandler implements LogHandlerInterface
abstract class LogHandler
{
/**
* @var string Code for the handler
@ -38,6 +36,16 @@ abstract class LogHandler implements LogHandlerInterface
public $errors = [];
/**
* Return name of logger
*
* @return string
*/
public function getName()
{
return ucfirst($this->code);
}
/**
* Content of the info tooltip.
*
@ -110,4 +118,17 @@ abstract class LogHandler implements LogHandlerInterface
{
$this->ident += $ident;
}
/**
* Export the message
*
* @param array $content Array containing the info about the message
* @param string $suffixinfilename When output is a file, append this suffix into default log filename.
* @return void
*/
public function export($content, $suffixinfilename = '')
{
// Code to output log
return;
}
}

View File

@ -1,90 +0,0 @@
<?php
/* Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
*/
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
* or see https://www.gnu.org/
*/
/**
* \file htdocs/core/modules/syslog/logHandlerInterface.php
* \ingroup syslog
* \brief LogHandlerInterface
*/
/**
* LogHandlerInterface
*/
interface LogHandlerInterface
{
/**
* Return name of logger
*
* @return string Name of logger
*/
public function getName();
/**
* Return version of logger
*
* @return string Version of logger
*/
public function getVersion();
/**
* Return information on logger
*
* @return string Version of logger
*/
public function getInfo();
/**
* Return warning if something is wrong with logger
*
* @return string Warning message
*/
public function getWarning();
/**
* Return array of configuration data
*
* @return array Return array of configuration data
*/
public function configure();
/**
* Return if configuration is valid
*
* @return boolean True if configuration ok
*/
public function checkConfiguration();
/**
* Is the logger active ?
*
* @return int 1 if logger enabled
*/
public function isActive();
/**
* Export the message
*
* @param array $content Array containing the info about the message
* @param string $suffixinfilename When output is a file, append this suffix into default log filename.
* @return void
*/
public function export($content, $suffixinfilename = '');
}

View File

@ -19,7 +19,7 @@ class mod_syslog_syslog extends LogHandler
*/
public function getName()
{
return 'Syslogd';
return 'Syslog';
}
/**
@ -125,7 +125,11 @@ class mod_syslog_syslog extends LogHandler
// (int) is required to avoid error parameter 3 expected to be long
openlog('dolibarr', LOG_PID | LOG_PERROR, (int) $facility);
syslog($content['level'], $content['message']);
$message = sprintf("%6s", dol_trunc($content['osuser'], 6, 'right', 'UTF-8', 1));
$message .= " ".$content['message'];
syslog($content['level'], $message);
closelog();
}
}

View File

@ -392,8 +392,8 @@ foreach ($handlers as $handler) {
require_once $file;
$loghandlerinstance = new $handler();
if (!$loghandlerinstance instanceof LogHandlerInterface) {
throw new Exception('Log handler does not extend LogHandlerInterface');
if (!$loghandlerinstance instanceof LogHandler) {
throw new Exception('Log handler does not extend LogHandler');
}
if (empty($conf->loghandlers[$handler])) {
@ -507,8 +507,8 @@ function conf($dolibarr_main_document_root)
require_once $file;
$loghandlerinstance = new $handler();
if (!$loghandlerinstance instanceof LogHandlerInterface) {
throw new Exception('Log handler does not extend LogHandlerInterface');
if (!$loghandlerinstance instanceof LogHandler) {
throw new Exception('Log handler does not extend LogHandler');
}
if (empty($conf->loghandlers[$handler])) {