Initial

CHANGELOG.md

@@ -7,16 +7,16 @@
 - dropped support for PHP 5.3, 5.4, 5.5, 5.6
 - dropped support for HHVM
 
-[2.2.0]: https://github.com/craue/CraueConfigBundle/compare/2.1.0...2.2.0
+[2.2.0]: https://github.com/effiana/ConfigBundle/compare/2.1.0...2.2.0
 
 ## [2.1.0] – 2018-01-02
 
 - [#41]:
   - added support for Symfony 4.*
   - no longer use Assetic
 
-[#41]: https://github.com/craue/CraueConfigBundle/issues/41
-[2.1.0]: https://github.com/craue/CraueConfigBundle/compare/2.0.0...2.1.0
+[#41]: https://github.com/effiana/ConfigBundle/issues/41
+[2.1.0]: https://github.com/effiana/ConfigBundle/compare/2.0.0...2.1.0
 
 ## [2.0.0] – 2017-05-11
 
@@ -29,98 +29,98 @@
 - [#35]: added a cache for settings
 - avoid warnings about missing translations when rendering the built-in form
 
-[#20]: https://github.com/craue/CraueConfigBundle/issues/20
-[#35]: https://github.com/craue/CraueConfigBundle/issues/35
-[2.0.0]: https://github.com/craue/CraueConfigBundle/compare/1.4.2...2.0.0
+[#20]: https://github.com/effiana/ConfigBundle/issues/20
+[#35]: https://github.com/effiana/ConfigBundle/issues/35
+[2.0.0]: https://github.com/effiana/ConfigBundle/compare/1.4.2...2.0.0
 
 ## [1.4.2] – 2017-03-27
 
 - prevent changes to names and sections of settings via hidden fields in the built-in form
 - use namespaced template names (available since Twig 1.10)
 
-[1.4.2]: https://github.com/craue/CraueConfigBundle/compare/1.4.1...1.4.2
+[1.4.2]: https://github.com/effiana/ConfigBundle/compare/1.4.1...1.4.2
 
 ## [1.4.1] – 2015-12-29
 
 - added support for PHP 7.0 and HHVM
 
-[1.4.1]: https://github.com/craue/CraueConfigBundle/compare/1.4.0...1.4.1
+[1.4.1]: https://github.com/effiana/ConfigBundle/compare/1.4.0...1.4.1
 
 ## [1.4.0] – 2015-11-30
 
 - added support for Symfony 3.*
 - dropped support for Symfony 2.1 and 2.2
 
-[1.4.0]: https://github.com/craue/CraueConfigBundle/compare/1.3.2...1.4.0
+[1.4.0]: https://github.com/effiana/ConfigBundle/compare/1.3.2...1.4.0
 
 ## [1.3.2] – 2015-11-30
 
 - [#22]+[#23]+[#28]: added conditional code updates to avoid deprecation notices with Symfony 2.8
 - simplified controller code by injecting the `Request` into the action
 
-[#22]: https://github.com/craue/CraueConfigBundle/issues/22
-[#23]: https://github.com/craue/CraueConfigBundle/issues/23
-[#28]: https://github.com/craue/CraueConfigBundle/issues/28
-[1.3.2]: https://github.com/craue/CraueConfigBundle/compare/1.3.1...1.3.2
+[#22]: https://github.com/effiana/ConfigBundle/issues/22
+[#23]: https://github.com/effiana/ConfigBundle/issues/23
+[#28]: https://github.com/effiana/ConfigBundle/issues/28
+[1.3.2]: https://github.com/effiana/ConfigBundle/compare/1.3.1...1.3.2
 
 ## [1.3.1] – 2015-02-27
 
 - [#17]: added Russian translation
 - added conditional code updates to avoid deprecation notices
 
-[#17]: https://github.com/craue/CraueConfigBundle/issues/17
-[1.3.1]: https://github.com/craue/CraueConfigBundle/compare/1.3.0...1.3.1
+[#17]: https://github.com/effiana/ConfigBundle/issues/17
+[1.3.1]: https://github.com/effiana/ConfigBundle/compare/1.3.0...1.3.1
 
 ## [1.3.0] – 2014-11-04
 
 - [#16]: added method `getBySection` to get settings with a given section
 
-[#16]: https://github.com/craue/CraueConfigBundle/issues/16
-[1.3.0]: https://github.com/craue/CraueConfigBundle/compare/1.2.0...1.3.0
+[#16]: https://github.com/effiana/ConfigBundle/issues/16
+[1.3.0]: https://github.com/effiana/ConfigBundle/compare/1.2.0...1.3.0
 
 ## [1.2.0] – 2014-05-22
 
-- [#10]: added Twig function `craue_setting`
+- [#10]: added Twig function `effiana_setting`
 - [#12]: added Dutch translation
 
-[#10]: https://github.com/craue/CraueConfigBundle/issues/10
-[#12]: https://github.com/craue/CraueConfigBundle/issues/12
-[1.2.0]: https://github.com/craue/CraueConfigBundle/compare/1.1.4...1.2.0
+[#10]: https://github.com/effiana/ConfigBundle/issues/10
+[#12]: https://github.com/effiana/ConfigBundle/issues/12
+[1.2.0]: https://github.com/effiana/ConfigBundle/compare/1.1.4...1.2.0
 
 ## [1.1.4] – 2013-12-08
 
 - fixed handling flash messages in the base template
 - fixed translating setting names in the modification form
 - adjusted the Composer requirements to also allow Symfony 2.4 and up (now 2.1 and up)
 
-[1.1.4]: https://github.com/craue/CraueConfigBundle/compare/1.1.3...1.1.4
+[1.1.4]: https://github.com/effiana/ConfigBundle/compare/1.1.3...1.1.4
 
 ## [1.1.3] – 2013-11-21
 
 - [#7]: fixed the base template to be compatible with Symfony 2.3 as well (now 2.1 and up)
 
-[#7]: https://github.com/craue/CraueConfigBundle/issues/7
-[1.1.3]: https://github.com/craue/CraueConfigBundle/compare/1.1.2...1.1.3
+[#7]: https://github.com/effiana/ConfigBundle/issues/7
+[1.1.3]: https://github.com/effiana/ConfigBundle/compare/1.1.2...1.1.3
 
 ## [1.1.2] – 2013-09-25
 
 - adjusted the Composer requirements to also allow Symfony 2.3
 
-[1.1.2]: https://github.com/craue/CraueConfigBundle/compare/1.1.1...1.1.2
+[1.1.2]: https://github.com/effiana/ConfigBundle/compare/1.1.1...1.1.2
 
 ## [1.1.1] – 2013-05-02
 
 - allow a custom route for redirection after handling form submission
 
-[1.1.1]: https://github.com/craue/CraueConfigBundle/compare/1.1.0...1.1.1
+[1.1.1]: https://github.com/effiana/ConfigBundle/compare/1.1.0...1.1.1
 
 ## [1.1.0] – 2013-02-28
 
 - adjustments to changes in the Form component for Symfony 2.1.*
 - [#2]: added setters to the `Config` class
 
-[#2]: https://github.com/craue/CraueConfigBundle/issues/2
-[1.1.0]: https://github.com/craue/CraueConfigBundle/compare/1.0.0...1.1.0
+[#2]: https://github.com/effiana/ConfigBundle/issues/2
+[1.1.0]: https://github.com/effiana/ConfigBundle/compare/1.0.0...1.1.0
 
 ## 1.0.0 - 2012-05-26
 

README.md

@@ -1,9 +1,9 @@
 # Information
 
-[![Build Status](https://travis-ci.org/craue/CraueConfigBundle.svg?branch=master)](https://travis-ci.org/craue/CraueConfigBundle)
-[![Coverage Status](https://coveralls.io/repos/github/craue/CraueConfigBundle/badge.svg?branch=master)](https://coveralls.io/github/craue/CraueConfigBundle?branch=master)
+[![Build Status](https://travis-ci.org/effiana/ConfigBundle.svg?branch=master)](https://travis-ci.org/effiana/ConfigBundle)
+[![Coverage Status](https://coveralls.io/repos/github/effiana/ConfigBundle/badge.svg?branch=master)](https://coveralls.io/github/effiana/ConfigBundle?branch=master)
 
-CraueConfigBundle manages configuration settings stored in the database and makes them accessible via a service in your
+ConfigBundle 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.
 
@@ -14,7 +14,7 @@ by an admin user.
 Let Composer download and install the bundle by running
 
 ```sh
-php composer.phar require craue/config-bundle:~2.2
+php composer.phar require effiana/config-bundle:~2.2
 ```
 
 in a shell.
@@ -26,7 +26,7 @@ in a shell.
 public function registerBundles() {
 	$bundles = [
 		// ...
-		new Craue\ConfigBundle\CraueConfigBundle(),
+		new Effiana\ConfigBundle\ConfigBundle(),
 	];
 	// ...
 }
@@ -57,19 +57,19 @@ You can either import the default routing configuration
 
 ```yaml
 # in app/config/routing.yml
-craue_config_settings:
-  resource: "@CraueConfigBundle/Resources/config/routing/settings.xml"
+effiana_config_settings:
+  resource: "@ConfigBundle/Resources/config/routing/settings.xml"
   prefix: /settings
 ```
 
 ...or add your own to have full control over the URL pattern.
 
 ```yaml
 # in app/config/routing.yml
-craue_config_settings_modify:
+effiana_config_settings_modify:
   path: /settings/modify
   defaults:
-    _controller: Craue\ConfigBundle\Controller\SettingsController::modifyAction
+    _controller: Effiana\ConfigBundle\Controller\SettingsController::modifyAction
 ```
 
 Some CSS is needed to render the form correctly. Install the assets in your project:
@@ -85,7 +85,7 @@ php bin/console assets:install --symlink web
 
 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
+This means that you have to create new settings in the database table `effiana_config_setting` yourself, e.g. using a
 migration.
 
 ## Managing settings' values
@@ -96,22 +96,22 @@ But you probably want to limit access to this form in your security configuratio
 
 ## Reading settings
 
-The bundle provides a service called `craue_config`. Inside of a controller you can call
+The bundle provides a service called `effiana_config`. Inside of a controller you can call
 
 ```php
-$this->get('craue_config')->get('name-of-a-setting')
+$this->get('effiana_config')->get('name-of-a-setting')
 ```
 
 to retrieve the value of the setting `name-of-a-setting`. Furthermore, you can call
 
 ```php
-$this->get('craue_config')->all()
+$this->get('effiana_config')->all()
 ```
 
 to get an associative array of all defined settings and their values.
 
 ```php
-$this->get('craue_config')->getBySection('name-of-a-section')
+$this->get('effiana_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).
@@ -121,8 +121,8 @@ will fetch only settings with the specified section (or those without a section
 With the same service you can set new values of settings:
 
 ```php
-$this->get('craue_config')->set('name-of-a-setting', 'new value');
-$this->get('craue_config')->setMultiple(['setting-1' => 'foo', 'setting-2' => 'bar']);
+$this->get('effiana_config')->set('name-of-a-setting', 'new value');
+$this->get('effiana_config')->setMultiple(['setting-1' => 'foo', 'setting-2' => 'bar']);
 ```
 
 Keep in mind that the setting has to be present, or an exception will be thrown.
@@ -132,7 +132,7 @@ Keep in mind that the setting has to be present, or an exception will be thrown.
 The Twig extension in this bundle supports reading settings directly in your template.
 
 ```twig
-{{ craue_setting('name-of-a-setting') }}
+{{ effiana_setting('name-of-a-setting') }}
 ```
 
 # Enable caching (optional)
@@ -143,50 +143,50 @@ implementation you'd like to use. Currently, there are adapters available for:
 - [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).
+done, `ConfigBundle` will automatically cache settings (using the built-in `effiana_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):
 
 ```sh
 # in a shell
-php bin/console doctrine:cache:clear craue_config_cache
+php bin/console doctrine:cache:clear effiana_config_cache
 ```
 
 ## 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`:
+Set the parameter `effiana_config.cache_adapter.class` appropriately and configure a so-called cache provider with the
+alias `effiana_config_cache_provider`:
 
 ```yaml
 # in app/config/config.yml
 parameters:
-  craue_config.cache_adapter.class: Craue\ConfigBundle\CacheAdapter\DoctrineCacheBundleAdapter
+  effiana_config.cache_adapter.class: Effiana\ConfigBundle\CacheAdapter\DoctrineCacheBundleAdapter
 
 doctrine_cache:
   providers:
-    craue_config_cache:
+    effiana_config_cache:
       apc: ~
-      namespace: craue_config
+      namespace: effiana_config
       aliases:
-        - craue_config_cache_provider
+        - effiana_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`:
+Set the parameter `effiana_config.cache_adapter.class` appropriately and configure a so-called cache pool with the
+service id `effiana_config_cache_provider`:
 
 ```yaml
 # in app/config/config.yml
 parameters:
-  craue_config.cache_adapter.class: Craue\ConfigBundle\CacheAdapter\SymfonyCacheComponentAdapter
+  effiana_config.cache_adapter.class: Effiana\ConfigBundle\CacheAdapter\SymfonyCacheComponentAdapter
 
 services:
-  craue_config_cache_provider:
+  effiana_config_cache_provider:
     class: Symfony\Component\Cache\Adapter\FilesystemAdapter
     public: false
     arguments:
-      - 'craue_config'
+      - 'effiana_config'
       - 0
       - '%kernel.cache_dir%'
 ```
@@ -201,7 +201,7 @@ target route name:
 ```yaml
 # in app/config/parameters.yml
 parameters:
-  craue_config.redirectRouteAfterModify: craue_config_settings_modify
+  effiana_config.redirectRouteAfterModify: effiana_config_settings_modify
 ```
 
 ## Rendering of settings in sections
@@ -212,21 +212,21 @@ name (in the database). Optionally, you can influence the order of these section
 ```yaml
 # in app/config/parameters.yml
 parameters:
-  craue_config.configTemplate.sectionOrder: [section1, section2, section3]
+  effiana_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.
+with the `ConfigBundle` domain, e.g.
 
 ```yaml
-# in app/Resources/CraueConfigBundle/translations/CraueConfigBundle.en.yml
+# in app/Resources/ConfigBundle/translations/ConfigBundle.en.yml
 name-of-a-setting: name of the setting
 
-# in app/Resources/CraueConfigBundle/translations/CraueConfigBundle.de.yml
+# in app/Resources/ConfigBundle/translations/ConfigBundle.de.yml
 name-of-a-setting: Name der Einstellung
 ```
 
@@ -240,11 +240,11 @@ So create the entity and its appropriate mapping:
 
 ```php
 // src/MyCompany/MyBundle/Entity/MySetting.php
-use Craue\ConfigBundle\Entity\BaseSetting;
+use Effiana\ConfigBundle\Entity\BaseSetting;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * @ORM\Entity(repositoryClass="Craue\ConfigBundle\Repository\SettingRepository")
+ * @ORM\Entity(repositoryClass="Effiana\ConfigBundle\Repository\SettingRepository")
  * @ORM\Table(name="my_setting")
  */
 class MySetting extends BaseSetting {
@@ -276,6 +276,6 @@ And make the bundle aware of it:
 
 ```yaml
 # in app/config/config.yml
-craue_config:
+effiana_config:
   entity_name: MyCompany\MyBundle\Entity\MySetting
 ```