Logger Class Reference

Inheritance diagram for Logger:

Public Member Functions
	__construct ($name="root", $pDevMode=false)
	debug (... $msg)
	info (... $msg)
	warning (... $msg)
	notice (... $msg)
	error (... $msg)

Protected Member Functions
	log ($level, $log)
	log_format ($level,... $args)

Private Attributes
	$devMode = false

Detailed Description

Definition at line 9 of file logging.i.

Member Function Documentation

debug()

Logger::debug

(

$msg

)

(3/6/18) - Debug prints should not make it to production. The intent of debug is purely for debugging development code. If you would like to dump extra information to the log to better track down error in production then use either info or error

Definition at line 52 of file logging.i.

                          {
    /**
     * (3/6/18) - Debug prints should not make it to production.
     * The intent of debug is purely for debugging development code.
     * If you would like to dump extra information to the log to better track down
     * error in production then use either
     * info or
     * error
     */
    if ($this->devMode) {
      return $this->log_format('DEBUG', ...$msg);
    }
  }

log_format()

Logger::log_format (   $level,   $args  )

protected

args can be a variable number of messages. ONLY 1 then this is the only message and there is no extra formatting

1

This option will format the string, based on the printf format, which should be the first argument in that array ** NOTE using [] is short notation for declaring an array For example $logger->info("%s %s", "Print this String", "Then this string");

Definition at line 25 of file logging.i.

                                                  {
    /**
      *  args can be a variable number of messages.
      *  ONLY 1
      *    then this is the only message and there is no extra formatting
      *
      *  > 1
      *    This option will format the string, based on the printf format, which should be the first argument in that array
      *        ** NOTE using [] is short notation for declaring an array
      *    For example  $logger->info("%s %s", "Print this String", "Then this string");
      *
      */
    if (count($args) == 1) {
      $logMsg = array_shift($args);
    } else {
        // ** First argument is the format
        // ** Remaining arguments will be used in the vsprintf function
        // ** However, if there aren't enough items in the array to match the printf formatting %
          // ** then an error is thrown.  Trying to catch that here.  And then just print out the array elements as a string
        // *** NOTE:  When using this method a warning will be raised if you have less arguments than formats % for vsprintf
      $fmt = array_shift($args);
      $logMsg = vsprintf($fmt, $args);
    }
    // pass string to log function and return response
    return $this->log($level, $logMsg);
  }

Member Data Documentation

$devMode

Logger::$devMode = false

private

devMode – Is the environment currently set to be in dev mode? {true, false (default)}

Definition at line 15 of file logging.i.

---

The documentation for this class was generated from the following file:

• app/web/shared/library/logging.i