Zum Ende der Metadaten springen
Zum Anfang der Metadaten

$url = LoxBerry::Web::loglist_url( %params );

 

Returns the URL to use as link to the loglist webpage of all the plugins logfiles. Using the NAME parameter filters to a specific NAME group (e.g. LoxBerry::Log (name => 'Daemon').

LoxBerry Compatibility

This function is available starting with LoxBerry V1.2.1. 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 without these LoxBerry SDK modules.

The function returns a string that is the link URL to the loglist webpage, listing all logfiles of your plugin. 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 named parameters.

Parameter

Case sensitivity

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

ParameterOptionalUsage
NAMEx

NAME is the log group name used with LoxBerry::Log. If you have created a logfile with LoxBerry::Log::new( 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 (like with LoxBerry::Log) the $lbpplugindir-Variable.

Core-Developers have to use the PACKAGE parameter.

Return value

Returns a string that is the HTML code for the Logfile button. Simply print the result of the function to your webpage.

Returns undef, if the call failed.

Usage

use LoxBerry::Web;
 
my $url = LoxBerry::Web::loglist_url ( NAME => 'daemon' );
print "<a href='$url'>To my logfiles</a>";



# Core-developers: Also use the PACKAGE parameter
my $url = LoxBerry::Web::loglist_url( PACKAGE => 'Plugins Update', NAME => 'check' );
print "<a href='$url'>Check logs of Plugins Update</a>";




  • Keine Stichwörter