dbxapp 4.1.3
CMS, Shop, Workflows und modulare Geschäftsanwendungen
Loading...
Searching...
No Matches
dbxApi.php File Reference

Zentrale Laufzeit-API und Kernel-Helfer. More...

Go to the source code of this file.

Classes

class  dbxApi
 Zentrale Laufzeit-API von dbXapp. More...

Functions

 dbx_log_missing_entry ($missing='')
 set_config (string $modul, array $config)
 Speichert die Konfiguration eines Moduls.
 set_local_config (string $modul, array $localConfig)
 Speichert die vollstaendige lokale Konfiguration eines Moduls.
 patch_local_config (string $modul, array $patch)
 Fuehrt einen lokalen Konfigurationsausschnitt rekursiv zusammen.
 set_local_config_section (string $modul, string $section, array $value)
 Ersetzt genau einen lokalen Konfigurationsbereich.
 send_mail ($from, $to, string $subject='', string $body='', string $format='html', $attachments=array(), array $options=array())
 Sendet eine E-Mail ueber dbxMail/PHPMailer.
 get_remember_var (string $varname, $default='', string $modul='modul')
 Liest einen Remember-Wert.
 set_remember_var (string $varname, $value, string $modul='modul')
 Setzt einen Remember-Wert.
 get_session_var ($key, $default=null, $section='sys', $modul='modul')
 Liest einen strukturierten Sessionwert.
 set_session_var ($key, $val, $section='sys', $modul='')
 Setzt einen strukturierten Sessionwert.
 delete_session_var ($key, $section='sys', $modul='modul')
 Loescht einen strukturierten Sessionwert oder eine ganze Ebene.
 action_token (string $scope='global')
 Liefert ein sessiongebundenes Token fuer zustandsaendernde Link-Aktionen.
 check_action_token (string $scope='global', string $token='')
 Prueft ein sessiongebundenes Aktions-Token.
 invalidate_action_tokens ()
 Verwirft alle Action-Tokens an einer Authentifizierungsgrenze.
 action_url (string $url, string $action='', array $bindings=array())
 Tokenisiert eine automatisch erkannte zustandsaendernde Route.
 user ($key='id')
 Liest einen Wert des aktuellen Benutzers.
 can ($access_groups='', $user_groups='')
 Prueft Gruppenrechte gegen den aktuellen oder uebergebenen Benutzer.
 has_group ($access_groups='', $user_groups='')
 is_dbx_edit ()
 Prueft, ob der Frontend-Edit-Modus aktiv ist (dbx_edit > 0).
 can_modul ($modul)
 Prueft den Zugriff auf ein Modul anhand seiner Konfiguration.
 login ($uid=0, $remember=0)
 Meldet einen Benutzer im DBX-Kontext an.
 get_base_url ()
 Liefert die Basis-URL des aktuellen Requests.
 get_self_url ()
 Liefert die Self-URL des aktuellen Requests.
 get_base_dir (int $cutData=0)
 Liefert das Basisverzeichnis der Installation.
 get_file_dir ()
 Liefert das files/-Verzeichnis der Installation.
 os_path (string $path)
 Normalisiert einen Pfad fuer das aktuelle Betriebssystem.
 config_path_store (string $path, bool $dirTrailingSlash=false)
 Speichert einen Installationspfad portabel relativ zum Projektstamm.
 config_path_resolve (string $path)
 Loest einen gespeicherten Projektpfad in einen Betriebssystempfad auf.
 error_log_file ()
 Liefert die zentrale PHP-Fehlerprotokolldatei.
 error_type (int $errno)
 Uebersetzt eine PHP-Fehlernummer in ihre symbolische Bezeichnung.
 write_php_error_log (string $type, string $message, string $file='', int $line=0)
 Schreibt einen PHP-Fehler mit Request-Kontext in das zentrale Protokoll.
 json_response (array $data, bool $withRuntime=false)
 Beendet den Request mit JSON-Ausgabe.
 timer ($section, $info='')
 Misst Laufzeiten fuer Debug/Analyse.
 get_design_skin_ids (string $design='')
 Liefert die Skin-IDs, die ein Design durch eigene skin-*.css-Dateien tatsaechlich bereitstellt.
 normalize_skin (string $skin='', string $design='')
 Normalisiert Skin-/Farbnamen auf gueltige Skin-IDs.
 get_skin ()
 Aktiver Skin aus Systemvariable dbx_color.
 get_skin_css ()
 CSS-Pfad zum aktiven Skin relativ zum Projektroot.
 get_skin_class ()
 Body-Klassen fuer den aktiven Skin.
 load_content_cache_classes ()
 Laedt die Content-Cache-Klassen einmalig fuer Frontend, CMS und Admin.
 get_content_permalink_mode ()
 Liefert den Permalink-Modus von dbxContent (content oder cms).
 log_missing ($missing='')
 Zaehlt einen fehlenden Pfad oder eine fehlende Ressource in dbxMissing.
 sys_msg ($status='', $about='', $rid='', $why='', $what='')
 Schreibt eine strukturierte Systemmeldung.
 norep ($norep, $i=0)
 Lagert HTML/Text in einen norep-Platzhalter aus.
 next_id (int $add=1)
 Erzeugt eine fortlaufende ID innerhalb des DBX-Kontexts.
 is_modul ($modul)
 Prueft, ob ein Modulverzeichnis existiert.
 is_design ($design, $page='default')
 Prueft, ob ein Design fuer die angegebene Seite existiert.
 redirect ($redirect, $timer=0)
 Sendet einen Redirect oder Meta-Refresh.
 set_cookie_var ($cookie, $key, $val)
 Setzt einen Wert in einem DBX-Cookie.
 has_text ($string, $find)
 Prueft, ob ein Text einen Suchbegriff enthaelt.
 html ($html)
 Bereitet HTML fuer die Ausgabe auf.
 esc ($value)
 Escaped einen Wert fuer HTML-Text und HTML-Attribute.
 search_defaults (array $overrides=array())
 Standard-Optionen fuer dbx|search (wie Content-Grid).
 timestamp ($add_sec=0)
 Liefert einen Unix-Timestamp mit optionalem Sekunden-Offset.
 time_diff ($starttime=0, $endtime=0)
 Berechnet eine Zeitdifferenz zwischen zwei Timestamps.
 part_select ($vor, $nach, $part)
 Schneidet einen Teil zwischen zwei Markern aus einem Text.
 parse_url ($data)
 Zerlegt URL-/Parameterdaten in einen Array.
 is_int_value ($value)
 Prueft, ob ein Wert als Integer verwendbar ist.
 new_password ($minlength, $special='-_!')
 Erzeugt ein neues Passwort.
 run_web_app_request ()
 Fuehrt den kompletten Frontcontroller-Ablauf aus und schreibt die Response.
 debug2 ($line)
 Schreibt eine einfache Debug-Zeile in files/dbxDebug2.txt.
 debug ($txt, $data1='', $data2='', $data3='')
 Schreibt Debug-Ausgaben in files/dbxDebug.txt, wenn Debug aktiv ist.
 dbx ()
 Liefert die zentrale dbXapp-API als Singleton.
 ge_stichtag ()
 Prueft einen projektspezifischen Stichtag.
 dbx_copy_recursive ($src, $dst)
 Kopiert ein komplettes Verzeichnis rekursiv.
 dbx_DateTime ($date_time='now', $calc=0, $special='')
 Liefert ein DBX-Datum/Zeit-Format mit optionalem Offset.
 dbx_make_dir (string $path)
 Erstellt ein Verzeichnis und alle notwendigen Unterverzeichnisse.
 dbx_sendMail ($from, $fromname, $to, $subject, $text, $type='html', $attach='', $archiv=0)
 Kompatibilitaetswrapper fuer dbx()->send_mail().
 dbx_is_page ($page, $design, $lng='')
 Prueft, ob ein historisches Template unter dbx/tpl/htm existiert.
 dbx_lng_current ()
 Lädt eine Klasse aus dem Cache oder erstellt eine neue Instanz der Klasse.
 dbx_accessible_lngs ()
 Konfigurierte Sprachen aus dbx-Config.
 dbx_lng_name (string $base, string $lng='')
 Sprachsuffix an Basisnamen haengen: content + de => content_de.
 dbx_lng_resolve_file (string $dir, string $name, string $ext, string $lng='', bool $fallback=true)
 Datei mit Sprachsuffix aufloesen: name_lng.ext mit Fallback name.ext.
 dbx_modul_translate ($content, $modul='', $lng='')
 Wendet die modulbezogene translate.php auf Inhalt an.
 dbx_replace_first ($search_str, $replacement_str, $src_str)
 Ersetzt das erste Vorkommen einer Zeichenfolge.
 dbx_convertArrayToPHPCode (array $array, string $prefix)
 Konvertiert ein Array in PHP-Code, der es rekonstruiert.
 dbx_convert_charset (string $in, string $charset, string $incharset='UTF-8')
 Lädt die Konfigurationsdaten eines Moduls aus einer Datei (verschlüsselt oder unverschlüsselt) und speichert sie im Session-Cache.
 dbx_add_modul (string $modul, string $action, string $work='')
 Erzeugt einen Modul-String im spezifischen Format mit den angegebenen Parametern.
 dbx_validate_var ($danger_value, $rules='parameter', $varname='undef')
 Validiert eine Eingabe basierend auf angegebenen Regeln.
 dbx_make_seed ()
 Holt und validiert eine POST-Variable.
 dbx_load_cookie ($cookie)
 Lädt einen JSON-Cookie in den dbxapp-Sessionbereich.
 dbx_save_cookie ($cookie, $hh=12)
 dbx_delete_cookie ($cookie)
 dbx_get_cookie_val ($cookie, $key, $default='')
 dbx_get_Date ($date, $io, $default='')
 Validates and formats a date string based on the input and output format.
 dbx_get_webDate ($date, $default='')
 dbx_get_phpDate ($date, $default='')
 dbx_get_webDateTime ($date_time, $default='')
 dbx_is_Login ()
 dbx_set_CurrentUser ($key, $value)
 Setzt einen Wert oder den gesamten aktuellen Benutzerkontext.
 dbx_is_decimal ($value)
 dbx_get_Today ($days=0)
 dbx_get_Microtime ()
 dbx_upload ()
 dbx_html2txt ($txt)
 dbx_txt2html ($txt)
 dbx_html2src ($html_in)
 dbx_interpreter ($content)
 dbx_decrypt ($content, $xkey='', $master='')
 Decrypts content using AES-128-CBC encryption.
 dbx_crypt ($content, $xkey='', $master='')
 Encrypts content using AES-128-CBC encryption.

Variables

Global $_dbxCache

Detailed Description

Zentrale Laufzeit-API und Kernel-Helfer.

Neue DBX-Entwicklung soll ueber dbx() und die Methoden von dbxApi laufen. Allgemeine Laufzeitfunktionen werden als Methoden dieser API bereitgestellt. Verbleibende globale Fachhelfer werden schrittweise auf dbx() umgestellt.

Definition in file dbxApi.php.

Function Documentation

◆ action_token()

action_token ( string $scope = 'global')

Liefert ein sessiongebundenes Token fuer zustandsaendernde Link-Aktionen.

Das Token wird aus einem einzigen Session-Secret und dem Scope abgeleitet. Dadurch koennen auch RID-spezifische Scopes verwendet werden, ohne fuer jede RID einen weiteren Sessioneintrag anzulegen.

Bestehende Aufrufe bleiben kompatibel:

$token = dbx()->action_token('myModule.delete.17');
DBX schema administration.

Modulcode nutzt stattdessen action_url(). Standardaktionen wie delete oder save werden zusammen mit rid direkt aus der URL erkannt; Scope und Transportparameter entstehen automatisch.

Parameters
string$scopeEindeutiger Aktionsbereich.
Returns
string Token.

Definition at line 1189 of file dbxApi.php.

References $scope.

Referenced by dbx\dbxKi\dbxKiCmsService\bundleExecuteToken().

◆ action_url()

action_url ( string $url,
string $action = '',
array $bindings = array() )

Tokenisiert eine automatisch erkannte zustandsaendernde Route.

Reine Navigation bleibt unveraendert. Nur wenn dbxWebApp fuer die URL eine Action-Policy findet (z.B. delete/save plus rid, eine Standardaktion von dbxReport oder eine kompatible Moduldefinition), wird dbx_token hinzugefuegt. Ein vorhandener Transportparameter wird dabei sicher ersetzt.

Mit $action und $bindings kann Kernel-/Komponentencode einen bereits bekannten Scope explizit aufbauen. Fachmodule verwenden im Normalfall nur die automatische Variante ohne diese Zusatzargumente.

Parameters
string$urlBestehende Modul-/Permalink-URL.
string$actionOptionaler kanonischer Aktionsname.
array$bindingsOptional gebundene Schluessel/Werte.
Returns
string Originale oder automatisch tokenisierte URL.
Examples
dbx/modules/myInvoices/include/myInvoicesService.class.php.

Definition at line 1270 of file dbxApi.php.

References $url, and $webApp.

Referenced by dbx\myInvoices\myInvoicesService\invoice_report_next_record(), dbx\dbxWorkflow\dbxWorkflowEngine\overview(), and dbx\dbxWorkflow\dbxWorkflowEngine\render().

◆ can()

can ( $access_groups = '',
$user_groups = '' )

Prueft Gruppenrechte gegen den aktuellen oder uebergebenen Benutzer.

Beispiel:

if (dbx()->can('admin')) { ... }
can($access_groups='', $user_groups='')
Prueft Gruppenrechte gegen den aktuellen oder uebergebenen Benutzer.
Definition dbxApi.php:1381
Parameters
string | array$access_groupsErforderliche Gruppen.
string | array$user_groupsOptional andere Benutzergruppen.
Returns
bool
Examples
dbx/modules/myInvoices/include/myInvoicesService.class.php.

Definition at line 1381 of file dbxApi.php.

References $_SESSION, and user().

Referenced by can_modul(), dbxDB\check_access(), has_group(), dbx\myInvoices\myInvoicesService\installation(), is_design(), dbx\dbxContent\dbxContentRenderer\renderStatic(), and dbx\dbxMenu\run().

◆ can_modul()

can_modul ( $modul)

Prueft den Zugriff auf ein Modul anhand seiner Konfiguration.

Parameters
string$modulModulname.
Returns
bool

Definition at line 1430 of file dbxApi.php.

References $_SESSION, $groups, and can().

◆ check_action_token()

check_action_token ( string $scope = 'global',
string $token = '' )

Prueft ein sessiongebundenes Aktions-Token.

Leere Tokens werden ohne Session-Schreibzugriff verworfen. Fuer bereits geoeffnete Seiten einer laufenden Session werden vor der Umstellung gespeicherte Scope-Tokens weiterhin akzeptiert. Neue Tokens verwenden ausschliesslich die konstante HMAC-Ablage.

Parameters
string$scopeEindeutiger Aktionsbereich.
string$tokenUebergebenes Token.
Returns
bool

Definition at line 1206 of file dbxApi.php.

References $scope, $token, and if.

Referenced by dbx\dbxKi\dbxKiCmsService\bundleCheckExecuteToken(), dbx\dbxContent_admin\dbxContent_cms\run(), and dbx\dbxWorkflow\dbxWorkflowEngine\start().

◆ config_path_resolve()

config_path_resolve ( string $path)

Loest einen gespeicherten Projektpfad in einen Betriebssystempfad auf.

Definition at line 1582 of file dbxApi.php.

References get_base_dir().

◆ config_path_store()

config_path_store ( string $path,
bool $dirTrailingSlash = false )

Speichert einen Installationspfad portabel relativ zum Projektstamm.

Definition at line 1561 of file dbxApi.php.

References $base.

◆ dbx()

dbx ( )

Liefert die zentrale dbXapp-API als Singleton.

