Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbtronics/settings-bundle

A bundle to easily create typesafe, user-configurable settings for symfony applications
https://github.com/jbtronics/settings-bundle

configuration configuration-management settings settings-management symfony symfony-bundle symfony6 symfony7 web

Last synced: 2 days ago
JSON representation

A bundle to easily create typesafe, user-configurable settings for symfony applications

Awesome Lists containing this project

README 

        
**[Documentation](https://jbtronics.github.io/settings-bundle/)**



[![codecov](https://codecov.io/github/jbtronics/settings-bundle/graph/badge.svg?token=2IGGK9MGOW)](https://codecov.io/github/jbtronics/settings-bundle)



# Settings bundle



Settings-bundle is a symfony bundle that let you easily create and manage user-configurable settings, which are changeable via a web frontend.

It allows for easy creation of type-safe settings objects, which can be easily managed and changed via a web frontend in your symfony application.



## Introduction

By default, symfony is mostly configured by parameters in configuration files, where a recompilation of the container is required, or via environment variables, which can not be easily changed by the application itself. 



However, you often want administrators and users of your application let change settings and configuration of your application. This bundle provides a simple way to do this. Unlike other bundles with a similar goal, this bundle tries to be as modular as possible and to be as type-safe as possible. Therefore you define your Settings as a class, and access objects of this class in your application, instead of doing simple key-value lookups with mixed return types.



All relevant definitions of settings are done directly in the settings class via metadata attributes. This makes it easy to understand and maintain the settings. The bundle also provides a simple way to generate forms to change the settings, which can be easily integrated into your application.



## Features

* Class based settings, which get easily managed by the bundle

* Type-safe access to settings

* Easy to use API

* Retrieve settings via dependency injection in service constructors

* Almost zero configuration required in many cases, as the bundle tries to derive as much information as possible from code metadata like property types, etc.

* Various storage backends, like database, json files, PHP files, etc. (custom backends can be easily implemented)

* Use symfony/validator to easily restrict possible values of settings parameters

* Automatically generate forms to change settings

* Easy possibility to version settings and automatically migrate old stored data to the current format

* Possibility to lazy load settings, so that only the settings, which are really needed, are loaded

* Profiler integration for easy debugging

* Ability to use environment variables for easy configuration on automated deployments



## Requirements

* PHP 8.1 or higher

* Symfony 6.4 or higher (compatible with Symfony 7.0)

* Symfony/forms and Symfony/validator required if forms should be generated or validation should be used

* twig required if you want to use the twig extension to access settings in your templates

* doctrine/orm and doctrine-bundle required if you want to use the doctrine storage adapter



## Installation



Add the bundle to your symfony project via composer:

```bash

composer require jbtronics/settings-bundle

```



If you are using symfony flex, the bundle should be automatically enabled. Otherwise you have to add the bundle to your `config/bundles.php` file:



```php

return [

    // ...

    Jbtronics\SettingsBundle\JbtronicsSettingsBundle::class => ['all' => true],

];

```



## Usage



*The following section is just a quick overview. See [documentation](https://jbtronics.github.io/settings-bundle/) for full info.*



Settings classes are simple PHP classes, which are annotated with the `#[Settings]` attribute. They must live in the path configured to store settings classes (normally `src/Settings`), in your symfony project. The bundle will automatically find and register all settings classes in this directory.



The properties of the classes are used for storing the different data. Similar to the `#[ORM\Column]` attribute of doctrine, you can use the `#[SettingsParameter]` attribute to make a class property to a managed parameter. The properties can be public, protected or private (as SettingsBundle accesses them via reflection), but you have some kind of possibility to access the properties to get/set the configuration parameters in your software.

You have to configure, which type mapper should be used to map the normalized data from the storage backend to the type of property. The bundle comes with a few default type mappers, but you can also implement your own type mappers.



```php

settingsManager->get(TestSettings::class);



        //To read the current settings value, just access the property

        dump('My string is: ' . $settings->myString);



        //To change the settings, just change the property (or call the setter)

        $settings->myString = 'new value';



        //And save the settings to the storage backend

        $this->settingsManager->save($settings);



        //You can also access the settings via a given name (which is the part before the "Settings" suffix of the class name in lowercase, by default)

        $settings = $this->settingsManager->get('test');



        //You can set an invalid value to the parameters

        $settings->myInt = 42;



        //But the bundle will throw an exception, when you try to save the settings

        $this->settingsManager->save($settings); // Throws an excpetion

    }

}



```



Alternatively if you have a service, which depends on the settings, you can inject the current settings instance directly via dependency injection. 

The bundle registers a service for each settings class, which can be injected into your services like any other service. 

Internally the settings manager `get()` method is called to retrieve a lazy loaded settings instance:



```php

class ExampleService {

    public function __construct(private TestSettings $settings) {

        //This is equivalent to calling $settings = $settingsManager->get(TestSettings::class, lazy: true)

        //The settings are lazy, meaning that they are only loaded from storage, when you access a property

        if ($this->settings->myString === 'some value') {

            //Do something

        }

    }

}

```



The instance injected via dependency injection is the same as the one you would get via the settings manager.

This means, that all changes to the settings instance are updated automatically in all parts of your application.



### Forms



The bundle can automatically generate forms to change settings classes. This is done via the `SettingsFormFactoryInterface`, which creates a form builder containing fields to edit one or more settings classes. You can also render just a subset of the settings. Validation attributes are checked and mapped to form errors. This way you can easily create a controller, to let users change the settings:



```php

settingsManager->createTemporaryCopy(TestSettings::class);



        //Create a builder for the settings form

        $builder = $this->settingsFormFactory->createSettingsFormBuilder($settings);



        //Add a submit button, so we can save the form

        $builder->add('submit', SubmitType::class);



        //Create the form

        $form = $builder->getForm();



        //Handle the form submission

        $form->handleRequest($request);



        //If the form was submitted and the data is valid, then it

        if ($form->isSubmitted() && $form->isValid()) {

            //Merge the valid data back into the managed instance

            $this->settingsManager->mergeTemporaryCopy($settings);



            //Save the settings to storage

            $this->settingsManager->save();

        }



        //Render the form

        return $this->render('settings.html.twig', [

            'form' => $form->createView(),

        ]);

    }

}

```



Form rendering can be customized via the Parameter attributes. See [documentation](https://jbtronics.github.io/settings-bundle/) for full info.



### Twig templates



In twig templates you can access the settings via the `settings_instance()` function, which behaves like the `SettingsManagerInterface::get()` function and returns the current settings instance:



```twig

{# @var settings \App\Settings\TestSettings #}

{% set settings = settings_instance('test') %}

{{ dump(settings) }}



{# or directly #}

{{ settings_instance('test').myString }}

```



## License



SettingsBundle is licensed under the MIT License.

This mostly means that you can use this bundle for whatever you want (even use it commercially)

as long as you retain the copyright/license information.



See [LICENSE](https://github.com/jbtronics/settings-bundle/blob/master/LICENSE) for more information.