Tabbar

En <tab>-tagg refererar till antingen en befintlig eller en ny flik i systemkonfigurationen.

Flikattributsreferens

En <tab>-tagg kan ha följande attribut:

AttributBeskrivningTypObligatoriskt
idDefinierar den identifierare som används för att referera till avsnittet.typeIdobligatoriskt
translateDefinierar det fält som ska vara översättningsbart. Ange label för att göra etiketten översättningsbar.stringvalfri
sortOrderDefinierar sorteringsordningen för avsnittet. Ett högt antal flyttar avsnittet längst ned på sidan och ett lågt antal flyttar avsnittet uppåt.floatvalfri
classLägger till en definierad CSS-klass i det återgivna flikelementet HTML.stringvalfri

Fliknodreferens

En <tab>-tagg kan ha följande underordnade taggar:

NodBeskrivningTyp
labelDefinierar den etikett som visas i förgrunden.string

Exempel: Skapa en flik

I följande kodutdrag visas hur du skapar en ny flik med exempeldata.

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
    <system>
        <tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
            <label>A meaningful label</label>
        </tab>
    </system>
</config>

Ovanstående kodutdrag skapar en ny flik med identifieraren A_UNIQUE_ID. När attributet translate definieras och refererar till etiketten, kan label-noden översättas. Under återgivningsprocessen kommer CSS-klassen a-custom-css-class-to-style-this-tab att användas på elementet HTML som skapades för den här fliken.
sortOrder-attributet med värdet 10 definierar tabbens position i listan över alla flikar när de återges.

Avsnitt

En <section>-tagg refererar till antingen ett befintligt eller ett nytt avsnitt i systemkonfigurationen.

Avsnittsattributreferens

En <section>-tagg kan ha följande attribut:

AttributBeskrivningTypObligatoriskt
idDefinierar den identifierare som används för att referera till avsnittet.typeIdobligatoriskt
translateDefinierar det fält som ska vara översättningsbart. Ange label för att göra etiketten översättningsbar.stringvalfri
typeDefinierar indatatypen för det återgivna HTML-elementet. Standardvärdet är text.stringvalfri
sortOrderDefinierar sorteringsordningen för avsnittet. Ett högt tal flyttar avsnittet längst ned på sidan och ett lågt värde flyttar avsnittet uppåt.floatvalfri
showInDefaultDefinierar om avsnittet visas i standardkonfigurationsomfånget. Ange 1 om du vill visa avsnittet och 0 om du vill dölja avsnittet.intvalfri
showInStoreDefinierar om avsnittet visas på butiksnivå. Ange 1 om du vill visa avsnittet och 0 om du vill dölja avsnittet.intvalfri
showInWebsiteDefinierar om avsnittet visas på webbplatsnivå. Ange 1 om du vill visa avsnittet och 0 om du vill dölja avsnittet.intvalfri
canRestoreAnger om avsnittet kan återställas till standardvärdet.intvalfri
advancedBorttagen sedan 10.0.2.boolvalfri
extendsGenom att ange en identifierare för ett annat avsnitt kommer innehållet i den här noden att utöka det avsnitt som du refererade till.stringvalfri

Avsnittsnodreferens

En <section>-tagg kan ha följande underordnade taggar:

NodBeskrivningTyp
labelDefinierar den etikett som visas i förgrunden.string
classLägger till en definierad CSS-klass i det återgivna avsnittets HTML-element.string
tabRefererar till den associerade fliken. Förväntar flikens ID.typeTabId
header_cssVarken använt eller utvärderat vid tidpunkten för detta skrivande.string
resourceRefererar till en ACL-resurs för att ange behörighetsinställningar för det här avsnittet.typeAclResourceId
groupDefiniera en eller flera undergrupper.typeGroup
frontend_modelAnger en annan kantmodell för att ändra återgivningen och ändra utdata.typeModel
includeAnvänds för att inkludera ytterligare system_include.xsd-kompatibla filer. Används vanligen för att strukturera stora system.xml filer.includeType

Exempel: Skapa ett avsnitt och tilldela det till en flik

Följande kodfragment visar hur du använder det till att skapa ett nytt avsnitt.

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
    <system>
        <tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
            <label>A meaningful label</label>
        </tab>

        <section id="A_UNIQUE_SECTION_ID" showInDefault="1" showInWebsite="0" showInStore="1" sortOrder="10" translate="label">
            <label>A meaningful section label</label>
            <tab>A_UNIQUE_ID</tab>
            <resource>VENDOR_MODULE::path_to_the_acl_resource</resource>
        </section>
    </system>
</config>