Anwendungscode soll diesen Einstieg verwenden statt globaler dbx_*-Funktionen.

Beispiel:

dbx()->set_system_var('dbx_ajax', 1);
$tpl = dbx()->get_system_obj('dbxTPL');
if($web->content_permalink_redirect_target() !=='') $tpl
Returns
dbxApi Zentrale API-Instanz.

Definition at line 2805 of file dbxApi.php.

References $api.

Referenced by dbx_copy_recursive(), dbx_crypt(), dbx_decrypt(), dbx_interpreter(), dbx_is_Login(), dbx_is_page(), dbx_log_missing_entry(), dbx_modul_translate(), dbx_sendMail(), dbx_upload(), login(), redirect(), dbxApi\set_modul_var(), and sys_msg().

◆ dbx_accessible_lngs()

dbx_accessible_lngs ( )

Konfigurierte Sprachen aus dbx-Config.

Returns
string[]

Definition at line 3048 of file dbxApi.php.

Referenced by dbx\dbxContent\dbxContentLngSync\accessibleLngs(), and dbxWebApp\check_perma().

◆ dbx_add_modul()

dbx_add_modul ( string $modul,
string $action,
string $work = '' )

Erzeugt einen Modul-String im spezifischen Format mit den angegebenen Parametern.

Diese Funktion erstellt einen String, der ein Modul mit seinen zugehörigen Parametern (Aktion und Arbeit) darstellt. Der resultierende String kann für Konfigurations-, Protokollierungs- oder andere Zwecke verwendet werden.

Parameters
string$modulDer Name des Moduls.
string$actionDie auszuführende Aktion im Modul.
string$work(Optional) Zusätzliche Arbeitsinformationen.
Returns
string Der generierte Modul-String im Format: [modul=<Modul>]dbx_run1=<Aktion>&dbx_run2=<Arbeit>[/modul]

Definition at line 3302 of file dbxApi.php.

References $content, and $work.

◆ dbx_convert_charset()

dbx_convert_charset ( string $in,
string $charset,
string $incharset = 'UTF-8' )

Lädt die Konfigurationsdaten eines Moduls aus einer Datei (verschlüsselt oder unverschlüsselt) und speichert sie im Session-Cache.

Diese Funktion:

  • Liest die Konfigurationsdatei des angegebenen Moduls.
  • Unterstützt verschlüsselte und unverschlüsselte Konfigurationsdateien.
  • Lädt die Konfiguration in den Session-Cache, um wiederholte Dateizugriffe zu vermeiden.
  • Gibt einen spezifischen Konfigurationswert oder die gesamte Konfiguration zurück.
Parameters
string$modulDer Modulname, dessen Konfiguration geladen werden soll. Standard ist 'dbx'.
string$key(Optional) Ein spezifischer Schlüssel, dessen Wert zurückgegeben werden soll.
Returns
mixed Die gesamte Konfiguration als Array, der spezifische Wert für $key, oder 'undef', falls der Schlüssel nicht existiert. Speichert die Konfiguration eines Moduls in einer Datei (verschlüsselt oder unverschlüsselt) und aktualisiert den Session-Cache.

Diese Funktion:

  • Akzeptiert ein Modul und die zu speichernde Konfiguration als Array.
  • Aktualisiert die Konfiguration im Session-Cache für sofortige Verfügbarkeit.
  • Speichert die Konfiguration in einer Datei, verschlüsselt, falls aktiviert.
  • Erstellt das Zielverzeichnis, falls es nicht existiert.
Parameters
string$modulDer Modulname, dessen Konfiguration gespeichert werden soll.
array$configDie Konfigurationsdaten als assoziatives Array.
Returns
int Gibt 0 zurück, falls ein Fehler aufgetreten ist, oder die Anzahl der geschriebenen Bytes. Konvertiert eine Zeichenkette in eine angegebene Zeichenkodierung.

Diese Funktion:

  • Wandelt die Eingabezeichenkette in eine neue Kodierung um, wenn die Zielkodierung ($charset) von der Quellkodierung ($incharset) abweicht.
  • Führt eine Erkennung der aktuellen Kodierung durch, falls $incharset als UTF-8 definiert ist.
  • Ersetzt explizit deutsche Umlaute (ä, ö, ü, ß, Ä, Ö, Ü) durch ihre entsprechenden Zeichencodes, falls notwendig.
Parameters
string$inDie zu konvertierende Zeichenkette.
string$charsetDie Zielzeichenkodierung (z. B. 'ISO-8859-1').
string$incharsetDie Eingabezeichenkodierung (Standard: 'UTF-8').
Returns
string Die konvertierte Zeichenkette.

Definition at line 3267 of file dbxApi.php.

References if.

◆ dbx_convertArrayToPHPCode()

dbx_convertArrayToPHPCode ( array $array,
string $prefix )

Konvertiert ein Array in PHP-Code, der es rekonstruiert.

Diese Funktion:

  • Traversiert ein Array rekursiv.
  • Generiert PHP-Code, um das Array durch Zuweisungen zu rekonstruieren.
  • Unterstützt verschachtelte Arrays und escapt automatisch Strings.
Parameters
array$arrayDas Array, das konvertiert werden soll.
string$prefixDer Prefix, der die Basisvariable oder den Startpunkt angibt.
Returns
string Der generierte PHP-Code, der das Array rekonstruiert.

Definition at line 3190 of file dbxApi.php.

References $array, $value, and dbx_convertArrayToPHPCode().

Referenced by dbx_convertArrayToPHPCode().

◆ dbx_copy_recursive()

dbx_copy_recursive ( $src,
$dst )

Kopiert ein komplettes Verzeichnis rekursiv.

Parameters
string$srcQuellverzeichnis (mit / am Ende oder ohne)
string$dstZielverzeichnis (mit / am Ende oder ohne)
Returns
bool true bei Erfolg, false bei Fehler

Definition at line 2833 of file dbxApi.php.

References $items, dbx(), and dbx_copy_recursive().

Referenced by dbx_copy_recursive().

◆ dbx_crypt()

dbx_crypt ( $content,
$xkey = '',
$master = '' )

Encrypts content using AES-128-CBC encryption.

Parameters
string$contentThe content to encrypt.
string$xkeyOptional. The encryption key. Defaults to a predefined key.
string$masterOptional. The master key. Defaults to the value from dbx()->get_config('dbx', 'crypt').
Returns
string|false The encrypted content or false on failure.

Definition at line 3772 of file dbxApi.php.

References $content, and dbx().

◆ dbx_DateTime()

dbx_DateTime ( $date_time = 'now',
$calc = 0,
$special = '' )

Liefert ein DBX-Datum/Zeit-Format mit optionalem Offset.

Beispiel:

echo dbx_DateTime('now', 3600); // aktuelle Zeit plus eine Stunde
echo dbx_DateTime('2026-06-06 10:00:00', 0, '+2 days');
dbx_DateTime($date_time='now', $calc=0, $special='')
Liefert ein DBX-Datum/Zeit-Format mit optionalem Offset.
Definition dbxApi.php:2894
Parameters
string$date_timeAusgangszeit oder now.
int$calcSekundenoffset.
string$specialstrtotime-Ausdruck relativ zur Ausgangszeit.
Returns
string Datum/Zeit im Format Y-m-d H:i:s.

Definition at line 2894 of file dbxApi.php.

◆ dbx_decrypt()

dbx_decrypt ( $content,
$xkey = '',
$master = '' )

Decrypts content using AES-128-CBC encryption.

Parameters
string$contentThe content to decrypt.
string$xkeyOptional. The encryption key. Defaults to a predefined key.
string$masterOptional. The master key. Defaults to the value from dbx()->get_config('dbx', 'crypt').
Returns
string|false The decrypted content or false on failure.

Definition at line 3731 of file dbxApi.php.

References $content, and dbx().

◆ dbx_delete_cookie()

dbx_delete_cookie ( $cookie)

Definition at line 3489 of file dbxApi.php.

Referenced by dbxSession\destroy_php_session().

◆ dbx_get_cookie_val()

