LSlog: add log_errors_context & log_errors_context_with_args paramters

doc/src/conf/global/LSlog.md

@@ -6,6 +6,8 @@ Cette section décrit le tableau de configuration de la journalisation de l'appl
 $GLOBALS['LSlog'] = array(
   'enable' => [booléen],
   'level' => '[niveau]',
+  'log_errors_context' => [booléen],
+  'log_errors_context_with_args' => [booléen],
   'handlers' => array(
     '[handler 1]',
     array (
@@ -53,6 +55,17 @@ $GLOBALS['LSlog'] = array(
   - `ERROR`
   - `FATAL`
 
+- `log_errors_context`
+
+  Booléen permatant de définir si le contexte _(=backtrace)_ doit être inclus lors de la
+  journalisation d'une erreurs.
+
+- `log_errors_context_with_args`
+
+  Booléen permatant de définir si les arguments des méthodes/fonctions appelées doivent être
+  inclus lors de la journalisation du contexte des erreurs.
+  __Note :__ ce paramètre n'as aucun effet si le paramètre `log_errors_context` n'est pas activé.
+
 - `handlers`
 
   Tableau permettant de configurer les *handlers* de la journalisation. Chaque *handler* gère les

src/conf/config.inc.php

@@ -204,8 +204,26 @@ define('LS_CSS_DIR', 'css');
 define('LSdebug',false);
 
 // Logging
-$GLOBALS['LSlog']['handlers'] = array (
+$GLOBALS['LSlog'] = array (
-  array (
+  // Enable/disable logs
+  'enable' => true,
+
+  // Global logs level (TRACE, DEBUG, INFO, WARNING, ERROR, FATAL)
+  'level' => 'INFO',
+
+  // Log errors's context (=backtrace)
+  'log_errors_context' => true,
+
+  // Log errors's context with arguments of called method/functions
+  'log_errors_context_with_args' => false,
+
+  /**
+   * Logs handlers are components that logged message emitted by the application.
+   * Each handlers handle emitted message as its own way (storing it in file/database, send it via
+   * email or to an external backend, ...).
+   */
+  'handlers' => array (
+    array(
       'handler' => 'file',
       'path' => 'tmp/LS.log',
       //'level' => 'DEBUG',
@@ -236,14 +254,14 @@ $GLOBALS['LSlog']['handlers'] = array (
       'level' => 'ERROR',
     ),
     */
-);
+  ),
-$GLOBALS['LSlog']['loggers'] = array (
   /**
    * Loggers permit to define different log parameters for specific components
    * of LdapSaisie (a class, an addon, ...). You could :
    *   - Enabled/disabled logs for this component with 'enabled' parameter
    *   - Set a specific log level for this component with 'enabled' parameter
    **/
+  "loggers" => array(
     /*
     'LSurl' => array (
       'level' => 'DEBUG',
@@ -255,9 +273,8 @@ $GLOBALS['LSlog']['loggers'] = array (
       'enabled' => false,
     ),
     */
+  ),
 );
-$GLOBALS['LSlog']['level'] = 'INFO';  // TRACE, DEBUG, INFO, WARNING, ERROR, FATAL
-$GLOBALS['LSlog']['enable'] = true;
 
 define('NB_LSOBJECT_LIST',30);
 define('NB_LSOBJECT_LIST_SELECT',20);

src/includes/class/class.LSlog.php

@@ -33,6 +33,18 @@ class LSlog {
    */
   private static $enabled = false;
 
+  /**
+   * Log errors context
+   * @var bool
+   */
+  private static $log_errors_context = false;
+
+  /**
+   * Log errors context with arguments
+   * @var bool
+   */
+  private static $log_errors_context_with_args = false;
+
   /**
    * Configured handlers
    * @see self::start()
@@ -91,6 +103,8 @@ class LSlog {
   public static function start() {
     // Load configuration
     self :: $enabled = self :: getConfig('enable', false, 'bool');
+    self :: $log_errors_context = self :: getConfig('log_errors_context', false, 'bool');
+    self :: $log_errors_context_with_args = self :: getConfig('log_errors_context_with_args', false, 'bool');
     self :: setLevel();
 
     // Load default handlers class
@@ -252,6 +266,13 @@ class LSlog {
         $message = varDump($message);
     }
 
+    // Append context to message (if enabled)
+    if (self :: $log_errors_context && self :: checkLevel($level, "ERROR"))
+      $message .= "\n".self :: get_debug_backtrace_context(
+        self :: $log_errors_context_with_args,
+        2
+      );
+
     foreach (self :: $handlers as $handler) {
       // Check handler level
       if (!$handler -> checkLevel($level))