Avsnittet som beskrivs ovan definierar ID:t A_UNIQUE_SECTION_ID, som är synligt i standardkonfigurationsvyn och i en butikskontext. label-noden är översättningsbar. Avsnittet är associerat med fliken med ID:t A_UNIQUE_ID. Avsnittet kan bara nås av användare som har de behörigheter som definierats i åtkomstkontrollistan VENDOR_MODULE::path_to_the_acl_resource.

Grupper

Taggen <group> används för att gruppera fält tillsammans.

Gruppattributreferens

En <group>-tagg kan ha följande attribut:

AttributBeskrivningTypObligatoriskt
idDefinierar den identifierare som används som referens för gruppen.typeIdobligatoriskt
translateDefinierar de fält som ska vara översättningsbara. Ange label för att göra etiketten översättningsbar. Flera fält ska avgränsas med ett blanksteg.stringvalfri
typeDefinierar indatatypen för det återgivna HTML-elementet. Standardvärdet är text.stringvalfri
sortOrderDefinierar sorteringsordningen för avsnittet. Ett högt tal flyttar avsnittet längst ned på sidan och ett lågt värde flyttar avsnittet uppåt.floatvalfri
showInDefaultDefinierar om gruppen visas i standardkonfigurationsomfånget. Ange 1 om du vill visa gruppen och 0 om du vill dölja gruppen.intvalfri
showInStoreDefinierar om gruppen visas på butiksnivå. Ange 1 om du vill visa gruppen och 0 om du vill dölja gruppen.intvalfri
showInWebsiteDefinierar om gruppen visas på webbplatsnivå. Ange 1 om du vill visa gruppen och 0 om du vill dölja gruppen.intvalfri
canRestoreDefinierar om gruppen kan återställas till standardvärdet.intvalfri
advancedBorttagen sedan 10.0.2.boolvalfri
extendsGenom att ange en identifierare för en annan grupp kommer innehållet i den här noden att utöka det avsnitt som du refererade till.stringvalfri

Gruppnodreferens

En <group>-tagg kan ha följande underordnade taggar:

NodBeskrivningTyp
labelDefinierar den etikett som visas i förgrunden.string
fieldset_cssLägger till en eller flera CSS-klasser i en gruppfältuppsättning.string
frontend_modelAnger en annan kantmodell för att ändra återgivningen och ändra utdata.typeModel
clone_modelAnger en angiven modell för att klona fält.typeModel
clone_fieldsKloning av fält har aktiverats eller inaktiverats.int
help_urlKan inte utökas. Se nedan.typeUrl
more_urlKan inte utökas. Se nedan.typeUrl
demo_linkKan inte utökas. Se nedan.typeUrl
commentLägger till en kommentar under gruppetiketten. Genom att använda <![CDATA[//]]> HTML kan du använda det.string
hide_in_single_store_modeAnger om gruppen ska vara synlig i läget för en enskild butik. 1 döljer gruppen. 0 visar gruppen.int
fieldDefiniera ett eller flera fält som ska vara tillgängliga under gruppen.field
groupDefiniera en eller flera undergrupper.unbounded
dependsKan användas för att deklarera beroenden för andra fält. Används endast för att visa specifika fält/grupper när ett angivet fält har värdet 1. Den här noden förväntar sig en section/group/field-sträng.depends
attributeAnpassade attribut kan användas av klientmodeller. Används vanligen för att göra en viss kantmodell mer dynamisk.attribute
includeAnvänds för att inkludera ytterligare system_include.xsd-kompatibla filer. Används vanligen för att strukturera stora system.xml filer.includeType
VARNING
Noderna more_url, demo_url och help_url definieras av en PayPal-frontmodell som bara används en gång. Dessa noder kan inte återanvändas.

Exempel: Skapa en grupp för ett visst avsnitt

Följande kodfragment visar hur du kan skapa en ny grupp.

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
    <system>
        <tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
            <label>A meaningful label</label>
        </tab>

        <section id="A_UNIQUE_SECTION_ID" showInDefault="1" showInWebsite="0" showInStore="1" sortOrder="10" translate="label">
            <label>A meaningful section label</label>
            <tab>A_UNIQUE_ID</tab>
            <resource>VENDOR_MODULE::path_to_the_acl_resource</resource>

            <group id="A_UNIQUE_GROUP_ID" translate="label comment" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="1">
                <label>A meaningful group label</label>
                <comment>An additional comment helping users to understand the effect when configuring the fields defined in this group.</comment>
                <!-- Add your fields here. -->
            </group>
        </section>
    </system>
</config>

Den grupp som beskrivs ovan definierar ID:t A_UNIQUE_GROUP_ID, som är synligt i standardkonfigurationsvyn och i en butikskontext. Både label och comment är markerade som översättningsbara.

Fält

Taggen <field>-Tag används i <group>-taggar för att definiera specifika konfigurationsvärden.