Information

CraueConfigBundle manages configuration settings stored in the database and makes them accessible via a service in your Symfony2 project. These settings are similar to those defined in parameters.yml but can be modified at runtime, e.g. by an admin user.

Installation

Please use tag 1.0.0 of this bundle if you need Symfony 2.0.x compatibility.

Get the bundle

Let Composer download and install the bundle by running

php composer.phar require craue/config-bundle:~1.1

in a shell.

Enable the bundle

// in app/AppKernel.php
public function registerBundles() {
	$bundles = array(
		// ...
		new Craue\ConfigBundle\CraueConfigBundle(),
	);
	// ...
}

Create the table

Preferably, you do this by calling

# in a shell
php app/console doctrine:migrations:diff
php app/console doctrine:migrations:migrate

or

# in a shell
php app/console doctrine:schema:update

or however you like.

Add the route to manage settings (optional)

You can either import the default routing configuration

# in app/config/routing.yml
craue_config_settings:
  resource: "@CraueConfigBundle/Resources/config/routing/settings.xml"
  prefix: /settings

...or add your own to have full control over the URL pattern.

# in app/config/routing.yml
craue_config_settings_modify:
  pattern: /settings/modify
  defaults:
    _controller: CraueConfigBundle:Settings:modify

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

$this->get('craue_config')->get('name-of-a-setting')

to retrieve the value of the setting name-of-a-setting. Furthermore, you can call

$this->get('craue_config')->all()

to get an associative array of all defined settings and their values.

Writing settings

With the same service you can set new values of settings:

$this->get('craue_config')->set('name-of-a-settings', 'new value');
$this->get('craue_config')->setMultiple(array('setting-1' => 'foo', 'setting-2' => 'bar'));

Keep in mind that the setting has to be present, or an exception will be thrown.

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:

# in app/config/parameters.yml
parameters:
  craue_config.redirectRouteAfterModify: craue_config_settings_modify

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:

# in app/config/parameters.yml
parameters:
  craue_config.configTemplate.sectionOrder: [section1, section2, section3]

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.

# in app/Resources/CraueConfigBundle/translations/CraueConfigBundle.en.yml
name-of-a-setting: name of the setting

# in app/Resources/CraueConfigBundle/translations/CraueConfigBundle.de.yml
name-of-a-setting: Name der Einstellung