dbxApi Class Reference

Zentrale Laufzeit-API von dbXapp. More...

Inheritance diagram for dbxApi:

Public Member Functions
	get_current_owner ()
	Liefert das aktuell aktive Owner-Objekt.
	run_owner ($owner, string $method='run',... $args)
	Fuehrt eine Methode in einem Owner-Kontext aus.
	get_system_obj (string $class, string $use='')
	Laedt ein Systemobjekt aus dbx/include und bevorzugt den myX-Override.
	editor_file_path (string $file)
	Liefert einen projekt-relativen Dateipfad fuer Editor-Marker.
	register_editor_file (string $kind, string $file)
	Registriert eine im aktuellen Request genutzte Editor-Datei.
	get_editor_files ()
	Liefert die im aktuellen Request registrierten Editor-Dateien.
	editor_marker (string $kind, string $file)
	Erzeugt einen HTML-Kommentar fuer den Frontend-Dateieditor.
	get_modul_obj (string $class)
	Laedt und startet den Kontext fuer ein Hauptmodul.
	get_include_obj (string $class, string $modul='', string $use='')
	Laedt eine Include-Klasse aus einem Modul.
	use_system_class ($class)
	Bindet eine Systemklasse aus dbx/include ein, ohne ein Objekt zu erzeugen.
	get_system_var (string $varname, $default='', string $rules=' *')
	Liest eine globale Systemvariable des aktuellen Requests.
	set_system_var (string $varname, $value)
	Setzt eine globale Systemvariable fuer den aktuellen Request.
	get_modul_var ($varname, $default='', $rules='alphanum')
	Liest eine Variable der aktuell aktiven Modulinstanz.
	set_modul_var ($varname, $value=null, $check_protected=true)
	Setzt eine Variable der aktuell aktiven Modulinstanz.
	get_request_var (string $varname, $default='', string $rules='parameter')
	Liest GET/POST über die Request-Systemklasse und validiert den Wert.
	get_config (string $modul='dbx', string $key='', $default=null)
	Laedt die Konfiguration eines Moduls.

Public Attributes
array	$editor_files = array()
	Dateien, die im aktuellen Request fuer den Editor markiert werden.

Detailed Description

Zentrale Laufzeit-API von dbXapp.

Diese Klasse ersetzt die frueher breit genutzten globalen dbx_*-Funktionen. Anwendungscode soll ueber die globale Singleton-Funktion dbx() arbeiten:

Beispiel:

$db = dbx()->get_system_obj('dbxDB');
$value = dbx()->get_request_var('dbx_run1', 'run');
dbx()->set_system_var('dbx_ajax', 1);

Wirkung:

• Systemobjekte werden zentral geladen und gecacht.
• Projektweite myX-Overrides werden automatisch bevorzugt.
• Request-, System-, Modul- und Sessionzustand bleiben an einer API gebuendelt.

Definition at line 39 of file dbxApi.php.

Member Function Documentation

editor_file_path()

dbxApi::editor_file_path

(

string

$file

)

Liefert einen projekt-relativen Dateipfad fuer Editor-Marker.

Parameters

string

$file

Absoluter oder relativer Dateipfad.

Returns

string Projekt-relativer Pfad.

Definition at line 215 of file dbxApi.php.

References $base, and $file.

editor_marker()

dbxApi::editor_marker	(	string	$kind,
		string	$file )

Erzeugt einen HTML-Kommentar fuer den Frontend-Dateieditor.

Die Marker werden nur im passenden dbx_edit-Modus ausgegeben:

• 4 = FD
• 5 = DD
• 6 = Modul-/Include-Class
• 7 = myX-Systemklasse
• 8 = config.php

Parameters

string	$kind	Marker-Typ: fd, dd, class, sysclass oder config.
string	$file	Absoluter oder projekt-relativer Dateipfad.

Returns

string HTML-Kommentar oder leerer String.

Definition at line 269 of file dbxApi.php.

References $file, $mode, and get_system_var().

get_config()

dbxApi::get_config	(	string	$modul = 'dbx',
		string	$key = '',
			$default = null )

Laedt die Konfiguration eines Moduls.

Beispiel:

$cache = dbx()->get_config('dbx', 'cache');
$config = dbx()->get_config('dbx');

Wirkung: Liest Modulkonfiguration aus Dateien/Cache und liefert entweder den kompletten Config-Array oder einen einzelnen Schluessel.

