Ce fichier contient les paramètres de configuration communs à tous les points d'entrée ou environnements, et également les valeurs par défaut.

Exemple d'un fichier mainconfig.ini.php (extrait) :

locale = "fr_FR"
charset = "ISO-8859-1"
timeZone = "Europe/Paris"
theme = default

[modules]
mymodule.enabled = on
jauth.enabled = on


[coordplugins]
;...

[responses]
;...

Il s'agit d'un fichier de configuration spécifique à un point d'entrée. Il ne contiendra donc que les valeurs spécifiques pour le point d'entrée, et peut bien sûr redéfinir des paramètres définis dans le fichier commun.

Il peut y avoir un exemplaire dans app/system/ mais aussi dans var/config si il y a des paramètres propres à l'environnement du serveur.

Pour les requêtes classiques, passant par index.php, on pourrait avoir le fichier app/system/index/config.ini.php. On le met ici dans un sous-répertoire index pour une meilleure organisation. Il peut en effet y avoir des fichiers de configuration de plugins propres à chaque point d'entrée, ça peut donc vite devenir peu lisible dans app/system/.

Dans ce fichier, on ne va redéfinir que certaines choses, comme par exemple :

[coordplugins]
autolocale = index/autolocale.ini.php

[responses]
html=myHtmlResponse

Un fichier localconfig.ini.php est pris en charge. Il est censé contenir la configuration propre à la machine locale, donc différent en fonction de l'environnement : developpement, production, tests... Les paramètres de ce fichier "écrasent" ceux de mainconfig.ini.php.

Bien entendu, en général, ce fichier n'est pas dans votre dépôt de code source.

Depuis Jelix 1.6.18, un fichier liveconfig.ini.php permet de stocker les paramètres qui sont modifiés durant la vie de l'application. Il ne doit donc pas être stocké dans votre dépôt de code source. Les paramètres de ce fichier "écrasent" ceux des autres fichiers mainconfig.ini.php, localconfig.ini.php et celui du point d'entrée.

Il faut savoir qu'il existe un fichier defaultconfig.ini.php, situé dans les sources de Jelix (dans lib/jelix/core/). Il contient une liste exhaustive de tous les paramètres possibles, leurs valeurs par défaut et des commentaires expliquant leur signification.

Ainsi, pour connaître la valeur de tous les paramètres de configuration, Jelix lit les fichiers dans l'ordre suivant et les fusionne :

1. lib/jelix/core/defaultconfig.ini.php,
2. app/system/mainconfig.ini.php
3. app/system/<entrypoint>/config.ini.php
4. var/config/localconfig.ini.php
5. var/config/<entrypoint>/config.ini.php
6. var/config/liveconfig.ini.php

Les valeurs contenues dans un fichier "écrasent" celles du fichiers précédent.

Pour chaque point d'entrée, le contenu résultant de cette fusion est mis en cache.

Les fichiers ini sont lus par parse_ini_file, et de ce fait les valeurs qui s'y trouvent peuvent prendre différente forme :

1. Vous pouvez indiquer des constantes PHP :

# quelque part dans un fichier inclus par votre index.php
define("SOMETHING", "hello world");

Un des fichiers ini de configuration :

foo = SOMETHING

Et foo vaudra donc "hello world".

1. Vous pouvez indiquer des variables d'environnement.

# variables définies dans l'environnement de PHP-FPM, PHP-CLI, ou Apache (avec le module PHP)
MYAPP_MYSQL_LOGIN=admin
MYAPP_MYSQL_PASSWORD=Sup3Rp4ssw0rd!

Dans votre fichier profiles.ini.php (voir ci-après), il faut utiliser cette notation particulière :

[jdb:default]
driver=mysqli
login= ${MYAPP_MYSQL_LOGIN}
password= ${MYAPP_MYSQL_PASSWORD}

Vous pouvez définir des alias de profils. C'est à dire donner plusieurs noms à un profil. C'est utile par exemple si un module utilise un nom de profil particulier. Il est alors possible d'indiquer que ce nom de profil soit rattaché à un profil existant.

Les alias sont définis dans une section dont le nom contient uniquement le nom du type de connexion.

Un exemple pour jDb, en définissant un alias 'jacl2_profile' :

[jdb]
jacl2_profile = default

[jdb:default]
driver=mysqli
login=
password=

Un alias ne doit pas indiquer le nom d'un autre alias.

Il est possible de définir des paramètres qui sont communs à tous les profils d'un même type. Cela évite de les répéter dans chaque profil. Pour ce faire, il faut les déclarer dans un profil spécial, __common__.

Par exemple, si toutes les connexions aux bases de données SQL (jDb) doivent être persistantes et se font toutes sur le même serveur :

[jdb:__common__]
host=my.server.example.com
persistant=on

Vous pouvez bien sûr redéfinir ces paramètres dans les profils, pour les exceptions.

Vous pouvez utiliser un profil qui n'existe pas dans le fichier profiles.ini.php. Cela permet d'utiliser une connexion dont on ne connaît pas les caractéristiques à l'avance.

Pour cela, avant d'appeler les différentes méthodes du composant concerné, il vous faut déclarer ce profil "virtuel". Vous appellerez alors la méthode createVirtualProfile de l'objet jProfiles qui gère les profils. À cette méthode, vous donnerez le type de profil, un nom de profil, ainsi qu'un tableau de paramètres de connexion.

Exemple :

   $params = array(
       'driver'=>'mysqli',
       'host'=>'localhost',
       'database'=>'jelix',
       'user'=>'toto',
       'password'=>'blabla',
       'persistent'=>false,
       'force_encoding'=>true
   );
   jProfiles::createVirtualProfile('jdb', 'mon_profil', $params);

   $cnx = jDb::getConnection('mon_profil');

Les paramètres communs s'appliquent bien sûr sur les profils virtuels.