dbx_get_cookie_val ( $cookie,
$key,
$default = '' )

Definition at line 3494 of file dbxApi.php.

References $_SESSION.

◆ dbx_get_Date()

dbx_get_Date ( $date,
$io,
$default = '' )

Validates and formats a date string based on the input and output format.

Parameters
string$dateThe date string to validate and format.
string$ioThe desired output format ('web' for DD.MM.YYYY, 'php' for YYYY-MM-DD).
string$defaultThe default value to return if the date is invalid.
Returns
string The formatted date or the default value if validation fails.

Definition at line 3513 of file dbxApi.php.

References if.

Referenced by dbx_get_phpDate(), dbx_get_webDate(), and dbx_get_webDateTime().

◆ dbx_get_Microtime()

dbx_get_Microtime ( )

Definition at line 3652 of file dbxApi.php.

◆ dbx_get_phpDate()

dbx_get_phpDate ( $date,
$default = '' )

Definition at line 3587 of file dbxApi.php.

References dbx_get_Date().

◆ dbx_get_Today()

dbx_get_Today ( $days = 0)

Definition at line 3641 of file dbxApi.php.

◆ dbx_get_webDate()

dbx_get_webDate ( $date,
$default = '' )

Definition at line 3581 of file dbxApi.php.

References dbx_get_Date().

◆ dbx_get_webDateTime()

dbx_get_webDateTime ( $date_time,
$default = '' )

Definition at line 3595 of file dbxApi.php.

References dbx_get_Date().

◆ dbx_html2src()

dbx_html2src ( $html_in)

Definition at line 3684 of file dbxApi.php.

Referenced by dbx_html2txt().

◆ dbx_html2txt()

dbx_html2txt ( $txt)

Definition at line 3672 of file dbxApi.php.

References dbx_html2src().

◆ dbx_interpreter()

dbx_interpreter ( $content)

Definition at line 3710 of file dbxApi.php.

References $content, and dbx().

◆ dbx_is_decimal()

dbx_is_decimal ( $value)

Definition at line 3623 of file dbxApi.php.

References $ok, and $value.

◆ dbx_is_Login()

dbx_is_Login ( )

Definition at line 3605 of file dbxApi.php.

References dbx().

◆ dbx_is_page()

dbx_is_page ( $page,
$design,
$lng = '' )

Prueft, ob ein historisches Template unter dbx/tpl/htm existiert.

Parameters
string$pageTemplate-/Seitenname.
string$designHistorischer Parameter.
string$lngHistorischer Parameter.
Returns
bool

Definition at line 2981 of file dbxApi.php.

References $design, $lng, $page, and dbx().

◆ dbx_lng_current()

dbx_lng_current ( )

Lädt eine Klasse aus dem Cache oder erstellt eine neue Instanz der Klasse.

Die Funktion versucht, ein Objekt der angegebenen Klasse zu laden:

  1. Wenn das Objekt bereits im Cache vorhanden ist, wird es zurückgegeben.
  2. Andernfalls wird die entsprechende Klassen-Datei eingebunden und ein neues Objekt erstellt.
Parameters
string$classDer Name der Klasse, die geladen werden soll.
string$use(Optional) Kann verwendet werden, um andere Logiken basierend auf der Klasse zu implementieren. Standardmäßig leer.
Returns
object|null Gibt das Klassen-Objekt zurück oder null, falls ein Fehler auftritt oder $use gesetzt ist.
Exceptions
ExceptionWenn die Klasse nicht geladen werden kann und keine Fallback-Klasse definiert ist. Lädt ein Modul-Objekt basierend auf dem Modulnamen und aktualisiert zugehörige System- und Modulvariablen.

Diese Funktion:

  1. Erzeugt den vollqualifizierten Klassennamen des Moduls.
  2. Aktualisiert System- und Modulvariablen wie dbx_activ_modul_id, dbx_activ_modul und Design-Informationen.
  3. Lädt die Klassen-Datei des Moduls und erstellt eine Instanz der Klasse.
Parameters
string$classDer Name des Moduls, das geladen werden soll.
Returns
object Gibt eine Instanz des Modul-Objekts zurück.
Exceptions
ExceptionWenn die Klassen-Datei des Moduls fehlt oder die Klasse nicht geladen werden kann. Lädt eine Klasse aus dem include-Ordner eines Moduls und erstellt ein Objekt.

Die Funktion sucht nach einer Klassen-Datei im include-Ordner des angegebenen Moduls oder des aktuell aktiven Moduls, lädt diese und erstellt eine Instanz der Klasse.

Parameters
string$classDer Name der Klasse, die geladen werden soll.
string$modul(Optional) Der Name des Moduls, zu dem die Klasse gehört. Standardmäßig wird das aktuell aktive Modul verwendet.
string$use(Optional) Zusätzliche Steuerung, ob ein Objekt zurückgegeben wird. Standard: leer.
Returns
object|null Gibt eine Instanz des Klassen-Objekts zurück oder null, wenn $use gesetzt ist.
Exceptions
ExceptionWenn die Klassen-Datei fehlt oder die Klasse nicht geladen werden kann. Aktive UI-Sprache (SysVar dbx_lng).
Returns
string z. B. de, en, es

Definition at line 3038 of file dbxApi.php.

References $lng.

Referenced by dbx\dbxContent\dbxContentLng\current(), and dbx\dbxContent\dbxContentHome\currentLng().

◆ dbx_lng_name()

dbx_lng_name ( string $base,
string $lng = '' )

Sprachsuffix an Basisnamen haengen: content + de => content_de.

Parameters
string$baseBasis ohne Sprachsuffix
string$lngSprache; leer = aktive Sprache
Returns
string

Definition at line 3085 of file dbxApi.php.

References $base, and $lng.

Referenced by dbx\dbxContent_admin\add_content(), dbx\dbxContent\dbxContentLng\ddContent(), dbx\dbxContent\dbxContentLng\ddFolder(), dbx\dbxContent_admin\del_content(), dbx\dbxContent_admin\dbxContent_edit\run(), dbx\dbxContent_admin\dbxContent_sysdata\run(), dbx\dbxContent_admin\dbxFolder_edit\run(), and dbx\dbxContent_admin\dbxContent_content\run_nix().

◆ dbx_lng_resolve_file()

dbx_lng_resolve_file ( string $dir,
string $name,
string $ext,
string $lng = '',
bool $fallback = true )

Datei mit Sprachsuffix aufloesen: name_lng.ext mit Fallback name.ext.

Parameters
string$dirVerzeichnis mit abschliessendem /
string$nameDateiname ohne Endung
string$extEndung ohne Punkt
string$lngSprache; leer = aktive Sprache
bool$fallbackNeutralen Namen als Fallback nutzen
Returns
string Absoluter Pfad oder leer

Definition at line 3109 of file dbxApi.php.

References $dir, $fallback, and $lng.

Referenced by dbxTPL\get_design_tpl_dir_file(), and dbxTPL\read_tpl().

◆ dbx_load_cookie()

dbx_load_cookie ( $cookie)

Lädt einen JSON-Cookie in den dbxapp-Sessionbereich.

Parameters
string$cookieName des zu ladenden Cookies.
Returns
void

Definition at line 3477 of file dbxApi.php.

References $_COOKIE, and $_SESSION.

◆ dbx_log_missing_entry()

dbx_log_missing_entry ( $missing = '')

Definition at line 17 of file dbxApi.php.

References $missing, and dbx().

◆ dbx_make_dir()

dbx_make_dir ( string $path)

Erstellt ein Verzeichnis und alle notwendigen Unterverzeichnisse.

Parameters
string$pathDer Pfad des zu erstellenden Verzeichnisses.
Returns
int 1 bei Erfolg oder wenn das Verzeichnis bereits existiert, 0 bei Fehler.

Beispiel:

$path = '/var/www/html/myBefund/ldt-in/';
$ok = dbx_make_dir($path);
echo $ok ? 'Verzeichnis erstellt oder existiert bereits' : 'Fehler beim Erstellen';
dbx_make_dir(string $path)
Erstellt ein Verzeichnis und alle notwendigen Unterverzeichnisse.
Definition dbxApi.php:2941