Parameters

string	$modul	Modulname.
string	$key	Optionaler Config-Schluessel.
mixed	$default	Rueckgabewert, wenn der Schluessel nicht existiert.

Returns

mixed

Definition at line 620 of file dbxApi.php.

References $_SESSION, $config, get_base_dir(), os_path(), and register_editor_file().

get_current_owner()

dbxApi::get_current_owner

(

)

Liefert das aktuell aktive Owner-Objekt.

Returns

object|null

Definition at line 112 of file dbxApi.php.

get_editor_files()

dbxApi::get_editor_files

(

)

Liefert die im aktuellen Request registrierten Editor-Dateien.

Returns

array

Definition at line 251 of file dbxApi.php.

get_include_obj()

dbxApi::get_include_obj	(	string	$class,
		string	$modul = '',
		string	$use = '' )

Laedt eine Include-Klasse aus einem Modul.

Beispiel:

$list = dbx()->get_include_obj('user_list', 'dbxUser_admin');
echo $list->run();

Wirkung:

• setzt die Systemvariable dbx_inc,
• nutzt ohne Modulparameter das aktuell aktive Modul,
• laedt dbx/modules/<modul>/include/<class>.class.php.

Parameters

string	$class	Include-Klassenname ohne .class.php.
string	$modul	Optionales Modul; leer bedeutet aktives Modul.
string	$use	Wenn gesetzt, wird nur geladen, aber nicht instanziert.

Returns

object|null Instanz der Include-Klasse oder null im Nur-Laden-Modus.

Exceptions

Exception

Wenn die Klasse nicht geladen werden kann.

Definition at line 370 of file dbxApi.php.

References $class, get_system_var(), and if.

get_modul_obj()

dbxApi::get_modul_obj

(

string

$class

)

Laedt und startet den Kontext fuer ein Hauptmodul.

Wirkung:

• erhoeht die aktive Modulinstanz-ID,
• setzt dbx_activ_modul und dbx_modul,
• laedt dbx/modules/<modul>/<modul>.class.php,
• erzeugt die Modulklasse im Namespace \dbx<modul><modul>.

Beispiel:

$modul = dbx()->get_modul_obj('dbxAdmin');
echo $modul->run();

Parameters

string

$class

Modulname.

Returns

object Instanz der Modulklasse.

Exceptions

Exception

Wenn die Modulklasse nicht geladen werden kann.

Definition at line 303 of file dbxApi.php.

References $class, get_system_var(), set_modul_var(), and set_system_var().

get_modul_var()

dbxApi::get_modul_var	(		$varname,
			$default = '',
			$rules = 'alphanum' )

Liest eine Variable der aktuell aktiven Modulinstanz.

Modulvariablen sind an dbx_activ_modul und dbx_activ_modul_id gebunden. Dadurch koennen mehrere Modul-/Include-Laeufe eigene Werte behalten.

Beispiel:

$action = dbx()->get_modul_var('dbx_run1', 'run');

Parameters

string	$varname	Name der Modulvariable.
mixed	$default	Rueckgabe, wenn kein gueltiger Wert existiert.
string	$rules	Validierungsregel.

Returns

mixed Validierter Wert oder Default.

Definition at line 519 of file dbxApi.php.

References $_GET, $_POST, $_SESSION, $rules, $value, dbx_validate_var(), and get_system_var().

get_request_var()

dbxApi::get_request_var	(	string	$varname,
			$default = '',
		string	$rules = 'parameter' )

Liest GET/POST über die Request-Systemklasse und validiert den Wert.

Definition at line 598 of file dbxApi.php.

References $rules, and get_system_obj().

get_system_obj()

dbxApi::get_system_obj	(	string	$class,
		string	$use = '' )

Laedt ein Systemobjekt aus dbx/include und bevorzugt den myX-Override.

Wird z.B. dbxDB angefordert, erzeugt/laedt DBX bei Bedarf dbx/modules/myX/sysclass/myDB.class.php und instanziert myDB extends dbxDB. Das Objekt wird unter dem Originalnamen gecacht.

Beispiel:

$db = dbx()->get_system_obj('dbxDB');
echo get_class($db); // myDB, wenn der Override existiert

Parameters

string	$class	Originale Systemklasse, z.B. dbxDB oder dbxTPL.
string	$use	Wenn gesetzt, wird nur geladen, aber nicht instanziert.

