Skip to end of metadata
Go to start of metadata

$html = LBWeb::loglist_html( %params );

 

Returns HTML of the logfile list to directly show the overview of your logfiles in your plugin. It is thought to show the list on navigating a Logfiles tab ($navbar), but you can integrate the HTML where you like.

LoxBerry Compatibility

This function is available starting with LoxBerry V1.2.5. If you use that function, set this minimum version in your plugin.cfg.

This feature only works with logfiles creates with the module LoxBerry::Log (Perl) or LBLog (PHP). It does not work for logfiles created with own logging features (as the list is read from the LoxBerry logfile database).

The function returns a preformatted html string of the list of your logfiles. Additionally, with the NAME parameter, you can filter to a specific logfile group name (e.g. 'Daemon') to only show that logfiles.

To give parameters to the function, use an associative array with named parameters.

Parameter

Case sensitivity

All parameter names are case-sensitive and written in capital letters.

Calling loglist_html in a plugin without parameters will return the html with all logs of the current plugin (=package).  

ParameterOptionalUsage
NAMEx

NAME is the log group name used with LoxBerry::Log/LBLog. If you have created a logfile with LBLog::newlog( [ name => 'Daemon' ]), use NAME => 'Daemon' to list only logfiles of that group.

If you omit the NAME parameter, the list includes all logfiles of your plugin, independent of the log group name.

PACKAGEx

Package is not required in the case of a plugin. By default, this is the $lbpplugindir-Variable.

Core-Developers have to use the PACKAGE parameter.

Return value

Returns a string that is the HTML code of the logfile list. Print the result of the function to your webpage.

Returns FALSE, if the call failed.

Usage

require_once "loxberry_web.php";
 
$html = LBWeb::loglist_html ( [ NAME => 'daemon' ] );
echo $html;


# Core-developers: Also use the PACKAGE parameter
$html = LBWeb::loglist_html ( [ PACKAGE => 'Plugins Update', NAME => 'check' ] );
echo $html;




  • No labels