Manual:Configuration for developers/fr


 * Pour la documentation concernant la configuration de MediaWiki, voir le manuel de Configuration.

Ceci est un guide pour les développeurs du noyau et des extensions à propos de la création et de l'accès aux paramètres de configuration.



Pour le noyau
Pour accéder à un paramètre de configuration tel que :

Si vous avez accès à aucun objet ContextSource, vous pouvez obtenir un objet Config avec :

Ceci ne doit pas être utilisé pour récupérer des objets de variable globale comme ou.



Pour les extensions


Configuration utilisant (recommandée)
Les extensions qui ont un fichier  doivent initialiser les paramètres de configuration tel qu'il est écrit dans cette section.

Si votre extension s'appelle, dans   vous écrirez :

En PHP, lorsque vous souhaitez les valeurs de vos paramètres de configuration :

If the prefix for your configuration keys is not the default "wg", you can specify it with the  or   key, depending on the schema version (see docs). Vous devez vous assurer qu'il n'y a pas de collision avec les paramètres d'une autre extension.

Il est très recommandé que le nom de la clé de configuration commence par le nom de votre extension (comme dans l'exemple), pour s'assurer que la clé de configuration est unique, parmi toutes les clés de toutes les applications. Not doing this is a bad idea, and will probably break the use of attributes.



Configuration utilisant les variables globales
Si vous le pouvez, utilisez le fichier  pour la configuration (voir ci-dessus). Sinon, utilisez le code suivant (ne fonctionne qu'avec des variables préfixées par ) :



Préfixes personnalisés
In the past, some extensions used "eg" instead of "wg". We want to move away from prefixes, but you can still continue to use them:

If you use extension registration, there is a  or   (depending on the schema version) field you can use instead.

Tests
When debugging, you use the following to test that you are accessing the right Config instance. You should do this in place of the $wgConfigRegistry shown in the for extensions section above.

If you are accessing the wrong Config instance, a will be produced.

For modifying configuration variables in PhpUnit tests in extensions using manifest version 1 (or in MediaWiki core), you can do the following in test cases that extend : ´



Modification des paramètres de configuration par programme
The only Config implementation that supports is, which is mostly used in tests.

One way to modify values from the MainConfig service is via the hook, but this is discouraged. Instead, a hook should be used to allow more controlled and explicit modification of the relevant values.



Mise à jour d'une version antérieure à MediaWiki 1.23
In MediaWiki 1.23 a new  interface was introduced to access configuration options. This allowed us to abstract the backends in which we store configuration options.

Pre-1.23 code would look like:

1.23+ code should look like this:

You'll notice a few changes here:
 * We use to get the default   object. Most contexts implement.
 * Rather than checking for "wgFoo", you ask the Config object for "Foo", without any wg prefix.



Voir aussi

 * Manual:$wgConfigRegistry
 * Manual:Config.php
 * Legoktm's presentation at the 2015 MediaWiki Developer Summit