Skip to content
For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.
  • Documentation >
  • Administration >
  • Configuration >
  • Dynamic configuration

Dynamic configuration

ConfigResolver

Dynamic configuration is handled by the ConfigResolverInterface.

It exposes the hasParameter() and getParameter() methods. You can use them to check the different scopes available for a given namespace to find the appropriate parameter.

To work with the ConfigResolver, your dynamic settings must have the following name format: <namespace>.<scope>.parameter.name.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
parameters:
    # Internal configuration
    ibexa.site_access.config.default.content.default_ttl: 60
    ibexa.site_access.config.site_group.content.default_ttl: 3600

    # Here "myapp" is the namespace, followed by the SiteAccess name as the parameter scope
    # Parameter "my_param" will have a different value in site_group and admin_group
    myapp.site_group.my_param: value
    myapp.admin_group.my_param: another value
    # Defining a default value, for other SiteAccesses
    myapp.default.my_param: Default value

Inside a controller extending the Ibexa\Core\MVC\Symfony\Controller\Controller class, in site_group SiteAccess, you can use the parameters in the following way (the same applies for hasParameter()):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
$configResolver = $this->getConfigResolver();

// ibexa.site_access.config is the default namespace, so no need to specify it
// The following will resolve ibexa.site_access.config.<siteaccessName>.content.default_ttl
// In the case of site_group, it will return 3600.
// Otherwise it will return the value for ibexa.site_access.config.default.content.default_ttl (60)
$locationViewSetting = $configResolver->getParameter( 'content.default_ttl' );

// For you own namespace, you need to specify it, here as "myapp"
$myParamSetting = $configResolver->getParameter( 'my_param', 'myapp' );
// $myParamSetting's value will be 'value'
 
// You can also force the scope by naming it explicitly (here as "admin_group")
$myParamSettingAdmin = $configResolver->getParameter( 'my_param', 'myapp', 'admin_group' );
// $myParamSetting's value will be 'another value'

Tip

To learn more about scopes, see SiteAccess documentation.

Both getParameter() and hasParameter() can take three arguments:

  1. $paramName - the name of the parameter
  2. $namespace - your application namespace, myapp in the previous example. If null, the default namespace is used, which is ibexa.site_access.config by default.
  3. $scope - a SiteAccess name. If null, the current SiteAccess is used.

Inject ConfigResolver into services

You can use the ConfigResolver in your own services whenever needed. To do this, inject the ibexa.config.resolver service:

1
2
3
services:
    App\Service:
        arguments: ['@ibexa.config.resolver']

You can also use the autowire feature, by type hinting against ConfigResolverInterface.

For more information about dependency injection, see Service container.

Note

Don't store the retrieved config value unless you know what you're doing. SiteAccess can change during code execution, which means you might work on the wrong value.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
namespace App;

use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;

class Service
{
    public function __construct(private readonly ConfigResolverInterface $configResolver)
    {
    }

    public function someMethodThatNeedConfig(): void
    {
        $configValue = $this->configResolver->getParameter('my_param', 'myapp');
    }
}
View as Markdown View on GitHub