Gemeinsame Basisklasse für dbxapp-System-, Modul- und Include-Objekte. Mehr ...

Klassendiagramm für dbxObj:

Öffentliche Methoden
	set_callback_owner ($owner)
	Setzt ein explizites Owner-Objekt für Callback-Aufrufe.
	set_callback_id (string $id)
	Setzt den Namenspräfix für konventionelle Callback-Methoden.
	set_callback (string $event, string $callback)
	Ordnet einem Event einen konkreten Methodennamen zu.
	set_property ($name, $value, $section='', $modul='modul')
	Speichert eine Objekt- oder Session-Property.
	get_property ($name, $default='', $section='', $modul='modul')
	Liest eine Objekt- oder Session-Property.
	del_property ($name, $section='', $modul='modul')
	Löscht eine Objekt- oder Session-Property.
	dbx_next_process ($content, $process='', $mode='append')
	Fügt den nächsten dbxProcess-Schritt in eine Ausgabe ein.

Öffentliche Attribute
Public	$_properties =array()
Public	$_section =''
Public	$_process =''

Geschützte Methoden
	normalize_callback_id (string $id)
	Normalisiert Callback-IDs auf gültige PHP-Methodenbestandteile.
	get_callback_name (string $event)
	Liefert den Methodennamen für ein Event.
	get_callback_owner ()
	Liefert das aktuelle Owner-Objekt für Callback-Aufrufe.
	callback (string $event, mixed $value)
	Führt einen Callback aus und gibt dessen Rückgabewert zurück.

Geschützte Attribute
	$_callback_owner = null
	$_callback_id = ''
	$_callbacks = array()

Ausführliche Beschreibung

Gemeinsame Basisklasse für dbxapp-System-, Modul- und Include-Objekte.

Sinn:

einfacher objektlokaler Property-Speicher
optionaler Session-Property-Speicher über Sections
einheitliches Callback-Modell für Form/Report/Module
Einhängepunkt für laufende dbxProcess-Ausgaben

Beispiel:

$obj = new dbxObj();
$obj->set_property('tab', 'details');
echo $obj->get_property('tab', 'main');

Dokumentation der Elementfunktionen

◆ callback()

dbxObj::callback	(	string	$event,
		mixed	$value )

protected

Führt einen Callback aus und gibt dessen Rückgabewert zurück.

Falls kein Callback existiert oder nicht aufrufbar ist, bleibt der Eingangswert unverändert. Callback-Methoden erhalten immer ($this, $value).

Parameter

string	$event	Eventname.
mixed	$value	Eingangswert.

Rückgabe: mixed Callback-Ergebnis oder unveränderter Eingangswert.

Benutzt get_callback_name().

Wird benutzt von dbxForm\forward_init(), dbxForm\forward_submit(), dbxReport\run_body(), dbxReport\run_footer(), dbxReport\run_header(), dbxReport\run_page_footer(), dbxReport\run_page_header(), dbxReport\run_report_footer() und dbxReport\run_report_header().

◆ dbx_next_process()

dbxObj::dbx_next_process	(	$content,
		$process = '',
		$mode = 'append' )

Fügt den nächsten dbxProcess-Schritt in eine Ausgabe ein.

Sinnvoll für längere Prozessabläufe, deren Fortschritt in mehreren Requests oder UI-Aktualisierungen dargestellt wird.

Parameter

string	$content	Vorhandener Inhalt.
string	$process	Prozess-ID; leer liest dbx_process aus der Session.
string	$mode	append\|insert\|replace.

Rückgabe: string Inhalt mit Prozessausgabe.

◆ del_property()

dbxObj::del_property	(	$name,
		$section = '',
		$modul = 'modul' )

Löscht eine Objekt- oder Session-Property.

Mit $name = '*' werden alle objektlokalen Properties gelöscht.

Parameter

string	$name	Property-Name oder *.
string	$section	Optionaler Session-Bereich.
string	$modul	Modulkontext oder modul für aktuelles Modul.

Rückgabe: void

Wird benutzt von dbxCSVreader\clear(), dbxFileWalker\clear() und dbxProcess\clear().

◆ get_callback_name()

dbxObj::get_callback_name ( string $event )

protected

Liefert den Methodennamen für ein Event.

Priorität: explizites Mapping über set_callback(), danach Konvention aus Callback-ID und Event.

Parameter

string $event Eventname.

Rückgabe: string Methodenname oder leerer String.

Benutzt if.

Wird benutzt von callback().

◆ get_callback_owner()

dbxObj::get_callback_owner ( )

protected

Liefert das aktuelle Owner-Objekt für Callback-Aufrufe.

Falls kein expliziter Owner gesetzt ist, wird der aktuelle Owner aus dbx()->get_current_owner() verwendet.

Rückgabe: object|null

◆ get_property()

dbxObj::get_property	(	$name,
		$default = '',
		$section = '',
		$modul = 'modul' )

Liest eine Objekt- oder Session-Property.

Parameter

string	$name	Property-Name.
mixed	$default	Rückgabe, wenn kein Wert existiert.
string	$section	Optionaler Session-Bereich.
string	$modul	Modulkontext oder modul für aktuelles Modul.

