5.3. Zend_Config_Ini

Zend_Config_Ini permet aux développeurs de stocker des données de configuration dans le format familier d'un fichier INI et de les lire dans l'application en employant une syntaxe de propriétés d'objet imbriquées. Le format INI est spécialisé pour fournir à la fois la capacité d'avoir une hiérarchie des données de configuration et permettre l'héritage entre les sections de données de configuration. La hiérarchie des données de configuration est supportée grâce au fractionnement des clés à l'aide de points (.). Une section peut être étendue ou héritée d'une autre section en suivant le nom de section avec le caractère de deux points (:) et le nom de la section de laquelle des données doivent être héritées.

[Note] parse_ini_file

Zend_Config_Ini utilise la fonction parse_ini_file() de PHP. Veuillez prendre connaissance de la documentation pour apréhender ses comportements spécifiques, qui se propagent à Zend_Config_Ini, tel que la façon dont les valeurs spéciales : true, false, yes, no et null sont manipulées.

[Note] Séparateur de clé

Par défaut, le séparateur de clé est le caractère point (.), cependant cela peut être changé en changeant la clé de $config "nestSeparator" en construisant l'objet Zend_Config_Ini. Par exemple:

<?php
require_once 'Zend/Config/Ini.php';
$config['nestSeparator'] = ':';
$config = new Zend_Config_Ini('/chemin/vers/config.ini', 'test', $config);?>

Exemple 5.2. Utiliser Zend_Config_Ini

Cet exemple illustre une utilisation de base de Zend_Config_Ini pour le chargement des données de configuration à partir d'un fichier INI. 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.ini :

; Données de configuration du site de production
[production]
webhost           = www.example.com
database.type     = pdo_mysql
database.host     = db.example.com
database.username = dbuser
database.password = secret
database.name     = dbname

; Données de configuration du site de test héritant du site de production
; et surchargeant les clés nécessaires
[test : production]
database.host     = dev.example.com
database.username = devuser
database.password = devsecret

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

<?php
require_once 'Zend/Config/Ini.php';

$config = new Zend_Config_Ini('/chemin/vers/config.ini', 'test');

echo $config->database->host; // affiche "dev.example.com"
echo $config->database->name; // affiche "dbname"?>
[Note] Note

Tableau 5.1. Paramètres du constructeur de Zend_Config_Ini

Paramètres Notes
$filename Le fichier INI à charger.
$section La [section] dans le fichier ini qui doit être chargé. L'affectation de null à ce paramètre au nul chargera toutes les sections. Alternativement, un tableau de noms de section peut être fourni pour charger des sections multiples.
$config = false Tableau de configuration. Les clés suivantes sont supportées :
  • allowModifications : Mettre à true pour permettre la modification du fichier chargé. Par défaut à false.

  • nestSeparator : Caractère à utiliser en tant que séparateur d'imbrication. Par défaut ".".