Ein Trait zum Lesen und Schreiben der Instanzkonfiguration

Von implementierenden Objekten wird erwartet, dass sie eine $_defaultConfig Eigenschaft.

Namespace: CakeCore

Zusammenfassung der Eigenschaften

  • $_config geschütztarray

    Laufzeitkonfiguration

  • $_configInitialized protectedbool

    Ob die Eigenschaft config bereits mit Standardwerten konfiguriert wurde

Zusammenfassung der Methode

  • _configDelete()protected

    Löscht einen einzelnen Konfigurationsschlüssel.

  • _configRead()protected

    Liest einen Konfigurationsschlüssel aus.

  • _configWrite()protected

    Schreibt einen Konfigurationsschlüssel.

  • configShallow()public

    Führt die bereitgestellte Konfiguration mit der vorhandenen Konfiguration zusammen. Im Gegensatz zu . config() die eine rekursive Zusammenführung für verschachtelte Schlüssel durchführt, führt diese Methode eine einfache Zusammenführung durch.

  • getConfig()public

    Gibt die Konfiguration zurück.

  • getConfigOrFail()public

    Gibt die Konfiguration für diesen spezifischen Schlüssel zurück.

  • setConfig()public

    Setzt die Konfiguration.

Methode Detail

_configDelete() protected

_configDelete(string$key)

Löscht einen einzelnen Konfigurationsschlüssel.

Parameter

stringSchlüssel

Zu löschender Schlüssel.

Wirft

CakeCoreExceptionException
wenn versucht wird, eine bestehende Konfiguration zu löschen.

_configRead() geschützt

_configRead(?string$key)

Liest einen Konfigurationsschlüssel.

Parameter

string|nullSchlüssel

Zu lesender Schlüssel.

Gibt zurück.

mixed

_configWrite() protected

_configWrite(mixed$key,mixed$value,mixed$merge)

Schreibt einen Konfigurationsschlüssel.

Parameter

string|arraySchlüssel

Schlüssel, auf den geschrieben werden soll.

mixed$Wert

Zu schreibender Wert.

bool|string$mergeoptional

True zum rekursiven Zusammenführen, 'shallow' für einfaches Zusammenführen, false zum Überschreiben, Standardwert ist false.

Wirft

CakeCoreExceptionException
wenn versucht wird, eine existierende Konfiguration zu verletzen

configShallow() public

configShallow(mixed$key,mixed$value)

Führt die bereitgestellte Konfiguration mit der vorhandenen Konfiguration zusammen. Im Gegensatz zu config() die eine rekursive Zusammenführung für verschachtelte Schlüssel durchführt, führt diese Methode eine einfache Zusammenführung durch.

Einen bestimmten Wert setzen:

$this->configShallow('key',$value);

Setzen eines verschachtelten Wertes:

$this->configShallow('some.nested.key',$value);

Aktualisieren mehrerer Konfigurationseinstellungen zur gleichen Zeit:

$this->configShallow(['one'=>'value','another'=>'value']);

Parameter

string|arraySchlüssel

Der Schlüssel, der gesetzt werden soll, oder ein komplettes Array von Konfigs.

mixed|null$Wertoptional

Der zu setzende Wert.

Gibt zurück.

$this

getConfig() public

getConfig(?string$key,mixed$default)

Gibt die Konfiguration zurück.

Verwendung

Lesen der gesamten Konfiguration:

$this->getConfig();

Lesen eines bestimmten Wertes:

$this->getConfig('key');

Lesen eines verschachtelten Wertes:

$this->getConfig('some.nested.key');

Lesen mit Standardwert:

$this->getConfig('some-key','default-value');

Parameter

string|nullSchlüsseloptional

Der zu erhaltende Schlüssel oder null für die gesamte Konfiguration.

mixed$Standardoptional

Der Rückgabewert, wenn der Schlüssel nicht vorhanden ist.

Gibt zurück.

mixed

Konfigurationsdaten zum genannten Schlüssel oder null, wenn der Schlüssel nicht existiert.

getConfigOrFail() public

getConfigOrFail(string$key)

Gibt die Konfiguration für diesen spezifischen Schlüssel zurück.

Der Config-Wert für diesen Schlüssel muss existieren, er kann niemals null sein.

Parameter

string$Schlüssel

Der zu ermittelnde Schlüssel.

Gibt zurück.

mixed

Konfigurationsdaten für den angegebenen Schlüssel

Wirft

InvalidArgumentException

setConfig() public

setConfig(mixed$key,mixed$value,mixed$merge)

Setzt die Konfiguration.

Verwendung

Einstellen eines bestimmten Wertes:

$this->setConfig('key',$value);

Einstellen eines verschachtelten Wertes:

$this->setConfig('some.nested.key',$value);

Aktualisieren mehrerer Konfigurationseinstellungen zur gleichen Zeit:

$this->setConfig(['one'=>'value','another'=>'value']);

Parameter

string|arraySchlüssel

Der Schlüssel, der gesetzt werden soll, oder ein komplettes Array von Konfigs.

mixed|null$Wertoptional

Der zu setzende Wert.

bool$mergeoptional

Ob eine bestehende Konfiguration rekursiv zusammengeführt oder überschrieben werden soll, Standardwert ist true.

Gibt zurück.

$this

Wirft

CakeCoreExceptionException
Wenn versucht wird, einen ungültigen Schlüssel zu setzen.

Eigenschaft Detail

$_configgeschützt

Laufzeitkonfiguration

Typ

array

$_configInitializedgeschützt

Ob die Eigenschaft config bereits mit Standardwerten konfiguriert wurde

Typ

bool