dbxapp 4.5.3
Technische API-Referenz der dbxapp-Plattform
Lade ...
Suche ...
Keine Treffer
dbx\dbxHelp\dbxModuleHelp Klassenreferenz

Konventionsbasierte, modulautonome Kontexthilfe. Mehr ...

Öffentliche Methoden

 context (string $module='', string $run1='', string $run2='')
 Liefert den bereinigten Hilfe-Kontext der aktuellen oder angegebenen Route.
 candidates (string $module='', string $run1='', string $run2='')
 Kandidaten in fester, dokumentierter Reihenfolge.
 template_name (string $module='', string $run1='', string $run2='')
 Ermittelt das tatsächlich vorhandene Template, ohne es zu rendern.
 has (string $module='', string $run1='', string $run2='')
 render (string $module='', string $run1='', string $run2='', array $data=array())
 url (string $module='', string $run1='', string $run2='', string $title='')
 button (string $module='', string $run1='', string $run2='', string $title='')
 form_url (string $module, string $form, string $title='')
 form_button (string $module, string $form, string $title='')
 module_bar_template_data (string $run1='', string $actions_html='', string $title='', string $icon='', string $subtitle='', string $module='', string $run2='')
 render_module_bar (string $run1='', string $actions_html='', string $title='', string $icon='', string $subtitle='', string $module='', string $run2='')
 help_window_bar_template_data (string $module, string $run1='', string $run2='', string $title='')
 form_help_window_bar_template_data (string $title='')
 vars (string $run1='', string $run2='', string $module='')
 attach_form ($form, string $run1='', string $run2='', string $module='')
 run ()

Ausführliche Beschreibung

Konventionsbasierte, modulautonome Kontexthilfe.

Ein Modul braucht nur noch Templates unter tpl/help: <run1>–<run2>.htm -> <run1>.htm -> modul.htm Die Standardaktionen '', run, start und show verwenden direkt modul.htm. Es gibt bewusst weder ein zentrales Topic-Verzeichnis noch Modul-Manifeste.

Dokumentation der Elementfunktionen

◆ attach_form()

dbx\dbxHelp\dbxModuleHelp::attach_form ( $form,
string $run1 = '',
string $run2 = '',
string $module = '' )

Benutzt if.

◆ button()

dbx\dbxHelp\dbxModuleHelp::button ( string $module = '',
string $run1 = '',
string $run2 = '',
string $title = '' )

Benutzt context() und has().

◆ candidates()

dbx\dbxHelp\dbxModuleHelp::candidates ( string $module = '',
string $run1 = '',
string $run2 = '' )

Kandidaten in fester, dokumentierter Reihenfolge.

Benutzt context().

◆ context()

dbx\dbxHelp\dbxModuleHelp::context ( string $module = '',
string $run1 = '',
string $run2 = '' )

Liefert den bereinigten Hilfe-Kontext der aktuellen oder angegebenen Route.

Wird benutzt von button(), candidates(), help_window_bar_template_data(), module_bar_template_data(), render(), template_name() und url().

◆ form_button()

dbx\dbxHelp\dbxModuleHelp::form_button ( string $module,
string $form,
string $title = '' )

◆ form_help_window_bar_template_data()

dbx\dbxHelp\dbxModuleHelp::form_help_window_bar_template_data ( string $title = '')

◆ form_url()

dbx\dbxHelp\dbxModuleHelp::form_url ( string $module,
string $form,
string $title = '' )

◆ has()

dbx\dbxHelp\dbxModuleHelp::has ( string $module = '',
string $run1 = '',
string $run2 = '' )

Benutzt template_name().

Wird benutzt von button() und module_bar_template_data().

◆ help_window_bar_template_data()

dbx\dbxHelp\dbxModuleHelp::help_window_bar_template_data ( string $module,
string $run1 = '',
string $run2 = '',
string $title = '' )

Benutzt context().

◆ module_bar_template_data()

dbx\dbxHelp\dbxModuleHelp::module_bar_template_data ( string $run1 = '',
string $actions_html = '',
string $title = '',
string $icon = '',
string $subtitle = '',
string $module = '',
string $run2 = '' )

Benutzt context() und has().

Wird benutzt von render_module_bar() und vars().

◆ render()

dbx\dbxHelp\dbxModuleHelp::render ( string $module = '',
string $run1 = '',
string $run2 = '',
array $data = array() )

Benutzt context() und template_name().

◆ render_module_bar()

dbx\dbxHelp\dbxModuleHelp::render_module_bar ( string $run1 = '',
string $actions_html = '',
string $title = '',
string $icon = '',
string $subtitle = '',
string $module = '',
string $run2 = '' )

Benutzt module_bar_template_data().

◆ run()

dbx\dbxHelp\dbxModuleHelp::run ( )

◆ template_name()

dbx\dbxHelp\dbxModuleHelp::template_name ( string $module = '',
string $run1 = '',
string $run2 = '' )

Ermittelt das tatsächlich vorhandene Template, ohne es zu rendern.

Benutzt context().

Wird benutzt von has() und render().

◆ url()

dbx\dbxHelp\dbxModuleHelp::url ( string $module = '',
string $run1 = '',
string $run2 = '',
string $title = '' )

Benutzt context().

◆ vars()

dbx\dbxHelp\dbxModuleHelp::vars ( string $run1 = '',
string $run2 = '',
string $module = '' )

Benutzt module_bar_template_data().

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: