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> vous donne la possibilité d'écrire des
  8. fichiers de configuration à partir d'objets <classname>Zend_Config</classname>. Il
  9. fonctionne avec des adaptateurs détachés du système et est donc très simple à utiliser. Par
  10. défaut <classname>Zend_Config_Writer</classname> embarque trois adaptateurs, qui
  11. fonctionnent tous de la même façon. Vous instanciez un rédacteur ("writer") avec des
  12. options spécifiques, qui peuvent être <emphasis>filename</emphasis> et
  13. <emphasis>config</emphasis>. Ensuite
  14. vous pouvez appeler la méthode <methodname>write()</methodname> du rédacteur et le fichier
  15. de configuration est créé. Vous pouvez aussi fournir <varname>$filename</varname> et
  16. <varname>$config</varname> directement à la méthode <methodname>write()</methodname>.
  17. Actuellement les
  18. rédacteurs suivants sont embarqués avec <classname>Zend_Config_Writer</classname>&#160;:
  19. </para>
  20. <itemizedlist>
  21. <listitem>
  22. <para><classname>Zend_Config_Writer_Array</classname></para>
  23. </listitem>
  24. <listitem>
  25. <para><classname>Zend_Config_Writer_Ini</classname></para>
  26. </listitem>
  27. <listitem>
  28. <para><classname>Zend_Config_Writer_Xml</classname></para>
  29. </listitem>
  30. </itemizedlist>
  31. <para>
  32. Une exception subsiste, <classname>Zend_Config_Writer_Ini</classname> qui a un
  33. paramètre optionnel additionnel <emphasis>nestSeparator</emphasis>, définissant le caractère
  34. séparant les profondeurs d'imbrication. Par défaut il s'agit du point,
  35. comme <classname>Zend_Config_Ini</classname> l'accepte par défaut.
  36. </para>
  37. <para>
  38. Lors de la modification ou la création d'objet <classname>Zend_Config</classname>, il
  39. y a quelques informations à garder en mémoire. Pour créer ou modifier une valeur, vous
  40. appelez simplement le réglage d'un paramètre d'un objet <classname>Zend_Config</classname>
  41. grâce à l'accesseur de paramètre ("<emphasis>-&gt;</emphasis>"). Pour créer une section à
  42. la racine ou pour créer une branche, vous avez juste à créer un nouveau tableau
  43. (<command>$config-&gt;branch = array();</command>). Pour définir quelle section en étend une
  44. autre, vous devez appeler la méthode <methodname>setExtend()</methodname> sur l'objet
  45. <classname>Zend_Config</classname> racine.
  46. </para>
  47. <example id="zend.config.writer.example.using">
  48. <title>Utilisation de Zend_Config_Writer</title>
  49. <para>
  50. Cet exemple illustre une utilisation basique
  51. <classname>Zend_Config_Writer_Xml</classname> pour créer un nouveau fichier de
  52. configuration&#160;:
  53. </para>
  54. <programlisting language="php"><![CDATA[
  55. // Créer l'objet de configuration
  56. $config = new Zend_Config(array(), true);
  57. $config->production = array();
  58. $config->staging = array();
  59. $config->setExtend('staging', 'production');
  60. $config->production->db = array();
  61. $config->production->db->hostname = 'localhost';
  62. $config->production->db->username = 'production';
  63. $config->staging->db = array();
  64. $config->staging->db->username = 'staging';
  65. // Ecrire le fichier de l'une des manières suivantes :
  66. // a)
  67. $writer = new Zend_Config_Writer_Xml(array('config' => $config,
  68. 'filename' => 'config.xml'));
  69. $writer->write();
  70. // b)
  71. $writer = new Zend_Config_Writer_Xml();
  72. $writer->setConfig($config)
  73. ->setFilename('config.xml')
  74. ->write();
  75. // c)
  76. $writer = new Zend_Config_Writer_Xml();
  77. $writer->write('config.xml', $config);
  78. ]]></programlisting>
  79. <para>
  80. Ceci créera un fichier de configuration <acronym>XML</acronym> avec les sections
  81. "production" et "staging", où "staging" étend "production".
  82. </para>
  83. </example>
  84. <example id="zend.config.writer.modifying">
  85. <title>Modifier une configuration existante</title>
  86. <para>
  87. Cet exemple montre comment modifier un fichier de configuration
  88. existant&#160;:
  89. </para>
  90. <programlisting language="php"><![CDATA[
  91. // Charger toutes les sections d'un fichier de configuration existant,
  92. // tout en évitant les sections étendues.
  93. $config = new Zend_Config_Ini('config.ini',
  94. null,
  95. array('skipExtends' => true,
  96. 'allowModifications' => true));
  97. // Modifier une valeur
  98. $config->production->hostname = 'foobar';
  99. // Ecrire le fichier
  100. $writer = new Zend_Config_Writer_Ini(array('config' => $config,
  101. 'filename' => 'config.ini'));
  102. $writer->write();
  103. ]]></programlisting>
  104. </example>
  105. <note>
  106. <title>Chargement d'un fichier de configuration</title>
  107. <para>
  108. Lors du chargement d'un fichier de configuration existant afin de le modifier, il
  109. est très important de charger toutes les sections et d'éviter les sections étendues,
  110. évitant ainsi toute fusion de valeurs. Ceci est réalisé en fournissant l'option
  111. <emphasis>skipExtends</emphasis> au constructeur.
  112. </para>
  113. </note>
  114. </sect1>