Zend_Config_Writer.xml 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18867 -->
  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 Datei
  11. basierend sind. 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. Der Ini Writer hat zwei Modi für die Darstellung bezüglich Sektionen. Standardmäßig wird die
  37. Top-Level Konfiguration immer in Sektionsnamen geschrieben. Durch den Aufruf von
  38. <code>$writer->setRenderWithoutSections()</code> werden alle Optionen in den globalen
  39. Namespace der INI Datei geschrieben und es werden keine Sektionen angehängt.
  40. </para>
  41. <para>
  42. Zusätzlich hat <classname>Zend_Config_Writer_Ini</classname> einen zusätzlichen optionalen
  43. Parameter <emphasis>nestSeparator</emphasis>, welche definiert mit welchem Zeichen die
  44. einzelnen Nodes getrennt werden. Der Standard ist ein einzelner Punkt, wie er standardmäßig
  45. von <classname>Zend_Config_Ini</classname> akzeptiert wird.
  46. </para>
  47. <para>
  48. Wenn ein <classname>Zend_Config</classname> Objekt geändert oder erstellt wird, muß man
  49. einige Dinge wissen. Um einen Wert zu erstellen oder zu ändern muß einfach der Parameter
  50. des <classname>Zend_Config</classname> Objektes über den Zugriffsaccessor
  51. (<emphasis>-&gt;</emphasis>) gesetzt werden. Um eine Sektion im Root oder im Branch zu
  52. erstellen muß einfach ein neues Aray erstellt werden
  53. ("<command>$config-&gt;branch = array();</command>"). Um zu definieren welche Sektion eine
  54. andere erweitert, muß die <methodname>setExtend()</methodname> Methode am Root
  55. <classname>Zend_Config</classname> Objekt aufgerufen werden.
  56. </para>
  57. <example id="zend.config.writer.example.using">
  58. <title>Verwenden von Zend_Config_Writer</title>
  59. <para>
  60. Dieses Beispiel zeigt die grundsätzliche Verwendung von
  61. <classname>Zend_Config_Writer_Xml</classname> um eine neue Konfigurationsdatei zu
  62. erstellen:
  63. </para>
  64. <programlisting language="php"><![CDATA[
  65. // Ein neues Config Objekt erstellen
  66. $config = new Zend_Config(array(), true);
  67. $config->production = array();
  68. $config->staging = array();
  69. $config->setExtend('staging', 'production');
  70. $config->production->db = array();
  71. $config->production->db->hostname = 'localhost';
  72. $config->production->db->username = 'production';
  73. $config->staging->db = array();
  74. $config->staging->db->username = 'staging';
  75. // Die Config Datei auf einem der folgenden Wege schreiben:
  76. // a)
  77. $writer = new Zend_Config_Writer_Xml(array('config' => $config,
  78. 'filename' => 'config.xml'));
  79. $writer->write();
  80. // b)
  81. $writer = new Zend_Config_Writer_Xml();
  82. $writer->setConfig($config)
  83. ->setFilename('config.xml')
  84. ->write();
  85. // c)
  86. $writer = new Zend_Config_Writer_Xml();
  87. $writer->write('config.xml', $config);
  88. ]]></programlisting>
  89. <para>
  90. Das erstellt eine <acronym>XML</acronym> Config Datei mit den Sektionen production und
  91. staging, wobei staging production erweitert.
  92. </para>
  93. </example>
  94. <example id="zend.config.writer.modifying">
  95. <title>Eine bestehende Config ändern</title>
  96. <para>
  97. Dieses Beispiel zeigt wie eine bestehende Config Datei bearbeitet werden kann.
  98. </para>
  99. <programlisting language="php"><![CDATA[
  100. // Lädt alle Sektionen einer bestehenden Config Datei, und überspringt
  101. // alle Erweiterungen
  102. $config = new Zend_Config_Ini('config.ini',
  103. null,
  104. array('skipExtends' => true,
  105. 'allowModifications' => true));
  106. // Ändere einen Wert
  107. $config->production->hostname = 'foobar';
  108. // Schreibe die Config Datei
  109. $writer = new Zend_Config_Writer_Ini(array('config' => $config,
  110. 'filename' => 'config.ini'));
  111. $writer->write();
  112. ]]></programlisting>
  113. </example>
  114. <note>
  115. <title>Laden einer Config Datei</title>
  116. <para>
  117. Beim Laden einer bestehenden Config Datei für eine Änderung ist es sehr wichtig das alle
  118. Sektionen geladen werden und die Erweiterungen übersprungen werden, sodas keine Werte
  119. zusammengefügt werden. Das wird durch die Übergabe von <emphasis>skipExtends</emphasis>
  120. als Option an den Constructor durchgeführt.
  121. </para>
  122. </note>
  123. <para>
  124. Für alle Datei-basierenden Writer (INI, XML und PHP Array) wird intern
  125. <methodname>render()</methodname> verwendet um den Konfigurationsstring zu erstellen. Diese
  126. Methode kann auch von ausserhalb aus verwendet werden wenn man Zugriff auf eine
  127. String-Repräsentation der Konfigurationsdaten benötigt.
  128. </para>
  129. </sect1>
  130. <!--
  131. vim:se ts=4 sw=4 et:
  132. -->