Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 4.47 KB

README.md

File metadata and controls

90 lines (70 loc) · 4.47 KB
Raw

Easy Configuration

Coverage Status Scrutinizer Code Quality Latest Stable Version Total Downloads License

A Symfony Bundle for easy configuration management.

Features Include

  • Group wise dynamic form creation ability
  • Store global configuration
  • Store user wise configuration
  • Get configuration through rest API

Install

  1. Download and Enable EasyConfigBundle
  2. Create Config entity class
  3. Configure yaml file
  4. Update database schema
  5. Create your first form
  6. Register the bundle’s routes
  7. Overriding default EasyConfigBundle templates (optional)

1. Download and Enable EasyConfigBundle :

Download through composer :

Open a command console, enter project directory and execute the following command to download the latest stable version of this bundle:

$ composer require xiidea/easy-config
Enable Bundle (No need when Flex is available):

The bundle should be automatically enabled by Symfony Flex. If you don't use Flex, you will need to enable the bundle manually by adding the following line in the config/bundles.php file of your project:

<?php
// src/Kernel.php

return [
    // ...
    Xiidea\EasyConfigBundle\XiideaEasyConfigBundle::class => ['all' => true],
];

2. Create Config entity class:

By default EasyConfigBundle supports Doctrine ORM. However, you must provide an Entity class and the class has to extend the class \Xiidea\EasyConfigBundle\Model\BaseConfig. To configure the Entity class properly please follow the detailed instructions.

3. Configure yaml file:

Create a file in the following directory config/packages with the exact name xiidea_easy_config.yaml A sample config file is available in this path Resources/config/config-sample.yml. Copy this sample file's content and paste to just created file. Do not forget to change your Entity class name which has been mentioned in Step 3.

# Xiidea Easy Config Configuration Sample

xiidea_easy_config:
    config_class: App\Entity\Configuration

4. Update database schema:

It’s time to set up the database schema, open your command console, go to your project root path and execute the following command.

$ php bin/console doctrine:schema:update --force

5. Create form group and type:

Create a form group class and form type with your necessary fields. Please follow the instructions to create the form group and type.

6. Register the bundle’s routes:

Now it's time to access the form you have just created, for that you have to include bundle's routes to your application by the following way.

xiidea_config_route:
    resource: "@XiideaEasyConfigBundle/Resources/config/routes.yaml"
    prefix: '/config'

Note: You may change the prefix as your wish

Following routes are available in this bundle:

  • Index route (prefix/) : List of all forms
  • Form group route (prefix/group_key) : Form of specific group key

7. Overriding default EasyConfigBundle templates (optional)

Template overriding is not important to use EasyConfigBundle bundle but if you want to keep UI as similar as your application you can override the template, to do so follow the instructions

Congratulations !

Your application is ready to store configurations, just browse the routes.

License

The Easy Config Bundle is licensed under the MIT license. See the LICENSE file for more details.