Creates a log object to do LoxBerry-specific logging to a logfile or to the standard output (stderr, stdout). The LoxBerry logging module uses the user-defined loglevel from the plugin management, therefore no plugin-own setting and own loglevel-filtering is required.

LoxBerry Compatibility

This feature is available starting with LoxBerry V1.2.1. Set this as minimum version in your plugin.cfg.

This article is the specification of LoxBerry's log object-class.

The constructor of the log object takes several named parameters to adjust the logging behaviour. Some parameters are dependent to other parameters. These named parameters are delivered as array. 

Info for LoxBerry-Core developers: Some parameters have fallback settings if used in a plugin, but are mandatory if used in widgets or other LoxBerry-Core components.

Named parameters are delivered in the form LBLog::newLog ( [ "parameter" ⇒ "value", parameter ⇒ "value", … ] ). Take note to the square brackets [ ] inside the round brackets ( ) that define the array. 

Simple logging

require_once "loxberry_log.php";
 
 
// Creates a log object, automatically assigned to your plugin, with the group name "PHPLog"
$log = LBLog::newLog( [ "name" => "PHPLog" ] );
 
// For better realability, you also can define the parameter array first, and use the array as parameter
// This parameters create a log object with name "Daemon" and the specific filename mylogfile.log. Log entries are appended to an existing log.
$params = [ 
    "name" => "Daemon", 
    "filename" => "$lbplogdir/mylogfile.log",
    "append" => 1
];
$log = LBLog::newLog ($params);
 
// After your log object is created, you start the logging with LOGSTART
// A start timestamp and other information is added automatically
LOGSTART("Daemon script started");
 
// Do the logging in your script
 
 
LOGINF("Processing query");
LOGOK("Query successfully processed");
LOGERR("Error on processing the query");
LOGCRIT("Unable to process, terminating");
 
 
// Close the log with an LOGEND event
// Use LOGEND for every quitting of you script (independent of successful or not). A logfile without LOGEND will be shown open and unexpectedly terminated.
LOGEND("Daemon stopped");

After the log is initialized, you can access several properties from the log object (column "Readable"), and you also can change several properties ("Changeable"). 

Simple logging

require_once "loxberry_log.php";
 
// Creates a log object, automatically assigned to your plugin, with the group name "PHPLog"
$log = LBLog::newLog( [ "name" => "PHPLog" ] );
 
// Query the filename
$filename = $log->filename;
 
// Query the current loglevel
$loglevel = $log->loglevel;
 
// Pipe text to the logfile during operation
$filename = $log->filename;
system("ls -l >> $filename");
 
// Change the title of the log (V1.2.5 and above)
$log->logtitle("New title");
LOGTITLE("Another new title");
 
// Finish processing because of an unrecoverable error
if ($unrecoverable_error_occured) {
    LOGCRIT("Processing stopped because of an unrecoverable error");
    LOGERR("Occured error: $error");
    LOGINF("Current state is $state");
    // Finish the log
 
    LOGEND("Processing terminated");
    exit(1);
}

The following, additional methods exist, for interface functionality e.g. for the Bash logging SDK, used by initlog.php.