Rückgabe: mixed Gespeicherter Wert oder Default.

Wird benutzt von dbxProcess\add(), dbxFileWalker\archiv(), dbxFileWalker\clear(), dbxFileWalker\create_que(), dbx\dbxContent_admin\dbxContent_view\dbx_view_run(), dbxView\dbx_view_run(), dbxFileWalker\delete(), dbx\dbxAdmin\dd_export\export(), dbxFileWalker\filewalker(), dbxProcess\get_status(), dbx\dbxAdmin\dd_import\import(), dbxCSVreader\import(), dbxSQLreader\import(), dbxCSVreader\init(), dbxFileWalker\init(), dbxProcess\process() und dbxProcess\run().

◆ normalize_callback_id()

dbxObj::normalize_callback_id ( string $id )

protected

Normalisiert Callback-IDs auf gültige PHP-Methodenbestandteile.

Parameter

string $id Roh-ID.

Rückgabe: string Normalisierte ID.

Benutzt $id.

Wird benutzt von set_callback_id().

◆ set_callback()

dbxObj::set_callback	(	string	$event,
		string	$callback )

Ordnet einem Event einen konkreten Methodennamen zu.

Beispiel:

$form->set_callback('run', 'render_user_form');

Parameter

string	$event	Fachlicher Eventname.
string	$callback	Methodenname auf dem Owner.

Rückgabe: void

Benutzt if.

Wird benutzt von dbxReport\set_body_callback(), dbxReport\set_footer_callback(), dbxReport\set_header_callback(), dbxForm\set_init_callback(), dbxReport\set_next_record_callback(), dbxReport\set_page_footer_callback(), dbxReport\set_page_header_callback(), dbxReport\set_report_footer_callback(), dbxReport\set_report_header_callback(), dbxForm\set_run_callback() und dbxForm\set_submit_callback().

◆ set_callback_id()

dbxObj::set_callback_id ( string $id )

Setzt den Namenspräfix für konventionelle Callback-Methoden.

Beispiel: Callback-ID user plus Event submit ergibt user_submit().

Parameter

string $id Callback-Präfix.

Rückgabe: void

Benutzt $id und normalize_callback_id().

Wird benutzt von dbxForm\forward_init() und dbxReport\init().

◆ set_callback_owner()

dbxObj::set_callback_owner ( $owner )

Setzt ein explizites Owner-Objekt für Callback-Aufrufe.

Wird vor allem genutzt, wenn Hilfsobjekte Methoden des aufrufenden Moduls aufrufen sollen, ohne selbst dessen Klasse zu kennen.

Parameter

object $owner Objekt, auf dem Callback-Methoden gesucht werden.

Rückgabe: void

Erneute Implementation in dbxReport.

Benutzt if.

Wird benutzt von dbxForm\forward_init() und dbxForm\set_form_callback_owner().

◆ set_property()

dbxObj::set_property	(	$name,
		$value,
		$section = '',
		$modul = 'modul' )

Speichert eine Objekt- oder Session-Property.

Ohne Section bleibt der Wert am Objekt. Mit Section wird er über die zentrale Session-API gespeichert und kann requestübergreifend genutzt werden.

Beispiel:

$obj->set_property('open_tab', 'settings');

$obj->set_property('page', 2, 'report-state');

Parameter

string	$name	Property-Name.
mixed	$value	Wert.
string	$section	Optionaler Session-Bereich.
string	$modul	Modulkontext oder modul für aktuelles Modul.

Rückgabe: void

Wird benutzt von dbxProcess\add(), dbxFileWalker\clear(), dbxFileWalker\create_que(), dbxView\dbx_view_init(), dbxFileWalker\filewalker(), dbxCSVreader\import(), dbxSQLreader\import(), dbxCSVreader\init(), dbxFileWalker\init(), dbxProcess\process() und dbx\dbxContent_admin\dbxContent_view\run().

Dokumentation der Datenelemente

◆ $_callback_id

dbxObj::$_callback_id = ''

protected

◆ $_callback_owner

dbxObj::$_callback_owner = null

protected

◆ $_callbacks

dbxObj::$_callbacks = array()

protected

◆ $_process

Public dbxObj::$_process =''

◆ $_properties

Public dbxObj::$_properties =array()

◆ $_section

Public dbxObj::$_section =''

Wird benutzt von dbxCSVreader\clear(), dbxFileWalker\clear(), dbxProcess\clear(), dbx\dbxAdmin\dd_export\export(), dbx\dbxAdmin\dd_import\import(), dbxProcess\process() und dbxProcess\run().

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

dbxapp/dbx/include/dbxKernel.php

Öffentliche Methoden

Öffentliche Attribute

Geschützte Methoden

Geschützte Attribute

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

◆ callback()

◆ dbx_next_process()

◆ del_property()

◆ get_callback_name()

◆ get_callback_owner()

◆ get_property()

◆ normalize_callback_id()

◆ set_callback()

◆ set_callback_id()

◆ set_callback_owner()

◆ set_property()

Dokumentation der Datenelemente

◆ $_callback_id

◆ $_callback_owner

◆ $_callbacks

◆ $_process

◆ $_properties

◆ $_section