Fichier de configuration du module

Le fichier config.xml est le fichier qui définit un module. Il est utilisé par NexoPOS pour identifier un module et le distinguer des autres modules. Cela vous expliquera tout ce que vous devez savoir sur le fichier config.xml.

Structure du fichier config.xml

Ce fichier se trouve à la racine de chaque module. Un module qui ne possède pas ce fichier n’est pas un module valide et pourrait même ne pas apparaître comme module dans le tableau de bord. Ce fichier doit avoir une structure spécifique, comme suit :

<?xml version="1.0" ?>
<module>
    <namespace>NsStockTransfers</namespace>
    <version>4.5.1</version>
    <author>Blair Jersyer</author>
    <name>Stock Transfers Module</name>
    <description>module description</description>
</module>

La balise « module » est un paramètre obligatoire. En tant qu’élément enfant, elle contient les balises suivantes

• namespace (required): a unique identifier of the module. Should not have any space or special character.
• version (required): the actual version of the module.
• author (required): The name of the author.
• name (required): A human name for the module. This will be displayed on the module list.
• description (required): a brief description of the module. This will also be displayed on the modules list.

Définition de la dépendance

Si vous souhaitez exiger certains modules avant qu’un module puisse être activé, vous devez définir une balise « requires » qui accepte, en tant que sous-balises, les modules que vous souhaitez exiger.

<requires>
        <dependency namespace="NsMultiStore" min-version="6.1.0">Nexo Multi Store Module</dependency>
</requires>

Dans l’exemple précédent, nous avons défini comme dépendance « NsMultiStore », qui doit être au moins à la version « 6.1.0 ».

Nous pouvons également définir une « version maximale » pour fixer la version maximale autorisée.

Version du noyau de force

Si vous souhaitez que le module soit compatible avec une version spécifique de NexoPOS, vous pouvez définir la version du cœur à l’aide de la balise « core », comme ceci.

<core min-version="6.1.0" max-version="6.1.9"/>

Dans l’exemple précédent, nous demandons la version « 6.1.0 » de NexoPOS et définissons la version maximale à « 6.1.9 ».

Localisation

À partir de NexoPOS 6.x, nous avons introduit la localisation dans la description du module. L’idée est de rendre la description largement compréhensible pour des publics qui ne parlent pas anglais (qui était la valeur par défaut). Cela nécessite d’ajouter un enfant à la balise de description, la balise « locale », comme suit :

...
<description>
    <locale lang="en">Here is an english description</locale>
    <locale lang="fr">Voici une description en français</locale>
</description>
...