Gemeinsame Basisklasse fuer dbXapp-System-, Modul- und Include-Objekte. More...

Inheritance diagram for dbxObj:

Public Member Functions
	set_callback_owner ($owner)
	Setzt ein explizites Owner-Objekt fuer Callback-Aufrufe.
	set_callback_id (string $id)
	Setzt den Namenspraefix fuer 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')
	Loescht eine Objekt- oder Session-Property.
	dbx_next_process ($content, $process='', $mode='append')
	Fuegt den naechsten dbxProcess-Schritt in eine Ausgabe ein.

Public Attributes
Public	$_properties =array()
Public	$_section =''
Public	$_process =''

Protected Member Functions
	normalize_callback_id (string $id)
	Normalisiert Callback-IDs auf gueltige PHP-Methodenbestandteile.
	get_callback_name (string $event)
	Liefert den Methodennamen fuer ein Event.
	get_callback_owner ()
	Liefert das aktuelle Owner-Objekt fuer Callback-Aufrufe.
	callback (string $event, mixed $value)
	Fuehrt einen Callback aus und gibt dessen Rueckgabewert zurueck.

Protected Attributes
	$_callback_owner = null
	$_callback_id = ''
	$_callbacks = array()

Detailed Description

Gemeinsame Basisklasse fuer dbXapp-System-, Modul- und Include-Objekte.

Regressionstest für den dbxTPL-Rohcache.

Sinn:

einfacher objektlokaler Property-Speicher
optionaler Session-Property-Speicher ueber Sections
einheitliches Callback-Modell fuer Form/Report/Module
Einhaengepunkt fuer laufende dbxProcess-Ausgaben

Beispiel:

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

Der Test stellt sicher, dass DBX-Systemvariablen nicht in den Session-Cache eingebrannt werden. Ein bereits gecachtes Template muss deshalb bei einer Änderung des aktiven Designs im selben Request den neuen Wert ausgeben.

Definition at line 63 of file dbxKernel.php.

Member Function Documentation

◆ callback()

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

protected

Fuehrt einen Callback aus und gibt dessen Rueckgabewert zurueck.

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

Parameters

string	$event	Eventname.
mixed	$value	Eingangswert.

Returns: mixed Callback-Ergebnis oder unveraenderter Eingangswert.

Definition at line 191 of file dbxKernel.php.

References $value, and get_callback_name().

Referenced by dbxForm\forward_init(), dbxForm\forward_run(), dbxForm\forward_submit(), dbxReport\get_table_row_action_data(), dbxReport\run_body(), dbxReport\run_footer(), dbxReport\run_haeder(), dbxReport\run_page_footer(), dbxReport\run_page_haeder(), dbxReport\run_report_footer(), and dbxReport\run_report_haeder().

◆ dbx_next_process()

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

Fuegt den naechsten dbxProcess-Schritt in eine Ausgabe ein.

Sinnvoll fuer laengere Prozessablaeufe, deren Fortschritt in mehreren Requests oder UI-Aktualisierungen dargestellt wird.

Parameters

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

Returns: string Inhalt mit Prozessausgabe.

Definition at line 319 of file dbxKernel.php.

References $content, $mode, and $process.

◆ del_property()

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

Loescht eine Objekt- oder Session-Property.

Mit $name = '*' werden alle objektlokalen Properties geloescht.

Parameters

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

Returns: void

Definition at line 293 of file dbxKernel.php.

Referenced by dbxCSVreader\clear(), dbxFileWalker\clear(), and dbxProcess\clear().

◆ get_callback_name()

dbxObj::get_callback_name ( string $event )

protected

Liefert den Methodennamen fuer ein Event.

Prioritaet: explizites Mapping ueber set_callback(), danach Konvention aus Callback-ID und Event.

Parameters

string $event Eventname.

Returns: string Methodenname oder leerer String.

Definition at line 144 of file dbxKernel.php.

References if.

Referenced by callback().

◆ get_callback_owner()

dbxObj::get_callback_owner ( )

protected

