Docs for page core.config.php

Description

license: COPYING
copyright: © 2001-2007 The FLIP Project Team
version: $Id: core.config.php 1484 2007-10-15 22:18:05Z loom $
author: Moritz Eysholdt

Constants

CORE.CONFIG.PHP = 1 (line 15)

Die Datei nur einmal includen

Functions

ConfigDelete (line 111)

ConfigDelete() Löscht einen Konfigurationseintrag.

return: true bei Erfolg, ansonsten false.

boolean ConfigDelete (string $Ident)

string $Ident: Der Key oder die ID eines Konfigurationeintrages.

ConfigGet (line 35)

ConfigGet() Liest zu einem Config-Key den Wert aus der Datenbank.

Dabei wird die gesamte Konfiguration gecached, so dass sich viele Aufrufe von ConfigGet() nicht negativ auf die Performance auswirken. Wenn der Konfigurationeintrag nicht existiert und ein Wert für $DefValue angegeben wurde, dann wird er automatisch erstellt.

Wenn die User-Properties einen gleichnamigen Key enthalten wie ein Konfigurationseitrag, dann überläd der Wert der User-Property den Wert des Konfigurationseintrages.

return: Der Wert zum Konfiguratoneintrag $Key. Ist dieser nicht vorhanden, wird $DefValue zurückgegeben. Wurde $DefValue nicht angegeben, wird NULL zurückgegeben.

string ConfigGet (string $Key, [string $DefValue = NULL], [string $Description = ""], [boolean $UseUserCfg = true])

string $Key: Der Key des zu lesenden Config-Wertes
string $DefValue: Wird zusammen mit $Key und $Description als Konfurationeintrag gespeichert, wenn der Key nocht nicht existiert
string $Description: (siehe $DefValue)
boolean $UseUserCfg: wenn false, kann der User keine Konfigurationeintraege ueberladen.

ConfigGetAll (line 134)

ConfigGetAll() Liest alle Konfigurationseinträge aus der Datenbank.

Wenn es nur darum geht, die Werte bestimmter Keys zu ermitteln, arbeitet ConfigGet() wesentlich performanter.

return: Alle Konfigurationeinträge sortiert nach Key:
1. array(
2. "key1" => array("key" => "key1", "value" => "foo", "default_value" => "works_always", "description" => "blablupp"),
3. "key2" => array("key" => "key2", "value" => "bar", "default_value" => "bar", "description" => ""),
4. "key_new" => array("key" => "key_new", "value" => "12345", "default_value" => "1337", "description" => ""),
5. (...)
6. );
see: ConfigGet()

array ConfigGetAll ()

ConfigGetLong (line 155)

ConfigGetLong() Liest einen gesamten Konfigurationseintrag aus der Datenbank.

Wenn es nur darum geht, die Werte bestimmter Keys zu ermitteln, arbeitet ConfigGet() wesentlich performanter.

return: Ein Konfigurationseintrag oder false, wenn dieser nicht gefunden wurde. z.B.:
1. array(
2. "key" => "key1",
3. "value" => "foo",
4. "default_value" => "works_always",
5. "description" => "blablupp"
6. );
see: ConfigGet()

array ConfigGetLong (string $Ident)

string $Ident: Der Key oder die ID eines Konfigurationeintrages.

ConfigSet (line 99)

ConfigSet() Erstellt oder bearbeitet einen Configeintrag.

return: true bei Erfolg, ansonsten false

boolean ConfigSet (string $Key, string $Value, [string $Default = null], [string $Description = null], [ $Type = null])

string $Key: Der Key des Konfigurationeintrages. Er darf nicht nur aus Ziffern bestehen.
string $Value
string $Default: Ein Default-Wert für $Value.
string $Description: Eine Beschreibung der Funktionalität und des Auswirkungen des Konfigurationseintrages.
$Type

ConfigSetByID (line 73)

ConfigSetByID() Erstellt oder bearbeitet einen Konfigurationeintrag.

Wenn $Ident leer ist (empty($Ident) === true), wird ein neuer Konfigurationeintrag erstellt. Ansonsten wird der über $Ident identifizierte Konfigurationseintrag geupdated.

return: true bei Erfolg, ansonsten false

boolean ConfigSetByID (string $ID, string $Key, string $Value, [string $Default = null], [string $Description = null], [ $Type = null])

string $ID: Die ID eines Konfigurationseintrages.
string $Key: Der Key des Konfigurationeintrages. Er darf nicht nur aus Ziffern bestehen.
string $Value
string $Default: Ein Default-Wert für $Value.
string $Description: Eine Beschreibung der Funktionalität und des Auswirkungen des Konfigurationseintrages.
$Type

/web/core/core.config.php