Definition at line 2941 of file dbxApi.php.

References if.

◆ dbx_make_seed()

dbx_make_seed ( )

Holt und validiert eine POST-Variable.

Diese Funktion prüft, ob eine POST-Variable vorhanden ist, validiert den Wert anhand der angegebenen Regeln und gibt den validierten Wert zurück. Wenn der Wert nicht vorhanden ist oder die Validierung fehlschlägt, wird der Standardwert zurückgegeben.

Parameters
string$varnameDer Name der POST-Variable, die abgerufen werden soll.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die POST-Variable nicht gesetzt ist oder die Validierung fehlschlägt. (Standard: leerer String)
string$rulesDie Validierungsregeln für die POST-Variable. (Standard: 'parameter')
Returns
mixed Der validierte Wert der POST-Variable oder der Standardwert, wenn die Variable nicht gesetzt oder ungültig ist. Holt und validiert eine GET-Variable.

Diese Funktion prüft, ob eine GET-Variable vorhanden ist, validiert den Wert anhand der angegebenen Regeln und gibt den validierten Wert zurück. Wenn der Wert nicht vorhanden ist oder die Validierung fehlschlägt, wird der Standardwert zurückgegeben.

Parameters
string$varnameDer Name der GET-Variable, die abgerufen werden soll.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die GET-Variable nicht gesetzt ist oder die Validierung fehlschlägt. (Standard: leerer String)
string$rulesDie Validierungsregeln für die GET-Variable. (Standard: 'parameter')
Returns
mixed Der validierte Wert der GET-Variable oder der Standardwert, wenn die Variable nicht gesetzt oder ungültig ist. Holt und validiert eine POST- oder GET-Variable.

Diese Funktion prüft, ob eine Variable in den $_POST- oder $_GET-Daten vorhanden ist, validiert den Wert anhand der angegebenen Regeln und gibt den validierten Wert zurück. Wenn der Wert nicht vorhanden ist oder die Validierung fehlschlägt, wird der Standardwert zurückgegeben.

Parameters
string$varnameDer Name der POST- oder GET-Variable, die abgerufen werden soll.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die Variable nicht gesetzt ist oder die Validierung fehlschlägt. (Standard: leerer String)
string$rulesDie Validierungsregeln für die Variable. (Standard: 'parameter')
Returns
mixed Der validierte Wert der Variable oder der Standardwert, wenn die Variable nicht gesetzt oder ungültig ist. Holt eine Systemvariable aus der Session, POST oder GET und validiert sie.

Diese Funktion prüft, ob eine Systemvariable in der Session, POST oder GET vorhanden ist, validiert den Wert anhand der angegebenen Regeln und gibt den validierten Wert zurück. Wenn die Variable nicht vorhanden oder ungültig ist, wird der Standardwert zurückgegeben.

Parameters
string$varnameDer Name der Systemvariable, die abgerufen werden soll.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die Variable nicht gesetzt ist oder die Validierung fehlschlägt. (Standard: leerer String)
string$rulesDie Validierungsregeln für die Variable. (Standard: '*' für keine Validierung)
Returns
mixed Der validierte Wert der Systemvariable oder der Standardwert, wenn die Variable nicht gesetzt oder ungültig ist. Holt eine "Remember"-Variable aus der Session und validiert sie.

Diese Funktion sucht nach einer Variable in der Session unter der "remember"-Sektion des angegebenen Moduls, validiert den Wert gemäß den angegebenen Regeln und gibt den validierten Wert zurück. Wenn die Variable nicht vorhanden oder ungültig ist, wird der Standardwert zurückgegeben.

Parameters
string$varnameDer Name der "Remember"-Variablen, die abgerufen werden soll.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die Variable nicht gesetzt ist oder ungültig ist. (Standard: leerer String)
string$modulDas Modul, zu dem die "Remember"-Variable gehört. (Standard: 'modul')
Returns
mixed Der validierte Wert der "Remember"-Variable oder der Standardwert, wenn die Variable nicht gesetzt oder ungültig ist. Setzt eine "Remember"-Variable in der Session und optional im System.

Diese Funktion speichert eine Variable in der Session unter der "remember"-Sektion des angegebenen Moduls. Wenn das Modul dbx ist, wird die Variable zusätzlich in der System-Session gespeichert.

Parameters
string$varnameDer Name der "Remember"-Variablen, die gesetzt werden soll.
mixed$valueDer Wert, der für die Variable gespeichert werden soll.
string$modulDas Modul, zu dem die "Remember"-Variable gehört. (Standard: 'modul') Setzt eine Systemvariable in der Session.

Diese Funktion speichert eine Systemvariable in der Session unter $_SESSION['dbx']['tmp'][0]['dbx'], sodass der Wert zwischen verschiedenen Anfragen erhalten bleibt.

Parameters
string$varnameDer Name der Systemvariablen, die gesetzt werden soll.
mixed$valueDer Wert, der für die Systemvariable gespeichert werden soll. Holt eine Modul-spezifische Variable aus verschiedenen Quellen (Session, GET, POST). Wenn der Wert nicht vorhanden oder ungültig ist, wird der Standardwert zurückgegeben.

Wichtige DBX-Regeln:

  • ModulVar aus dem aktuellen Modulkontext hat Vorrang.
  • Wenn kein ModulVar-Wert existiert, wird zuerst GET und danach POST geprüft.
  • POST gewinnt dadurch vor GET.
  • Werte wie 0 oder "0" sind gültige Werte und dürfen nicht auf den Default zurückfallen.
  • Der Default gilt nur bei nicht vorhandenem Wert, leerem String oder ungültiger Validierung.
Parameters
string$varnameDer Name der zu holenden Variable.
mixed$defaultDer Standardwert, der zurückgegeben wird, wenn die Variable nicht gefunden wird oder ungültig ist. (Standard: '')
string$rulesDie Validierungsregel für die Variable (Standard: 'alphanum').
Returns
mixed Der Wert der Variable oder der Standardwert, wenn die Variable nicht gefunden oder ungültig ist. Setzt eine Modul-spezifische Variable in der Session.

Geschützte ModulVariablen werden nicht überschrieben, wenn sie in dbx_protected_modulvars des aktuellen Modulkontexts eingetragen sind.

Wichtig:

  • Die Schutzliste wird direkt aus der ModulVar-Session gelesen.
  • GET/POST dürfen bei der Schutzprüfung niemals mitreden.
  • Mit $check_protected = false kann bewusst intern/gezielt überschrieben werden.
Parameters
string$varnameDer Name der zu setzenden Variable.
mixed$valueDer Wert, der für die Variable gespeichert werden soll.
bool$check_protectedOb geschützte ModulVariablen beachtet werden sollen.
Returns
void Liefert einen float-basierten Zufalls-Seed aus microtime().
float Seed-Wert.

Definition at line 3466 of file dbxApi.php.

◆ dbx_modul_translate()

dbx_modul_translate ( $content,
$modul = '',
$lng = '' )

Wendet die modulbezogene translate.php auf Inhalt an.

Beispiel:

$html = dbx_modul_translate($html, 'dbxContent', 'de');
dbx_modul_translate($content, $modul='', $lng='')
Wendet die modulbezogene translate.php auf Inhalt an.
Definition dbxApi.php:3154
Parameters
string$contentZu uebersetzender Inhalt.
string$modulModulname; leer nutzt aktives Modul.
string$lngSprache; leer nutzt aktive Sprache.
Returns
string Uebersetzter Inhalt.

Definition at line 3154 of file dbxApi.php.

References $content, $lng, and dbx().

◆ dbx_replace_first()

dbx_replace_first ( $search_str,
$replacement_str,
$src_str )

Ersetzt das erste Vorkommen einer Zeichenfolge.

Parameters
string$search_strGesuchte Zeichenfolge.
string$replacement_strErsatztext.
string$src_strQuelltext.
Returns
string Text mit hoechstens einer Ersetzung.

Definition at line 3173 of file dbxApi.php.

