Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 4.01 KB

configuration.md

File metadata and controls

92 lines (62 loc) · 4.01 KB
Raw
description
In Ibexa DXP you store and manage configuration in project files, typically in YAML format.

Configuration

[[= product_name =]] configuration is delivered by means of a number of dedicated configuration files. It contains everything from selecting the content repository to SiteAccesses to language settings.

Configuration format

The recommended configuration format is YAML. It's used by default in the kernel (and in examples throughout the documentation). However, you can also use XML or PHP formats for configuration.

Configuration files

Configuration files are located in the config folder. Configuration is provided per package in the config/packages folder, and routes are defined per package in config/routes.

config/packages/ibexa.yaml contains basic configuration. It stores, among others, SiteAccess information and content view config.

Other configuration is provided in respective files, for example, config/packages/ibexa_admin_ui.yaml, config/packages/ibexa_http_cache.yaml.

You can make configuration environment-specific by using separate folders for each environment. These files contain additional settings and point to the general (not environment-specific) configuration that is applied in other cases.

!!! note "New configuration files"

It's good practice to provide your own configuration in separate files.
Any YAML files placed in the `config/packages` folder is automatically included in the system configuration.

!!! tip

Read more about [how configuration is handled in Symfony]([[= symfony_doc =]]/best_practices/configuration.html).

!!! caution "Special characters"

Avoid using special characters in your configuration files. More specifically, don't use Unicode characters from the ["Other" (`C`) categories](https://en.wikipedia.org/wiki/Unicode#General_Category_property), such as control or format characters.

Make sure your IDE displays them.

Be careful when copy-pasting text from a word processing software or a PDF, because it might contain hidden characters like the [soft hyphen](https://en.wikipedia.org/wiki/Soft_hyphen).

Configuration handling

!!! note

Configuration is tightly related to the [service container](php_api.md#service-container).
To fully understand it, you must be familiar with the service container and [its configuration]([[= symfony_doc =]]/service_container.html#service-parameters).

Basic configuration handling in [[= product_name =]] is similar to what is commonly possible with Symfony. You can define key/value pairs in your configuration files.

Internally and by convention, keys follow a dot syntax, where the different segments follow your configuration hierarchy. Keys are usually prefixed by a namespace corresponding to your application. All kinds of values are accepted, including arrays and deep hashes.

For configuration that is meant to be exposed to an end-user (or end-developer), it's usually a good idea to also [implement semantic configuration]([[= symfony_doc =]]/components/config/definition.html).

You can also implement SiteAccess-aware semantic configuration.

For example:

parameters:
    myapp.parameter.name: someValue
    myapp.boolean.param: true
    myapp.some.hash:
        foo: bar
        an_array: [apple, banana, pear]
// Usage inside a controller
$myParameter = $this->container->getParameter( 'myapp.parameter.name' );

Configuration settings

For specific configuration settings, see: