Modul-Konfigurationsdatei

Die config.xml ist die Datei, die ein Modul definiert. Sie wird von NexoPOS verwendet, um ein Modul zu identifizieren und es von anderen Modulen zu unterscheiden. Das erklärt alles, was Sie über die config.xml-Datei wissen müssen.

Struktur der config.xml-Datei

Diese Datei befindet sich im Stammverzeichnis jedes Moduls. Ein Modul, das diese Datei nicht enthält, ist kein gültiges Modul und wird möglicherweise sogar nicht als Modul im Dashboard angezeigt. Diese Datei muss eine bestimmte Struktur haben, etwa so:

<?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>

Das Tag „module“ ist ein erforderlicher Parameter. Als untergeordnetes Element hat es die folgenden Tags:

• 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.

Abhängigkeit definieren

Wenn Sie bestimmte Module vorschreiben möchten, bevor ein Modul aktiviert werden kann, sollten Sie ein „requires“-Tag definieren, das als Unter-Tags die Module akzeptiert, die Sie als Voraussetzung festlegen möchten.

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

Im vorherigen Beispiel haben wir als Abhängigkeit „NsMultiStore“ festgelegt, das mindestens in der Version „6.1.0“ vorliegen muss.

Wir können auch eine „max-version“ definieren, um die maximal zulässige Version festzulegen.

Core-Version erzwingen

Wenn Sie möchten, dass das Modul mit einer bestimmten Version von NexoPOS kompatibel ist, können Sie die Kernversion mithilfe des „core“-Tags wie folgt festlegen.

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

Im vorherigen Beispiel fordern wir die Version „6.1.0“ von NexoPOS an und setzen die maximale Version auf „6.1.9“.

Lokalisierung

Ab NexoPOS 6.x haben wir die Lokalisierung in der Modulbeschreibung eingeführt. Die Idee ist, die Beschreibung für Zielgruppen, die kein Englisch sprechen (was die bisherige Standardeinstellung war), allgemein verständlich zu machen. Dazu muss ein untergeordnetes Element des Description-Tags hinzugefügt werden, das „locale“-Tag, wie folgt:

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