Zend_Config_Writer

Zend_Config_Writer gibt einem die Möglichkeit Configdateien aus Zend_Config Objekten heraus zu schreiben. Es arbeitet mit einem Adapter-artigen System und ist deswegen sehr einfach zu verwenden. Standardmäßig wird Zend_Config_Writer mit drei Adaptern ausgeliefert, die alle Datei basierend sind. Der Writer wird mit speziellen Optionen instanziert, welche filename und config sein können. Dann wird die write() Methode des Writers aufgerufen und die Configdatei wird erstellt. Man kann $filename und $config auch direkt an die write() Methode übergeben. Aktuell werden die folgenden Writer mit Zend_Config_Writer ausgeliefert:

  • Zend_Config_Writer_Array

  • Zend_Config_Writer_Ini

  • Zend_Config_Writer_Xml

Der INI Writer hat zwei Modi für die Darstellung bezüglich Sektionen. Standardmäßig wird die Top-Level Konfiguration immer in Sektionsnamen geschrieben. Durch den Aufruf von $writer->setRenderWithoutSections(); werden alle Optionen in den globalen Namespace der INI Datei geschrieben und es werden keine Sektionen angehängt.

Zusätzlich hat Zend_Config_Writer_Ini einen zusätzlichen optionalen Parameter nestSeparator, welche definiert mit welchem Zeichen die einzelnen Nodes getrennt werden. Der Standard ist ein einzelner Punkt, wie er standardmäßig von Zend_Config_Ini akzeptiert wird.

Wenn ein Zend_Config Objekt geändert oder erstellt wird, muß man einige Dinge wissen. Um einen Wert zu erstellen oder zu ändern muß einfach der Parameter des Zend_Config Objektes über den Zugriffsaccessor (->) gesetzt werden. Um eine Sektion im Root oder im Branch zu erstellen muß einfach ein neues Aray erstellt werden ("$config->branch = array();"). Um zu definieren welche Sektion eine andere erweitert, muß die setExtend() Methode am Root Zend_Config Objekt aufgerufen werden.

Example #1 Verwenden von Zend_Config_Writer

Dieses Beispiel zeigt die grundsätzliche Verwendung von Zend_Config_Writer_Xml um eine neue Konfigurationsdatei zu erstellen:

  1. // Ein neues Config Objekt erstellen
  2. $config = new Zend_Config(array(), true);
  3. $config->production = array();
  4. $config->staging    = array();
  5.  
  6. $config->setExtend('staging', 'production');
  7.  
  8. $config->production->db = array();
  9. $config->production->db->hostname = 'localhost';
  10. $config->production->db->username = 'production';
  11.  
  12. $config->staging->db = array();
  13. $config->staging->db->username = 'staging';
  14.  
  15. // Die Config Datei auf einem der folgenden Wege schreiben:
  16. // a)
  17. $writer = new Zend_Config_Writer_Xml(array('config'   => $config,
  18.                                            'filename' => 'config.xml'));
  19. $writer->write();
  20.  
  21. // b)
  22. $writer = new Zend_Config_Writer_Xml();
  23. $writer->setConfig($config)
  24.        ->setFilename('config.xml')
  25.        ->write();
  26.  
  27. // c)
  28. $writer = new Zend_Config_Writer_Xml();
  29. $writer->write('config.xml', $config);

Das erstellt eine XML Config Datei mit den Sektionen production und staging, wobei staging production erweitert.

Example #2 Eine bestehende Config ändern

Dieses Beispiel zeigt wie eine bestehende Config Datei bearbeitet werden kann.

  1. // Lädt alle Sektionen einer bestehenden Config Datei, und überspringt
  2. // alle Erweiterungen
  3. $config = new Zend_Config_Ini('config.ini',
  4.                               null,
  5.                               array('skipExtends'        => true,
  6.                                     'allowModifications' => true));
  7.  
  8. // Ändere einen Wert
  9. $config->production->hostname = 'foobar';
  10.  
  11. // Schreibe die Config Datei
  12. $writer = new Zend_Config_Writer_Ini(array('config'   => $config,
  13.                                            'filename' => 'config.ini'));
  14. $writer->write();

Note: Laden einer Config Datei
Beim Laden einer bestehenden Config Datei für eine Änderung ist es sehr wichtig das alle Sektionen geladen werden und die Erweiterungen übersprungen werden, sodas keine Werte zusammengefügt werden. Das wird durch die Übergabe von skipExtends als Option an den Constructor durchgeführt.

Für alle Datei-basierenden Writer (INI, XML und PHP Array) wird intern render() verwendet um den Konfigurationsstring zu erstellen. Diese Methode kann auch von ausserhalb aus verwendet werden wenn man Zugriff auf eine String-Repräsentation der Konfigurationsdaten benötigt.

blog comments powered by Disqus