Zend_Config_Writer.xml 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 16674 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.config.writer.introduction">
  5. <title>Zend_Config_Writer</title>
  6. <para>
  7. <classname>Zend_Config_Writer</classname> gibt einem die Möglichkeit Configdateien aus
  8. <classname>Zend_Config</classname> Objekten heraus zu schreiben. Es arbeitet mit einem
  9. Adapter-artigen System und ist deswegen sehr einfach zu verwenden. Standardmäßig wird
  10. <classname>Zend_Config_Writer</classname> mit drei Adaptern ausgeliefert, die alle gleich
  11. funktionieren. Der Writer wird mit speziellen Optionen instanziert, welche
  12. <emphasis>filename</emphasis> und <emphasis>config</emphasis> sein können. Dann wird die
  13. <methodname>write()</methodname> Methode des Writers aufgerufen und die Configdatei wird
  14. erstellt. Man kann <varname>$filename</varname> und <varname>$config</varname> auch direkt
  15. an die <methodname>write()</methodname> Methode übergeben. Aktuell werden die folgenden
  16. Writer mit <classname>Zend_Config_Writer</classname> ausgeliefert:
  17. </para>
  18. <itemizedlist>
  19. <listitem>
  20. <para>
  21. <classname>Zend_Config_Writer_Array</classname>
  22. </para>
  23. </listitem>
  24. <listitem>
  25. <para>
  26. <classname>Zend_Config_Writer_Ini</classname>
  27. </para>
  28. </listitem>
  29. <listitem>
  30. <para>
  31. <classname>Zend_Config_Writer_Xml</classname>
  32. </para>
  33. </listitem>
  34. </itemizedlist>
  35. <para>
  36. Als Ausnahme hat <classname>Zend_Config_Writer_Ini</classname> einen zusätzlichen optionalen
  37. Parameter <emphasis>nestSeparator</emphasis>, welche definiert mit welchem Zeichen die
  38. einzelnen Nodes getrennt werden. Der Standard ist ein einzelner Punkt, wie er standardmäßig
  39. von <classname>Zend_Config_Ini</classname> akzeptiert wird.
  40. </para>
  41. <para>
  42. Wenn ein <classname>Zend_Config</classname> Objekt geändert oder erstellt wird, muß man
  43. einige Dinge wissen. Um einen Wert zu erstellen oder zu ändern muß einfach der Parameter
  44. des <classname>Zend_Config</classname> Objektes über den Zugriffsaccessor
  45. (<emphasis>-&gt;</emphasis>) gesetzt werden. Um eine Sektion im Root oder im Branch zu
  46. erstellen muß einfach ein neues Aray erstellt werden
  47. ("<command>$config-&gt;branch = array();</command>"). Um zu definieren welche Sektion eine
  48. andere erweitert, muß die <methodname>setExtend()</methodname> Methode am Root
  49. <classname>Zend_Config</classname> Objekt aufgerufen werden.
  50. </para>
  51. <example id="zend.config.writer.example.using">
  52. <title>Verwenden von Zend_Config_Writer</title>
  53. <para>
  54. Dieses Beispiel zeigt die grundsätzliche Verwendung von
  55. <classname>Zend_Config_Writer_Xml</classname> um eine neue Konfigurationsdatei zu
  56. erstellen:
  57. </para>
  58. <programlisting language="php"><![CDATA[
  59. // Ein neues Config Objekt erstellen
  60. $config = new Zend_Config(array(), true);
  61. $config->production = array();
  62. $config->staging = array();
  63. $config->setExtend('staging', 'production');
  64. $config->production->db = array();
  65. $config->production->db->hostname = 'localhost';
  66. $config->production->db->username = 'production';
  67. $config->staging->db = array();
  68. $config->staging->db->username = 'staging';
  69. // Die Config Datei auf einem der folgenden Wege schreiben:
  70. // a)
  71. $writer = new Zend_Config_Writer_Xml(array('config' => $config,
  72. 'filename' => 'config.xml'));
  73. $writer->write();
  74. // b)
  75. $writer = new Zend_Config_Writer_Xml();
  76. $writer->setConfig($config)
  77. ->setFilename('config.xml')
  78. ->write();
  79. // c)
  80. $writer = new Zend_Config_Writer_Xml();
  81. $writer->write('config.xml', $config);
  82. ]]></programlisting>
  83. <para>
  84. Das erstellt eine <acronym>XML</acronym> Config Datei mit den Sektionen production und
  85. staging, wobei staging production erweitert.
  86. </para>
  87. </example>
  88. <example id="zend.config.writer.modifying">
  89. <title>Eine bestehende Config ändern</title>
  90. <para>
  91. Dieses Beispiel zeigt wie eine bestehende Config Datei bearbeitet werden kann.
  92. </para>
  93. <programlisting language="php"><![CDATA[
  94. // Lädt alle Sektionen einer bestehenden Config Datei, und überspringt
  95. // alle Erweiterungen
  96. $config = new Zend_Config_Ini('config.ini',
  97. null,
  98. array('skipExtends' => true,
  99. 'allowModifications' => true));
  100. // Ändere einen Wert
  101. $config->production->hostname = 'foobar';
  102. // Schreibe die Config Datei
  103. $writer = new Zend_Config_Writer_Ini(array('config' => $config,
  104. 'filename' => 'config.ini'));
  105. $writer->write();
  106. ]]></programlisting>
  107. </example>
  108. <note>
  109. <title>Laden einer Config Datei</title>
  110. <para>
  111. Beim Laden einer bestehenden Config Datei für eine Änderung ist es sehr wichtig das alle
  112. Sektionen geladen werden und die Erweiterungen übersprungen werden, sodas keine Werte
  113. zusammengefügt werden. Das wird durch die Übergabe von <emphasis>skipExtends</emphasis>
  114. als Option an den Constructor durchgeführt.
  115. </para>
  116. </note>
  117. </sect1>
  118. <!--
  119. vim:se ts=4 sw=4 et:
  120. -->