Liefert das aktuelle Owner-Objekt fuer Callback-Aufrufe.

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

Returns: object|null

Definition at line 168 of file dbxKernel.php.

◆ get_property()

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

Liest eine Objekt- oder Session-Property.

Parameters

string	$name	Property-Name.
mixed	$default	Rueckgabe, wenn kein Wert existiert.
string	$section	Optionaler Session-Bereich.
string	$modul	Modulkontext oder modul fuer aktuelles Modul.

Returns: mixed Gespeicherter Wert oder Default.

Definition at line 266 of file dbxKernel.php.

References $value.

Referenced by dbxProcess\add(), dbxFileWalker\archiv(), dbxFileWalker\clear(), dbxFileWalker\create_que(), dbx\dbxContent_admin\dbxContent_view\dbxView_run(), dbxView\dbxView_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(), and dbxProcess\run().

◆ normalize_callback_id()

dbxObj::normalize_callback_id ( string $id )

protected

Normalisiert Callback-IDs auf gueltige PHP-Methodenbestandteile.

Parameters

string $id Roh-ID.

Returns: string Normalisierte ID.

Definition at line 124 of file dbxKernel.php.

Referenced by 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');

$form

Definition dbxActionTokenAutomation_test.php:260

Parameters

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

Returns: void

Definition at line 112 of file dbxKernel.php.

References if.

Referenced by 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(), and dbxForm\set_submit_callback().

◆ set_callback_id()

dbxObj::set_callback_id ( string $id )

Setzt den Namenspraefix fuer konventionelle Callback-Methoden.

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

Parameters

string $id Callback-Praefix.

Returns: void

Definition at line 96 of file dbxKernel.php.

References normalize_callback_id().

Referenced by dbxForm\forward_init(), and dbxReport\init().

◆ set_callback_owner()

dbxObj::set_callback_owner ( $owner )

Setzt ein explizites Owner-Objekt fuer Callback-Aufrufe.

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

Parameters

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

Returns: void

Reimplemented in dbxReport.

Definition at line 82 of file dbxKernel.php.

References $owner, and if.

Referenced by dbxForm\forward_init(), and 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 ueber die zentrale Session-API gespeichert und kann requestuebergreifend genutzt werden.

Beispiel:

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

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

Parameters

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

Returns: void

Definition at line 246 of file dbxKernel.php.

References $value.

Referenced by dbxProcess\add(), dbxFileWalker\clear(), dbxFileWalker\create_que(), dbxView\dbxView_init(), dbxFileWalker\filewalker(), dbxCSVreader\import(), dbxSQLreader\import(), dbxCSVreader\init(), dbxFileWalker\init(), dbxProcess\process(), and dbx\dbxContent_admin\dbxContent_view\run().

Member Data Documentation

◆ $_callback_id

dbxObj::$_callback_id = ''

protected

Definition at line 69 of file dbxKernel.php.

◆ $_callback_owner

dbxObj::$_callback_owner = null

protected

Definition at line 68 of file dbxKernel.php.

◆ $_callbacks

dbxObj::$_callbacks = array()

protected

Definition at line 70 of file dbxKernel.php.

◆ $_process

Public dbxObj::$_process =''

Definition at line 67 of file dbxKernel.php.

◆ $_properties

Public dbxObj::$_properties =array()

Definition at line 65 of file dbxKernel.php.

◆ $_section

Public dbxObj::$_section =''

Definition at line 66 of file dbxKernel.php.

Referenced by dbxCSVreader\clear(), dbxFileWalker\clear(), dbxProcess\clear(), dbx\dbxAdmin\dd_export\export(), dbx\dbxAdmin\dd_import\import(), dbxProcess\process(), and dbxProcess\run().

The documentation for this class was generated from the following file:

dbxKernel.php

	dbxapp 4.1.3 CMS, Shop, Workflows und modulare Geschäftsanwendungen dbxapp.de

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ 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()

Member Data Documentation

◆ $_callback_id

◆ $_callback_owner

◆ $_callbacks

◆ $_process

◆ $_properties

◆ $_section