◆ dbx_save_cookie()

dbx_save_cookie ( $cookie,
$hh = 12 )

Definition at line 3484 of file dbxApi.php.

References $_SESSION.

◆ dbx_sendMail()

dbx_sendMail ( $from,
$fromname,
$to,
$subject,
$text,
$type = 'html',
$attach = '',
$archiv = 0 )

Kompatibilitaetswrapper fuer dbx()->send_mail().

Parameters
string$fromAbsender-E-Mail.
string$fromnameAbsendername.
string | array$toEmpfaenger.
string$subjectBetreff.
string$textInhalt.
string$typehtml|text.
mixed$attachAnhaenge.
int$archivHistorischer Parameter, aktuell nicht ausgewertet.
Returns
int 1 bei Erfolg, 0 bei Fehler.

Definition at line 2967 of file dbxApi.php.

References dbx().

◆ dbx_set_CurrentUser()

dbx_set_CurrentUser ( $key,
$value )

Setzt einen Wert oder den gesamten aktuellen Benutzerkontext.

Parameters
string$keyFeldname oder * fuer den vollstaendigen Kontext.
mixed$valueZu speichernder Feldwert oder Benutzer-Array.
Returns
void

Definition at line 3616 of file dbxApi.php.

References $_SESSION, and $value.

◆ dbx_txt2html()

dbx_txt2html ( $txt)

Definition at line 3679 of file dbxApi.php.

◆ dbx_upload()

dbx_upload ( )

Definition at line 3659 of file dbxApi.php.

References dbx().

◆ dbx_validate_var()

dbx_validate_var ( $danger_value,
$rules = 'parameter',
$varname = 'undef' )

Validiert eine Eingabe basierend auf angegebenen Regeln.

Diese Funktion überprüft, ob der übergebene Wert ($danger_value) den festgelegten Validierungsregeln entspricht. Sie verwendet ein Validator-Objekt, um die Validierung durchzuführen, es sei denn, die Regeln sind auf '*' gesetzt, was bedeutet, dass keine Validierung erfolgt.

Parameters
mixed$danger_valueDer Wert, der validiert werden soll.
string$rulesDie Validierungsregeln. Kann eine spezifische Regel oder '*' sein, um keine Validierung durchzuführen.
string$varnameDer Name der Variablen, der nur zu Validierungszwecken verwendet wird. (Standardwert: 'undef')
Returns
bool Gibt true zurück, wenn die Validierung erfolgreich ist, andernfalls false.

Definition at line 3331 of file dbxApi.php.

References $rules, and if.

Referenced by dbxRequest\get(), dbxApi\get_modul_var(), dbxApi\get_system_var(), dbxRequest\post(), and dbxRequest\request().

◆ debug()

debug ( $txt,
$data1 = '',
$data2 = '',
$data3 = '' )

Schreibt Debug-Ausgaben in files/dbxDebug.txt, wenn Debug aktiv ist.

Debug wird ueber files/dbxDebugActiv.txt aktiviert und im Remember-Cache gehalten. Arrays werden lesbar per print_r ausgegeben.

Beispiel:

dbx()->debug('Import fertig', $rows);
Parameters
string$txtHauptmeldung.
mixed$data1Optionale Zusatzdaten.
mixed$data2Optionale Zusatzdaten.
mixed$data3Optionale Zusatzdaten.
Returns
void

Definition at line 2686 of file dbxApi.php.

References $activ, $file, get_file_dir(), get_remember_var(), os_path(), and set_remember_var().

Referenced by run_web_app_request().

◆ debug2()

debug2 ( $line)

Schreibt eine einfache Debug-Zeile in files/dbxDebug2.txt.

Parameters
string$lineZu schreibende Zeile.
Returns
void

Definition at line 2663 of file dbxApi.php.

References $file, get_file_dir(), and os_path().

◆ delete_session_var()

delete_session_var ( $key,
$section = 'sys',
$modul = 'modul' )

Loescht einen strukturierten Sessionwert oder eine ganze Ebene.

Parameters
string$keySchluessel oder '*' fuer komplette Ebene.
string$sectionSessionbereich.
string$modulModulbereich.
Returns
void

Definition at line 1115 of file dbxApi.php.

References $_SESSION.

Referenced by invalidate_action_tokens().

◆ error_log_file()

error_log_file ( )

Liefert die zentrale PHP-Fehlerprotokolldatei.

Definition at line 1592 of file dbxApi.php.

References $dir, and get_file_dir().

◆ error_type()

error_type ( int $errno)

Uebersetzt eine PHP-Fehlernummer in ihre symbolische Bezeichnung.

Definition at line 1599 of file dbxApi.php.

◆ esc()

esc ( $value)

Escaped einen Wert fuer HTML-Text und HTML-Attribute.

Ungueltige UTF-8-Sequenzen werden ersetzt, damit die Ausgabe nicht unerwartet leer wird. Die Methode ist der zentrale Ersatz fuer lokale htmlspecialchars()-Hilfsfunktionen.

Parameters
mixed$valueAuszugebender Wert.
Returns
string HTML-sicherer Wert.

Definition at line 2310 of file dbxApi.php.

References $value.

Referenced by dbx\dbxUser_admin\list(), dbx\dbxKi\dbxKiBriefingService\renderHub(), dbx\dbxKi\dbxKiBriefingService\renderStylesAdmin(), dbx\dbxAdmin\report_modules(), dbx\dbxAdmin\dbxDashboard\run(), dbx\dbxAdmin\dbxUpdate\run(), dbx\dbxAdmin\dbxUser\run(), dbx\dbxDocs\dbxDocs\run(), and dbx\dbxUser\dbxUser_avatar\run().

◆ ge_stichtag()

ge_stichtag ( )

Prueft einen projektspezifischen Stichtag.

Returns
bool true ab 2025-06-01.

Definition at line 2819 of file dbxApi.php.

◆ get_base_dir()

◆ get_base_url()

get_base_url ( )

Liefert die Basis-URL des aktuellen Requests.

Returns
string

Definition at line 1488 of file dbxApi.php.

Referenced by dbxWebApp\check_request(), login(), redirect(), dbxTPL\replace_design_slots(), and dbx\dbxAdmin\dbxModuleImages\urlBase().

◆ get_content_permalink_mode()

get_content_permalink_mode ( )

Liefert den Permalink-Modus von dbxContent (content oder cms).

Returns
string

Definition at line 1913 of file dbxApi.php.

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

◆ get_design_skin_ids()

get_design_skin_ids ( string $design = '')

Liefert die Skin-IDs, die ein Design durch eigene skin-*.css-Dateien tatsaechlich bereitstellt.

Die Verzeichnisstruktur ist der verbindliche Katalog. Ein neues Farbschema wird dadurch ohne zusaetzliche PHP- oder JavaScript-Liste verfuegbar, sobald beispielsweise dbx/design/meindesign/css/skin-petrol.css existiert.

Parameters
string$designDesignname; leer verwendet das aktive Design.
Returns
array<int,string> Sichere, eindeutig sortierte Skin-IDs.

Definition at line 1753 of file dbxApi.php.

References $design.

◆ get_file_dir()

◆ get_remember_var()

get_remember_var ( string $varname,
$default = '',
string $modul = 'modul' )

Liest einen Remember-Wert.

Remember speichert laenger gueltigen Benutzer-/UI-Zustand, z.B. Sprache, Design, Edit-Modus, aktive Auswahl oder Reportzustand.

Beispiel:

$lng = dbx()->get_remember_var('dbx_lng', 'de', 'dbx');
Parameters
string$varnameName des Remember-Werts.
mixed$defaultRueckgabe, wenn kein Wert existiert.
string$modulModulbereich; 'modul' bedeutet aktuelles Modul.
Returns
mixed

Definition at line 1014 of file dbxApi.php.

References $_SESSION, and $value.

Referenced by dbxWebApp\check_lng(), debug(), dbxWebApp\get_base_url(), and next_id().

◆ get_self_url()

get_self_url ( )

