tIniFile

tIniFile est un composant PHP permettant la manipulation des fichiers de configurations type ".ini".
PHP ne prenant en charge que la lecture des fichiers de configuration, tIniFile vient en complétion en proposant des méthodes de manipulation des sections, clés et valeurs.

Méthodes disponibles

sectionExists($section)

La méthode sectionExists() permet de déterminer si une section existe dans le fichier de configuration.
$section indique la section du fichier INI dont sectionExists() détermine l'existence.
sectionExists() renvoie une valeur booléenne indiquant si la section spécifiée existe.

readValue($section, $ident, $default = '')

Appelez readValue() pour lire une valeur chaîne dans un fichier INI.

$section identifie la section qui contient la clé voulue.
$ident spécifie le nom de la clé contenant la valeur chaîne à lire.
$default est la valeur chaîne à renvoyer si :
- la section n'existe pas
- la clé n'existe pas
- la valeur de données n'a pas été affectée pour la clé

writeValue($section, $ident, $value, $type)

Appelez writeValue() pour écrire une valeur chaîne dans un fichier INI.

$section identifie la section de fichier contenant la clé dans laquelle il faut écrire.
$ident est le nom de la clé pour laquelle une valeur doit être définie.
$value est la valeur chaîne à écrire.

Remarque : Les tentatives d'écriture de valeurs dans une section inexistante ou d'écriture de données dans des clés inexistantes ne sont pas considérées comme des erreurs. Dans une telle situation, writeValue crée la section et la clé et définit la valeur initiale à $value.

readSection($section)

Appelez readSection() pour lire les noms des clés contenues dans une section donnée d'un fichier INI et les placer dans un tableau associatif.

$section identifie la section contenant la liste de noms de clés.
Retourne un booleen si la section n'existe pas.

readSections()

Appelez readSections() pour lire le nom de toutes les sections d'un fichier INI dans un tableau associatif.

eraseSection($section)

Appelez eraseSection() pour supprimer dans un fichier INI une section, toutes ses clés et leurs valeurs.

$section identifie le nom de la section à supprimer dans le fichier INI.
Lorsqu'une section ne peut pas être supprimée (n'existe pas), un booléen est transmis.

deleteKey($section, $ident)

Appelez deleteKey() pour supprimer un ensemble clé / valeur associé à une entrée de fichier INI.

$section est la chaîne qui contient le nom de la section d'un fichier INI
$ident est une chaîne contenant le nom de la clé pour laquelle attribuer une valeur nulle.

valueExists($section, $ident)

La méthode valueExists() permet de déterminer si une clé existe dans le fichier INI spécifié par fileName.

$section spécifie la section du fichier INI dans laquelle rechercher la clé.
$ident spécifie le nom de la clé à rechercher.
valueExists() renvoie une valeur booléenne indiquant si la clé spécifiée existe dans la section spécifiée.

Exemple de code

require_once 'tIniFile.class.php';

// Initialisation du composant
$iniFile = new TIniFile('/www/site/config.ini');

// Lecture de toutes les sections du fichier dans un tableau associatif
$sections = $iniFile->readSections();

// Lecture d'une section particulière dans un tableau associatif
$sectionBDD = $iniFile->readSection('BDD');

// Modification d'une valeur pour la section BDD
$iniFile->writeValue('BDD', 'user', 'root');

// Création d'une valeur pour la section BDD : fonctionnement similaire, si la clé n'existe pas, elle est créée dynamiquement
$iniFile->writeValue('BDD', 'password', 'rootpassword');

// Suppression de la clé précédemment créé
$iniFile->deleteKey('BDD', 'password');

// Suppression de la section BDD
$iniFile->eraseSection('BDD');

unset($iniFile);

Pré-requis

PHP 5.x et supérieur

Téléchargement

License

Creative Commons License Cette création est mise à disposition sous un contrat Creative Commons. Cela signifie que vous êtes libre de reproduire, distribuer et communiquer cette création au public. Si vous disposez d'un site internet, il n'est nullement obligatoire mais serait grandement appréciable de faire une référence à la présente page.