Download the PHP package nti/config-bundle without Composer
On this page you can find all versions of the php package nti/config-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package config-bundle
Information
CraueConfigBundle manages configuration settings stored in the database and makes them accessible via a service in your
Symfony project. These settings are similar to those defined in parameters.yml
but can be modified at runtime, e.g.
by an admin user.
Installation
Get the bundle
Let Composer download and install the bundle by running
in a shell.
Enable the bundle
Create the table
Preferably you do this by calling
or
or however you like.
Add the route to manage settings (optional)
You can either import the default routing configuration
...or add your own to have full control over the URL pattern.
Usage
Defining settings
This bundle does not provide functionality to create new settings because this would make no sense at runtime.
Those settings will be used in your application and thus code needs to be written for that.
This means that you have to create new settings in the database table craue_config_setting
yourself, e.g. using a
migration.
Managing settings' values
If you added the route described above you can manage the values of all defined settings in a simple form.
By default, you can access that form by browsing to app_dev.php/settings/modify
.
But you probably want to limit access to this form in your security configuration.
Reading settings
The bundle provides a service called craue_config
. Inside of a controller you can call
to retrieve the value of the setting name-of-a-setting
. Furthermore, you can call
to get an associative array of all defined settings and their values.
will fetch only settings with the specified section (or those without a section if explicitly passing null
for the name).
Writing settings
With the same service you can set new values of settings:
Keep in mind that the setting has to be present, or an exception will be thrown.
Usage in Twig templates
The Twig extension in this bundle supports reading settings directly in your template.
Enable caching (optional)
To reduce the number of database queries, you can set up a cache for settings. First, you have to choose which cache implementation you'd like to use. Currently, there are adapters available for:
Refer to the documentation of each implementation for details and read on in the corresponding section below. When
done, CraueConfigBundle
will automatically cache settings (using the built-in craue_config_cache_adapter
service).
Keep in mind to clear the cache (if needed) after modifying settings outside of your app (e.g. by Doctrine migrations):
Cache implementation: DoctrineCacheBundle
Set the parameter craue_config.cache_adapter.class
appropriately and configure a so-called cache provider with the
alias craue_config_cache_provider
:
Cache implementation: Symfony Cache component
Set the parameter craue_config.cache_adapter.class
appropriately and configure a so-called cache pool with the
service id craue_config_cache_provider
:
Customization
Redirect to a different page after submitting the built-in form
If you've enabled the build-in form, you can define where to redirect on successfully saving the changes by setting the target route name:
Rendering of settings in sections
If you want to render settings in a group (called section here), you'll have to assign those settings a common section name (in the database). Optionally, you can influence the order of these sections:
Settings without a section will be rendered at first. Sections without explicit ordering are rendered at last.
Translation
You can add translations for all settings (and sections) to be shown in the form by adding them to translation files
with the CraueConfigBundle
domain, e.g.
Using a custom entity for settings
The custom entity has to provide a mapping for the field value
. The class BaseSetting
defines this field, but no
mapping for it. This allows easy overriding, including the data type. In the following example, the value
field will
be mapped to a text
column, which will in turn render the built-in form fields as textarea
.
So create the entity and its appropriate mapping:
And make the bundle aware of it:
All versions of config-bundle with dependencies
doctrine/doctrine-bundle Version ~1.3
symfony/framework-bundle Version ~2.7|~3.0|~4.0