Zum Ende der Metadaten springen
Zum Anfang der Metadaten

Einbindung

use LoxBerry::Web;

Das Modul inkludiert automatisch die Module:

  • LoxBerry::System
  • HTML::Template
  • und implizit über LoxBerry::System
    • Config::Simple
    • URI::Escape

Befehle dieser Module können im Code direkt verwendet werden, ohne diese zusätzlich über use xxx einzubinden. Es tritt kein Fehler auf, wenn die Module trotzdem eingebunden werden. 

Globale Variablen

VariableVerwendung
$lbpluginpage
URI der LoxBerry Plugin Übersichtsseite - soll verwendet werden, wenn ein Plugin dort hin zurück linkt
$lbsystempageURI der LoxBerry System Übersichtsseite - soll verwendet werden, wenn ein Plugin dort hin linkt

Funktionen

Funktionen zum Erstellen des Templates

In diesem Artikel ist beschrieben, wie mit LoxBerry::Web die Webseite mit dem LoxBerry-Template aufgebaut wird. Neue Plugins in Perl sollten diese Methode verwenden.

LoxBerry::Web::foot

Gibt direkt das Ende der HTML-Seite aus. Siehe Funktionen zum Erstellen des Templates

LoxBerry::Web::get_plugin_icon

Damit wird die URL des Plugin-Icons in der gewünschten Größe zurückgegeben.

LoxBerry::Web::head

Gibt direkt den <head> Teil des Templates aus. Siehe Funktionen zum Erstellen des Templates

LoxBerry::Web::iso_languages

Diese Funktion gibt entweder alle verfügbaren, oder alle Sprachen nach ISO-639-1 aus, wahlweise als Array oder Hash.

LoxBerry::Web::lbfooter

Abkürzung für pageend und foot. Gibt direkt das pageend und den foot des Templates aus. Siehe Funktionen zum Erstellen des Templates

LoxBerry::Web::lbheader

Abkürzung für head und pagestart. Gibt direkt den head und einen pagestart des Templates aus. Siehe Funktionen zum Erstellen des Templates

LoxBerry::Web::logfile_button_html

Returns HTML code for a logfile button. This function accepts parameters from LoxBerry::Log to open the lastest logfile, and also directly a logfile name.

LoxBerry::Web::loglevel_select_html

Returns ready HTML code for the plugin loglevel dropdown list. The loglevel setting of the html is saved in the LoxBerry plugin database, therefore this is the same selection as in the plugin management.

LoxBerry::Web::loglist_button_html

Returns HTML code for a button to a webpage with all logfiles of your plugin. This function lists all logfiles of your plugin, and additionally accepts the NAME parameter from LoxBerry::Log to filter to a specific log group name.

LoxBerry::Web::loglist_html

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 as ever you like. .

LoxBerry::Web::loglist_url

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::Web::mslist_select_html

Returns ready HTML code for a Miniserver dropdown list. You can pre-select the current configured Miniserver from a config file.

LoxBerry::Web::pageend

Gibt direkt das Ende einer jQuery Mobile Page aus. Siehe Funktionen zum Erstellen des Templates

LoxBerry::Web::pagestart

Gibt direkt den Start einer jQuery Mobile Page aus. Siehe Funktionen zum Erstellen des Templates

Navigation Bar (Perl)

Bei Verwendung von Perl LoxBerry::Web::pagestart und LoxBerry::Web::lbheader bzw. PHP LBWeb::pagestart und LBWeb::lbheader kann oben, unterhalb der Titelzeile, eine Navigation Bar eingeblendet werden. Damit kann man beispielsweise innerhalb des Plugins über mehrere Einstellungsseiten navigieren. Es können auch Notification Bullets eingeblendet werden.

Debugging

To debug the module, use that code in your program:

$LoxBerry::Web::DEBUG = 1;

This will send debugging messages to STDERR.

  • Keine Stichwörter