Returns

object|null Instanz des myX-Overrides oder der Originalklasse.

Exceptions

Exception

Wenn die Zielklasse nicht geladen werden kann.

Reimplemented in dbxMissingLogTestApi.

Definition at line 166 of file dbxApi.php.

References $_dbxCache, and $class.

Referenced by get_request_var().

get_system_var()

dbxApi::get_system_var	(	string	$varname,
			$default = '',
		string	$rules = '*' )

Liest eine globale Systemvariable des aktuellen Requests.

Systemvariablen beschreiben den Laufkontext, z.B. aktives Modul, Design, Sprache, Ajax-Status oder URLs. GET/POST kann den Wert liefern, wenn noch kein Sessionwert existiert.

Beispiel:

$ajax = dbx()->get_system_var('dbx_ajax', 0, 'int');

Parameters

string	$varname	Name der Systemvariable.
mixed	$default	Rueckgabe, wenn kein gueltiger Wert existiert.
string	$rules	Validierungsregel fuer dbx_validate_var().

Returns

mixed Validierter Wert oder Default.

Definition at line 454 of file dbxApi.php.

References $_GET, $_POST, $_SESSION, $rules, $value, and dbx_validate_var().

Referenced by editor_marker(), get_include_obj(), get_modul_obj(), get_modul_var(), and set_modul_var().

register_editor_file()

dbxApi::register_editor_file	(	string	$kind,
		string	$file )

Registriert eine im aktuellen Request genutzte Editor-Datei.

Parameters

string	$kind	Marker-Typ: fd, dd, class, sysclass oder config.
string	$file	Absoluter oder projekt-relativer Dateipfad.

Returns

void

Definition at line 233 of file dbxApi.php.

References $file.

Referenced by get_config().

run_owner()

dbxApi::run_owner	(		$owner,
		string	$method = 'run',
			... )

Fuehrt eine Methode in einem Owner-Kontext aus.

Beispiel:

$modul = dbx()->get_modul_obj('dbxAdmin');
echo dbx()->run_owner($modul, 'run', 'dashboard');

Parameters

object	$owner	Objekt, das ausgefuehrt wird.
string	$method	Methodenname, normalerweise run.
mixed	$args	Argumente fuer die Methode.

Returns

mixed|null Rueckgabe der Methode oder null.

Definition at line 134 of file dbxApi.php.

References $method, and $owner.

set_modul_var()

dbxApi::set_modul_var	(		$varname,
			$value = null,
			$check_protected = true )

Setzt eine Variable der aktuell aktiven Modulinstanz.

Beispiel:

dbx()->set_modul_var('dbx_run2', 'edit');

Wirkung: Schreibt in den modulinstanzbezogenen Sessionbereich. Geschuetzte Modulvariablen werden standardmaessig nicht ueberschrieben.

Parameters

string	$varname	Name der Modulvariable.
mixed	$value	Neuer Wert.
bool	$check_protected	Schutzliste beachten.

Returns

void

Definition at line 569 of file dbxApi.php.

References $_SESSION, $value, dbx(), and get_system_var().

Referenced by get_modul_obj().

set_system_var()

dbxApi::set_system_var	(	string	$varname,
			$value )

Setzt eine globale Systemvariable fuer den aktuellen Request.

Beispiel:

dbx()->set_system_var('dbx_design', 'admin');

Wirkung: Veraendert den globalen Laufkontext in $_SESSION['dbx']['tmp'][0]['dbx'].

Parameters

string	$varname	Name der Systemvariable.
mixed	$value	Neuer Wert.

Returns

void

Definition at line 498 of file dbxApi.php.

References $_SESSION, and $value.

Referenced by get_modul_obj().

use_system_class()

dbxApi::use_system_class

(

$class

)

Bindet eine Systemklasse aus dbx/include ein, ohne ein Objekt zu erzeugen.

Beispiel:

dbx()->use_system_class('dbxValidator');

Parameters

string

$class

Systemklasse ohne .class.php.

Returns

void

Definition at line 426 of file dbxApi.php.

References $class, get_base_dir(), and os_path().

Member Data Documentation

$editor_files

array dbxApi::$editor_files = array()

Dateien, die im aktuellen Request fuer den Editor markiert werden.

Definition at line 42 of file dbxApi.php.

---

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

• dbxApi.php