Liefert die Self-URL des aktuellen Requests.

Returns
string

Definition at line 1497 of file dbxApi.php.

Referenced by dbxWebApp\check_request().

◆ get_session_var()

get_session_var ( $key,
$default = null,
$section = 'sys',
$modul = 'modul' )

Liest einen strukturierten Sessionwert.

Beispiel:

$selection = dbx()->get_session_var('selected_ids', array(), 'report', 'dbxAdmin');
Parameters
string$keySchluessel oder '*' fuer komplette Ebene.
mixed$defaultRueckgabe, wenn kein Wert existiert.
string$sectionSessionbereich.
string$modulModulbereich; 'modul' bedeutet aktuelles Modul.
Returns
mixed

Definition at line 1078 of file dbxApi.php.

References $_SESSION.

◆ get_skin()

get_skin ( )

Aktiver Skin aus Systemvariable dbx_color.

Returns
string

Definition at line 1858 of file dbxApi.php.

References normalize_skin().

Referenced by get_skin_class().

◆ get_skin_class()

get_skin_class ( )

Body-Klassen fuer den aktiven Skin.

Returns
string

Definition at line 1882 of file dbxApi.php.

References get_skin().

◆ get_skin_css()

get_skin_css ( )

CSS-Pfad zum aktiven Skin relativ zum Projektroot.

Returns
string

Definition at line 1867 of file dbxApi.php.

References $design.

◆ has_group()

has_group ( $access_groups = '',
$user_groups = '' )

Definition at line 1410 of file dbxApi.php.

References can().

◆ has_text()

has_text ( $string,
$find )

Prueft, ob ein Text einen Suchbegriff enthaelt.

Parameters
string$stringText.
string$findSuchbegriff.
Returns
bool

Definition at line 2286 of file dbxApi.php.

◆ html()

html ( $html)

Bereitet HTML fuer die Ausgabe auf.

Parameters
string$htmlEingabe.
Returns
string

Definition at line 2296 of file dbxApi.php.

References $html.

Referenced by dbx\dbxUser_admin\run().

◆ invalidate_action_tokens()

invalidate_action_tokens ( )

Verwirft alle Action-Tokens an einer Authentifizierungsgrenze.

Login und Logout wechseln den Sicherheitskontext. Ein zuvor gerendertes Gast- oder Benutzer-Token darf danach nicht weiterverwendet werden. Der naechste action_token()-Aufruf erzeugt automatisch ein neues Secret.

Die Legacy-Ablage wird ebenfalls entfernt, damit alte geoeffnete Links keinen Wechsel des angemeldeten Benutzers ueberleben.

Returns
void

Definition at line 1247 of file dbxApi.php.

References delete_session_var().

◆ is_dbx_edit()

is_dbx_edit ( )

Prueft, ob der Frontend-Edit-Modus aktiv ist (dbx_edit > 0).

Returns
bool

Definition at line 1419 of file dbxApi.php.

◆ is_design()

is_design ( $design,
$page = 'default' )

Prueft, ob ein Design fuer die angegebene Seite existiert.

Parameters
string$designDesignname.
string$pageSeiten-/Template-Name.
Returns
bool

Definition at line 2217 of file dbxApi.php.

References $admin, $design, $page, can(), and get_base_dir().

Referenced by dbxWebApp\check_design().

◆ is_int_value()

is_int_value ( $value)

Prueft, ob ein Wert als Integer verwendbar ist.

Parameters
mixed$valueEingabewert.
Returns
bool

Definition at line 2435 of file dbxApi.php.

References $value.

Referenced by dbxDB\check_where(), and dbx\dbxMenu\dbxContent_menu\run().

◆ is_modul()

is_modul ( $modul)

Prueft, ob ein Modulverzeichnis existiert.

Parameters
string$modulModulname.
Returns
bool

Definition at line 2201 of file dbxApi.php.

References get_base_dir().

Referenced by dbxWebApp\check_modul().

◆ json_response()

json_response ( array $data,
bool $withRuntime = false )

Beendet den Request mit JSON-Ausgabe.

Parameters
array$dataAntwortdaten.
bool$withRuntimeOptional Laufzeit-Metadaten und Header mitsenden.
Returns
void

Definition at line 1647 of file dbxApi.php.

References if.

Referenced by dbx\dbxKi\dbxKiBundleService\handleDescribeJson().

◆ load_content_cache_classes()

load_content_cache_classes ( )

Laedt die Content-Cache-Klassen einmalig fuer Frontend, CMS und Admin.

Returns
void

Definition at line 1898 of file dbxApi.php.

Referenced by dbxWebApp\check_perma().

◆ log_missing()

log_missing ( $missing = '')

Zaehlt einen fehlenden Pfad oder eine fehlende Ressource in dbxMissing.

Parameters
string$missingPermalink, Dateipfad oder Request-URI.
Returns
int Update-/Insert-Ergebnis oder 0 bei leerem Schluessel.

Definition at line 1930 of file dbxApi.php.

References $db, $missing, $ok, user(), and write_php_error_log().

◆ login()

login ( $uid = 0,
$remember = 0 )

Meldet einen Benutzer im DBX-Kontext an.

Beispiel:

dbx()->login($uid, 1);
Parameters
int$uidBenutzer-ID.
int$rememberRemember-Login setzen.
Returns
void

Definition at line 1465 of file dbxApi.php.

References $page, dbx(), get_base_url(), and user().

◆ new_password()

new_password ( $minlength,
$special = '-_!' )

Erzeugt ein neues Passwort.

Parameters
int$minlengthMindestlänge.
string$specialErlaubte Sonderzeichen.
Returns
string

Definition at line 2448 of file dbxApi.php.

References $password.

◆ next_id()

next_id ( int $add = 1)

Erzeugt eine fortlaufende ID innerhalb des DBX-Kontexts.

Parameters
int$addSchrittweite.
Returns
int Neue ID.

Definition at line 2181 of file dbxApi.php.

References get_remember_var().

Referenced by dbx\dbxContent\dbxContentRenderer\renderStatic().

◆ norep()

norep ( $norep,
$i = 0 )

Lagert HTML/Text in einen norep-Platzhalter aus.

Wirkung: Inhalt wird vor spaeteren Ersetzungslaeufen geschuetzt und am Ende wieder eingesetzt. Sinnvoll fuer HTML, Scriptbloecke oder komplexe Fragmente.

Parameters
string$norepZu schuetzender Inhalt.
int$iOptionaler Zaehler.
Returns
string Platzhalter-ID.

Definition at line 2168 of file dbxApi.php.

References $_SESSION.

◆ normalize_skin()

normalize_skin ( string $skin = '',
string $design = '' )

Normalisiert Skin-/Farbnamen auf gueltige Skin-IDs.

Parameters
string$skinRohwert aus URL, Session oder Profil.
string$designOptionales Design; leer verwendet das aktive Design.
Returns
string Gueltige Skin-ID des angegebenen Designs.

Definition at line 1813 of file dbxApi.php.

References $design.

Referenced by get_skin().

◆ os_path()

os_path ( string $path)

Normalisiert einen Pfad fuer das aktuelle Betriebssystem.

Parameters
string$pathEingabepfad.
Returns
string Normalisierter Pfad.

Definition at line 1538 of file dbxApi.php.

Referenced by debug(), debug2(), dbx\dbxDesign_admin\dbxDesignService\designRoot(), dbxApi\get_config(), get_content_permalink_mode(), dbxRuntime\store_performance_timer(), and dbxApi\use_system_class().

◆ parse_url()

parse_url ( $data)

Zerlegt URL-/Parameterdaten in einen Array.

Parameters
string$dataParameterstring.
Returns
array

Definition at line 2416 of file dbxApi.php.

References $first.

Referenced by dbxWebApp\check_uri(), dbxWebApp\get_base_uri(), and dbxWebApp\get_request_route_string().

◆ part_select()

part_select ( $vor,
$nach,
$part )

Schneidet einen Teil zwischen zwei Markern aus einem Text.

Parameters
string$vorMarker vor dem Teil.
string$nachMarker nach dem Teil.
string$partEingabetext.
Returns
string

