PHPackages nti/config-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. nti/config-bundle ActiveSymfony-bundle[Utility & Helpers](/categories/utility) nti/config-bundle ================= Database-stored settings made available via a service for your Symfony project. 2.1.0(8y ago)015MITPHPPHP ^5.3.9|~7.0 Since May 26Pushed 8y agoCompare [ Source](https://github.com/ntidev/CraueConfigBundle)[ Packagist](https://packagist.org/packages/nti/config-bundle)[ Docs](https://github.com/craue/CraueConfigBundle)[ RSS](/packages/nti-config-bundle/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependencies (7)Versions (16)Used By (0) Information =========== [](#information) [![Build Status](https://camo.githubusercontent.com/2b1510588f72e9422b1497292fa354e9b6fd15bdf80a97fee4527ecf42a71ae6/68747470733a2f2f7472617669732d63692e6f72672f63726175652f4372617565436f6e66696742756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/craue/CraueConfigBundle)[![Coverage Status](https://camo.githubusercontent.com/e95755353bbcedfda520f3371c12f856387ea775b078589ab3dfaef365c81e69/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f63726175652f4372617565436f6e66696742756e646c652f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/craue/CraueConfigBundle?branch=master) 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 ============ [](#installation) Get the bundle -------------- [](#get-the-bundle) Let Composer download and install the bundle by running ``` php composer.phar require craue/config-bundle:~2.1 ``` in a shell. Enable the bundle ----------------- [](#enable-the-bundle) ``` // in app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Craue\ConfigBundle\CraueConfigBundle(), ); // ... } ``` Create the table ---------------- [](#create-the-table) Preferably you do this by calling ``` # in a shell (run `bin/console` instead of `app/console` if your project is based on Symfony 3) php app/console doctrine:migrations:diff php app/console doctrine:migrations:migrate ``` or ``` # in a shell (run `bin/console` instead of `app/console` if your project is based on Symfony 3) php app/console doctrine:schema:update ``` or however you like. Add the route to manage settings (optional) ------------------------------------------- [](#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: path: /settings/modify defaults: _controller: CraueConfigBundle:Settings:modify ``` Usage ===== [](#usage) Defining settings ----------------- [](#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 ------------------------- [](#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 ---------------- [](#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. ``` $this->get('craue_config')->getBySection('name-of-a-section') ``` will fetch only settings with the specified section (or those without a section if explicitly passing `null` for the name). Writing settings ---------------- [](#writing-settings) With the same service you can set new values of settings: ``` $this->get('craue_config')->set('name-of-a-setting', '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. Usage in Twig templates ----------------------- [](#usage-in-twig-templates) The Twig extension in this bundle supports reading settings directly in your template. ``` {{ craue_setting('name-of-a-setting') }} ``` Enable caching (optional) ========================= [](#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: - [DoctrineCacheBundle](https://symfony.com/doc/current/bundles/DoctrineCacheBundle/index.html) - [Symfony Cache component](https://symfony.com/doc/current/components/cache.html) 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): ``` # in a shell (run `bin/console` instead of `app/console` if your project is based on Symfony 3) php app/console doctrine:cache:clear craue_config_cache ``` Cache implementation: DoctrineCacheBundle ----------------------------------------- [](#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`: ``` # in app/config/config.yml parameters: craue_config.cache_adapter.class: Craue\ConfigBundle\CacheAdapter\DoctrineCacheBundleAdapter doctrine_cache: providers: craue_config_cache: apc: ~ namespace: craue_config aliases: - craue_config_cache_provider ``` Cache implementation: Symfony Cache component --------------------------------------------- [](#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`: ``` # in app/config/config.yml parameters: craue_config.cache_adapter.class: Craue\ConfigBundle\CacheAdapter\SymfonyCacheComponentAdapter services: craue_config_cache_provider: class: Symfony\Component\Cache\Adapter\FilesystemAdapter public: false arguments: - 'craue_config' - 0 - '%kernel.cache_dir%' ``` Customization ============= [](#customization) Redirect to a different page after submitting the built-in form --------------------------------------------------------------- [](#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 --------------------------------- [](#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 ----------- [](#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 ``` Using a custom entity for settings ---------------------------------- [](#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: ``` // src/MyCompany/MyBundle/Entity/MySetting.php use Craue\ConfigBundle\Entity\BaseSetting; use Doctrine\ORM\Mapping as ORM; /** * @ORM\Entity(repositoryClass="Craue\ConfigBundle\Repository\SettingRepository") * @ORM\Table(name="my_setting") */ class MySetting extends BaseSetting { /** * @var string|null * @ORM\Column(name="value", type="text", nullable=true) */ protected $value; /** * @var string|null * @ORM\Column(name="comment", type="string", nullable=true) */ protected $comment; public function setComment($comment) { $this->comment = $comment; } public function getComment() { return $this->comment; } } ``` And make the bundle aware of it: ``` # in app/config/config.yml craue_config: entity_name: MyCompany\MyBundle\Entity\MySetting ``` ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community11 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 97.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~146 days Recently: every ~191 days Total 15 Last Release 3054d ago Major Versions 1.4.2 → 2.0.02017-05-11 PHP version history (3 changes)1.0.0PHP >=5.3.2 1.4.1PHP ^5.3.2|~7.0 2.0.0PHP ^5.3.9|~7.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/d33aa0220bae1b0c48f14fc349b7b3181fec7aa674da145ded4446f2b098fe47?d=identicon)[ntidev](/maintainers/ntidev) --- Top Contributors [![craue](https://avatars.githubusercontent.com/u/800119?v=4)](https://github.com/craue "craue (233 commits)")[![enl](https://avatars.githubusercontent.com/u/670322?v=4)](https://github.com/enl "enl (2 commits)")[![rvanlaak](https://avatars.githubusercontent.com/u/2707563?v=4)](https://github.com/rvanlaak "rvanlaak (2 commits)")[![pmartelletti](https://avatars.githubusercontent.com/u/557390?v=4)](https://github.com/pmartelletti "pmartelletti (1 commits)")[![stof](https://avatars.githubusercontent.com/u/439401?v=4)](https://github.com/stof "stof (1 commits)") --- Tags configSymfony2symfony4symfony3 ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/nti-config-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/nti-config-bundle/health.svg)](https://phpackages.com/packages/nti-config-bundle) ``` ### Alternatives [aws/aws-sdk-php-symfony A Symfony bundle for v3 of the AWS SDK for PHP 36517.7M22](/packages/aws-aws-sdk-php-symfony)[stfalcon/tinymce-bundle This Bundle integrates TinyMCE WYSIWYG editor into a Symfony2 project. 2692.9M24](/packages/stfalcon-tinymce-bundle)[craue/config-bundle Database-stored settings made available via a service for your Symfony project. 1771.0M4](/packages/craue-config-bundle)[dmishh/settings-bundle Database centric Symfony configuration management. Global and per-user settings supported. 115254.9k1](/packages/dmishh-settings-bundle)[phobetor/rabbitmq-supervisor-bundle Symfony bundle to automatically create and update supervisor configurations for RabbitMQ consumer daemons 104564.5k](/packages/phobetor-rabbitmq-supervisor-bundle)[xiidea/easy-audit A Symfony Bundle To Log Selective Events. It is easy to configure and easy to customize for your need 91179.0k](/packages/xiidea-easy-audit) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)