Zend_Config_Ini
Zend_Config
Programmer's Reference Guide

Zend_Config_Xml

Zend_Config_Xml permet aux développeurs de stocker des données de configuration dans un format simple XML et de les lire grâce à une syntaxe de propriétés d'objets imbriquées. Le nom de l'élément racine du fichier XML n'a pas d'importance et peut être nommé arbitrairement. Le premier niveau des éléments XML correspond aux sections des données de configuration. Le format XML supporte l'organisation hiérarchique par l'emboîtement des éléments XML à l'intérieur des éléments de niveau section. Le contenu d'un élément XML de niveau le plus bas correspond aux données de configuration. L'héritage des sections est supportée par un attribut spécial de XML nommé extends, et la valeur de cet attribut correspond à la section de laquelle des données doivent être héritées.

Note: Type retourné
 Les données de configuration lues grâce à Zend_Config_Xml sont toujours des chaînes de caractères. La conversion des données à partir des chaînes de caractères vers d'autres types de données est laissée aux développeurs en fonction de leurs besoins.

Example #1 Utiliser Zend_Config_Xml

Cet exemple illustre une utilisation de base de Zend_Config_Xml pour le chargement des données de configuration à partir d'un fichier XML. Dans cet exemple il y a des données de configuration pour un environnement de production et pour un environnement de test. Puisque les données de configuration de l'environnement de test sont très semblables à celles de la production, la section de test hérite de la section de production. Dans ce cas, la décision est arbitraire et pourrait avoir été écrite réciproquement, avec la section de production héritant de la section de test, bien que ceci ne doit pas être le cas pour des situations plus complexes. Supposons, que les données suivantes de configuration sont contenues dans /chemin/vers/config.xml :

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production>
  4.         <webhost>www.example.com</webhost>
  5.         <database>
  6.             <adapter>pdo_mysql</adapter>
  7.             <params>
  8.                 <host>db.example.com</host>
  9.                 <username>dbuser</username>
  10.                 <password>secret</password>
  11.                 <dbname>dbname</dbname>
  12.             </params>
  13.         </database>
  14.     </production>
  15.     <test extends="production">
  16.         <database>
  17.             <params>
  18.                 <host>dev.example.com</host>
  19.                 <username>devuser</username>
  20.                 <password>devsecret</password>
  21.             </params>
  22.         </database>
  23.     </test>
  24. </configdata>

Ensuite, supposons que le développeur a besoin des données de configuration de test issues du fichier XML. Il est facile de charger ces données en indiquant le fichier XML et la section de test :

  1. $config = new Zend_Config_Xml('/chemin/vers/config.xml', 'test');
  2.  
  3. echo $config->database->params->host;   // affiche "dev.example.com"
  4. echo $config->database->params->dbname; // affiche "dbname"

Example #2 Utilisation des attributs de balise avec Zend_Config_Xml

Zend_Config_Xml supporte aussi 2 autres manières de définir des noeuds dans la configuration. Celles-ci utilisent les attributs de balises. Puisque les attributs extends et value sont des mots réservés (ce dernier par la seconde manière d'utiliser les attributs), ils ne doivent pas être utilisés. La première manière d'utiliser les attributs est de les ajouter au noeud parent, ils seront ainsi interprétés en tant qu'enfant de ce noeud :

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production webhost="www.example.com">
  4.         <database adapter="pdo_mysql">
  5.             <params host="db.example.com"
  6.                     username="dbuser"
  7.                     password="secret"
  8.                     dbname="dbname"/>
  9.         </database>
  10.     </production>
  11.     <staging extends="production">
  12.         <database>
  13.             <params host="dev.example.com"
  14.                     username="devuser"
  15.                     password="devsecret"/>
  16.         </database>
  17.     </staging>
  18. </configdata>

La seconde manière ne permet pas vraiment de raccourcir la configuration, mais la rend plus facile à maintenir puisque vous n'avez pas à écrire les noms de balises deux fois. Vous créez simplement une balise vide ayant sa valeur dans value :

  1. <?xml version="1.0"?>
  2. <configdata>
  3.     <production>
  4.         <webhost>www.example.com</webhost>
  5.         <database>
  6.             <adapter value="pdo_mysql"/>
  7.             <params>
  8.                 <host value="db.example.com"/>
  9.                 <username value="dbuser"/>
  10.                 <password value="secret"/>
  11.                 <dbname value="dbname"/>
  12.             </params>
  13.         </database>
  14.     </production>
  15.     <staging extends="production">
  16.         <database>
  17.             <params>
  18.                 <host value="dev.example.com"/>
  19.                 <username value="devuser"/>
  20.                 <password value="devsecret"/>
  21.             </params>
  22.         </database>
  23.     </staging>
  24. </configdata>

Note: Chaînes de caractères XML
 Zend_Config_Xml est capable de charger une chaîne de caractères XML directement, par exemple si elle est issue d'une base de données. La chaîne est fournie en tant que premier paramètre du constructeur et doit commencer par les caractères '<?xml' :

  1. $string = <<<EOT
  2. <?xml version="1.0"?>
  3. <config>
  4.     <production>
  5.         <db>
  6.             <adapter value="pdo_mysql"/>
  7.             <params>
  8.                 <host value="db.example.com"/>
  9.             </params>
  10.         </db>
  11.     </production>
  12.     <staging extends="production">
  13.         <db>
  14.             <params>
  15.                 <host value="dev.example.com"/>
  16.             </params>
  17.         </db>
  18.     </staging>
  19. </config>
  20. EOT;
  21.  
  22. $config = new Zend_Config_Xml($string, 'staging');

Note: Espace de noms XML de Zend_Config
 Zend_Config possède son propre espace de noms XML, qui ajoute des fonctionnalités additionnelles lors du processus d'analyse. Pour tirer avantage de celui-ci, vous devez définir l'espace de noms avec l'URI http://framework.zend.com/xml/zesnd-config-xml/1.0/ dans votre noeud racine de configuration.
Avec l'espace de noms activé, vous pouvez maintenant utiliser les constantes PHP à l'intérieur de vos fichiers de configuration. De plus l'attribut extends a été déplacé dans ce nouvel espace de noms et déprécié de l'espace de noms NULL. Il en sera complétement effacé dans Zend Framework 2.0.

  1. $string = <<<EOT
  2. <?xml version="1.0"?>
  3. <config xmlns:zf="http://framework.zend.com/xml/zend-config-xml/1.0/">
  4.     <production>
  5.         <includePath>
  6.             <zf:const zf:name="APPLICATION_PATH"/>/library</includePath>
  7.         <db>
  8.             <adapter value="pdo_mysql"/>
  9.             <params>
  10.                 <host value="db.example.com"/>
  11.             </params>
  12.         </db>
  13.     </production>
  14.     <staging zf:extends="production">
  15.         <db>
  16.             <params>
  17.                 <host value="dev.example.com"/>
  18.             </params>
  19.         </db>
  20.     </staging>
  21. </config>
  22. EOT;
  23.  
  24. define('APPLICATION_PATH', dirname(__FILE__));
  25. $config = new Zend_Config_Xml($string, 'staging');
  26.  
  27. echo $config->includePath; // Affiche "/var/www/something/library"

Zend_Config_Ini
Zend_Config
Programmer's Reference Guide