Definition at line 2390 of file dbxApi.php.

◆ patch_local_config()

patch_local_config ( string $modul,
array $patch )

Fuehrt einen lokalen Konfigurationsausschnitt rekursiv zusammen.

Bestehende Passwoerter oder andere lokale Werte bleiben erhalten, wenn der Patch nur DD-Serverbindungen ergaenzt.

Definition at line 875 of file dbxApi.php.

References if.

Referenced by dbx\dbxSetup\dbxInstallationService\bindAllToServer().

◆ redirect()

redirect ( $redirect,
$timer = 0 )

Sendet einen Redirect oder Meta-Refresh.

Parameters
string$redirectZiel-URL.
int$timerSekunden bis Weiterleitung.
Returns
void

Definition at line 2240 of file dbxApi.php.

References $ajax, $base, dbx(), and get_base_url().

◆ run_web_app_request()

run_web_app_request ( )

Fuehrt den kompletten Frontcontroller-Ablauf aus und schreibt die Response.

Definition at line 2612 of file dbxApi.php.

References $response, $stored, debug(), and dbx\dbxContent\dbxContentPageCache\writeFullPage().

◆ search_defaults()

search_defaults ( array $overrides = array())

Standard-Optionen fuer dbx|search (wie Content-Grid).

Parameters
array$overridesname, placeholder, title, tooltip, errormsg, input_class, wrap_class, wrap_style, data_role, extra_attrs, label, value, i
Returns
array

Definition at line 2326 of file dbxApi.php.

◆ send_mail()

send_mail ( $from,
$to,
string $subject = '',
string $body = '',
string $format = 'html',
$attachments = array(),
array $options = array() )

Sendet eine E-Mail ueber dbxMail/PHPMailer.

Beispiel:

dbx()->send_mail(
'sender@example.org',
'kunde@example.org',
'Betreff',
'<p>Hallo</p>',
'html',
array('/tmp/rechnung.pdf')
);
Parameters
mixed$fromString, "Name <mail>" oder array('email'=>..., 'name'=>...)
mixed$toString, CSV/Semikolon-Liste oder Array
string$subjectBetreff
string$bodyHTML- oder Textinhalt
string$formathtml, text oder txt
mixed$attachmentsDatei, Dateien oder Attachment-Arrays
array$optionscc, bcc, reply_to, text, html, mail, mail_profile
Returns
int 1 bei Erfolg, 0 bei Fehler

Definition at line 940 of file dbxApi.php.

References $body, $mail, and $options.

◆ set_config()

set_config ( string $modul,
array $config )

Speichert die Konfiguration eines Moduls.

Beispiel:

dbx()->set_config('dbx', $config);
if($resolved !==$expectedBase . 'files/test/') $config
Parameters
string$modulModulname.
array$configZu speichernde Konfiguration.
Returns
int Anzahl geschriebener Bytes oder 0 bei Fehler.

Definition at line 793 of file dbxApi.php.

References $config, $content, and $dir.

◆ set_cookie_var()

set_cookie_var ( $cookie,
$key,
$val )

Setzt einen Wert in einem DBX-Cookie.

Parameters
string$cookieCookie-Name.
string$keySchluessel im Cookie.
mixed$valWert.
Returns
void

Definition at line 2275 of file dbxApi.php.

References $_SESSION.

◆ set_local_config()

set_local_config ( string $modul,
array $localConfig )

Speichert die vollstaendige lokale Konfiguration eines Moduls.

config.local.php enthaelt installationsbezogene Serverbindungen und Geheimnisse. Die Datei wird von Releases nicht ausgeliefert und darf deshalb getrennt von set_config() geschrieben werden.

Definition at line 841 of file dbxApi.php.

References if.

◆ set_local_config_section()

set_local_config_section ( string $modul,
string $section,
array $value )

Ersetzt genau einen lokalen Konfigurationsbereich.

Im Gegensatz zu patch_local_config() koennen damit entfernte DD-Bindungen wirklich geloescht werden, ohne andere lokale Bereiche wie Datenbankpasswoerter anzutasten.

Definition at line 896 of file dbxApi.php.

References $value, and if.

Referenced by dbx\dbxAdmin\dbxDDServerBindings\run().

◆ set_remember_var()

set_remember_var ( string $varname,
$value,
string $modul = 'modul' )

Setzt einen Remember-Wert.

Beispiel:

dbx()->set_remember_var('dbx_lng', 'de', 'dbx');

Wirkung: Merkt UI-/Benutzerzustand ueber den aktuellen Request hinaus.

Parameters
string$varnameName des Remember-Werts.
mixed$valueNeuer Wert.
string$modulModulbereich; 'modul' bedeutet aktuelles Modul.
Returns
void

Definition at line 1049 of file dbxApi.php.

References $_SESSION, and $value.

Referenced by debug().

◆ set_session_var()

set_session_var ( $key,
$val,
$section = 'sys',
$modul = '' )

Setzt einen strukturierten Sessionwert.

Parameters
string$keySchluessel.
mixed$valNeuer Wert.
string$sectionSessionbereich.
string$modulModulbereich.
Returns
void

Definition at line 1102 of file dbxApi.php.

References $_SESSION.

◆ sys_msg()

sys_msg ( $status = '',
$about = '',
$rid = '',
$why = '',
$what = '' )

Schreibt eine strukturierte Systemmeldung.

Beispiel:

dbx()->sys_msg('info', 'Import', $rid, 'done', '42 rows');
Parameters
string$statusMeldungsart, z.B. info, warning, error, login, security.
string$aboutBereich oder Komponente.
mixed$ridBetroffener Datensatz oder Bezug.
string$whyGrund.
mixed$whatDetail oder Zusatzdaten.
Returns
int Insert-ID oder 0 bei Fehler/Schutzfall.

Definition at line 2047 of file dbxApi.php.

References $file, $ok, $work, dbx(), and user().

Referenced by dbx\dbxKi\dbxKiBriefingService\handleStylesReset().

◆ time_diff()

time_diff ( $starttime = 0,
$endtime = 0 )

Berechnet eine Zeitdifferenz zwischen zwei Timestamps.

Parameters
int$starttimeStartzeit; 0 bedeutet jetzt.
int$endtimeEndzeit; 0 bedeutet jetzt.
Returns
int

Definition at line 2376 of file dbxApi.php.

References timestamp().

◆ timer()

timer ( $section,
$info = '' )

Misst Laufzeiten fuer Debug/Analyse.

Beispiel:

dbx()->timer('report', 'start');
// ...
dbx()->timer('report');
Parameters
string$sectionMessbereich.
string$infoOptionaler Beschreibungstext.
Returns
void

Definition at line 1678 of file dbxApi.php.

References $state.

◆ timestamp()

timestamp ( $add_sec = 0)

Liefert einen Unix-Timestamp mit optionalem Sekunden-Offset.

Parameters
int$add_secSekunden-Offset.
Returns
int

Definition at line 2362 of file dbxApi.php.

Referenced by time_diff().

◆ user()

user ( $key = 'id')

Liest einen Wert des aktuellen Benutzers.

Beispiel:

$uid = dbx()->user();
$groups = dbx()->user('groups');
Parameters
string$keyBenutzerfeld; Standard ist id.
Returns
mixed

Definition at line 1305 of file dbxApi.php.

References $_SESSION.

Referenced by can(), dbxDB\check_access(), log_missing(), login(), dbx\dbxContact\dbxContactForm\run(), dbx\dbxLogin\register\run(), and sys_msg().

◆ write_php_error_log()

write_php_error_log ( string $type,
string $message,
string $file = '',
int $line = 0 )

Schreibt einen PHP-Fehler mit Request-Kontext in das zentrale Protokoll.

Definition at line 1621 of file dbxApi.php.

References $_SERVER, and $file.

Referenced by log_missing().

Variable Documentation

◆ $_dbxCache

Global $_dbxCache

Definition at line 15 of file dbxApi.php.

Referenced by dbxApi\get_system_obj().