Configuration

INFO

Configurations for apps adhere to the same schema as Plugin Configurations.

To offer configuration possibilities to your users you can provide a config.xml file that describes your configuration options. You can find detailed information about the possibilities and the structure of the config.xml in the according documentation page. To include a config.xml file in your app put it into the Resources/config folder:

...
└── DemoApp
      └── Resources
            └── config  
                  └── config.xml
      └── manifest.xml

The configuration page will be displayed in the Administration under Extensions > My extensions. For development purposes you can use the Administration component to configure plugins to provide configuration for your app, therefore use the URL {APP_URL}/admin#/sw/extension/config/{appName}.

Reading the configuration values

The configuration values are saved as part of the SystemConfig and you can use the key {appName}.config.{fieldName} to identify the values. There are two possibilities to access the configuration values from your app. If you need those values on your app-backend server, you can read them over the API. If you need the configuration values in your Storefront twig templates you can use the systemConfig()-twig function.

Reading the config over the API

To access your apps configuration over the API make a GET request against the /api/_action/system-config route. You have to add the prefix for your configuration as the domain query parameter. Optionally you can provide a SalesChannelId, if you want to read the values for a specific SalesChannel, as the salesChannelId query param. The API call will return a JSON-Object containing all of your configuration values. A sample Request and Response may look like this.

GET /api/_action/system-config?domain=DemoApp.config&salesChannelId=98432def39fc4624b33213a56b8c944d

{
    "DemoApp.config.field1": true,
    "DemoApp.config.field2": "successfully configured"
}

WARNING

Keep in mind that your app needs the system_config:read permission to access this API.

Writing the config over the API

To write your app's configuration over the API, make a POSTrequest against the /api/_action/system-config route. You have to provide the configurations as JSON object and optionally provide a salesChannelId query param, if you want to write the values for a specific Sales Channel.

POST /api/_action/system-config?salesChannelId=98432def39fc4624b33213a56b8c944d
Content-Type: application/json

{
    "DemoApp.config.field1": true
}

WARNING

Keep in mind that your app needs the system_config:update, system_config:create and system_config:delete permission to access this API.

Reading the config in templates

Inside twig templates you can use the twig function config (see Shopware Twig functions). An example twig template could look like this:

{{ config('DemoApp.config.field1') }}

Reading the config in app scripts

In app scripts you have access to the config service, that can be used to access config values.

INFO

Note that app scripts were introduced in Shopware 6.4.8.0, and are not supported in previous versions.

The config service provides an app() method, that can be used to access your app's configuration. When using this method you don't need to provide the {appName}.config prefix and your app does not need any additional permissions.

{% set configValue = services.config.app('field1') %}

Additionally, you can use the get() method, to access any configuration value and not just the ones of your app.

WARNING

Keep in mind that your app needs the system_config:read permission to use the config.get() method.

{% set configValue = services.config.get('core.listing.productsPerPage') %}

For a detailed description about app scripts refer to this guide.

For a full description of the config service take a look at the service's reference.