Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kunicmarko20/simpleconfigurationbundle
Symfony bundle that adds simple key:value Configuration Managment to Sonata Admin.
https://github.com/kunicmarko20/simpleconfigurationbundle
configuration-management key-value sonata-admin symfony-bundle
Last synced: 3 months ago
JSON representation
Symfony bundle that adds simple key:value Configuration Managment to Sonata Admin.
- Host: GitHub
- URL: https://github.com/kunicmarko20/simpleconfigurationbundle
- Owner: kunicmarko20
- License: mit
- Archived: true
- Created: 2017-10-27T16:48:23.000Z (about 7 years ago)
- Default Branch: v1.x
- Last Pushed: 2017-11-24T08:08:09.000Z (about 7 years ago)
- Last Synced: 2024-09-27T01:43:43.436Z (3 months ago)
- Topics: configuration-management, key-value, sonata-admin, symfony-bundle
- Language: PHP
- Homepage:
- Size: 78.1 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple Configuration Bundle
============
[](https://travis-ci.org/kunicmarko20/SimpleConfigurationBundle)
[](https://insight.sensiolabs.com/projects/4b9c511d-3a09-442e-b882-db7da663bf11)
[](https://styleci.io/repos/108571141)
[](https://coveralls.io/github/kunicmarko20/SimpleConfigurationBundle)
This bundle adds key:value storage to your sonata admin, also you can easily extend bundle and add your own types.
This bundle depends on [SonataAdminBundle](https://github.com/sonata-project/SonataAdminBundle)
Documentation
-------------
* [Installation](#installation)
* [How to use](#how-to-use)
* [Add new type](#add-new-type)
* [Roles and Categories](#roles-and-categories)
* [Additional stuff](#additional-stuff)
## Installation
**1.** Add to composer.json to the `require` key
```
composer require kunicmarko/simple-configuration-bundle
```
**2.** Register the bundle in ``app/AppKernel.php``
```
$bundles = array(
// ...
new KunicMarko\SimpleConfigurationBundle\SimpleConfigurationBundle(),
);
```
If you are not using auto_mapping add it to your orm mappings
```
# app/config/config.yml
orm:
entity_managers:
default:
mappings:
AppBundle: ~
...
SimpleConfigurationBundle: ~
```
**3.** Update database
```
app/console doctrine:schema:update --force
```
**4.** Clear cache
```
app/console cache:clear
```
## How to use
In your twig template you can call it like :
```
{{ simple_configuration.getAll() }}
{{ simple_configuration.getValueFor('name') }}
```
if you want to use it in controller you can do :
```
$this->get('simple_configuration.service.configuration')->getAll()
$this->get('simple_configuration.service.configuration')->getValueFor('name')
```
## Add new type
If you want to add new types, you can do it like this
```
# app/config/config.yml
simple_configuration:
types:
newtype: YourBundle\Entity\NewType
```
### Creating new Type ###
Your new type has to extend AbstractConfigurationType, you also have to specify template used for sonata list (it can be sonata template, or your own created), and how should field be rendered in form.
**1.** New type without new column
```
namespace YourBundle\Entity;
use KunicMarko\SimpleConfigurationBundle\Entity\AbstractConfigurationType;
use Sonata\AdminBundle\Form\FormMapper;
use Symfony\Component\Form\Extension\Core\Type\TextType;
class NewType extends AbstractConfigurationType
{
/**
* {@inheritDoc}
*/
public function getTemplate() : string
{
return 'SonataAdminBundle:CRUD:list_string.html.twig';
}
/**
* {@inheritDoc}
*/
public function generateFormField(FormMapper $formMapper) : void
{
$formMapper->add('value', TextType::class, ['required' => false]);
}
}
```
**2.** New type with new column
As you can see from example code below, we added new `$date` field, the one thing that is necessary is to overwrite `getValue()` method with delegating to your getter for new field as shown below.
```
namespace YourBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use KunicMarko\SimpleConfigurationBundle\Entity\AbstractConfigurationType;
use Sonata\AdminBundle\Form\FormMapper;
use Symfony\Component\Form\Extension\Core\Type\DateType;
class NewType extends AbstractConfigurationType
{
/**
* @var \DateTime
*
* @ORM\Column(name="date", type="date", nullable=true)
*/
private $date;
public function setDate(?\DateTime $date) : self
{
$this->date = $date;
return $this;
}
public function getDate() : ?\DateTime
{
return $this->date;
}
public function getValue() : ?\DateTime
{
return $this->getDate();
}
/**
* {@inheritDoc}
*/
public function getTemplate() : string
{
//return 'SonataAdminBundle:CRUD:list_string.html.twig'; can also be used
return 'SimpleConfigurationBundle:CRUD:list_field_date.html.twig';
}
/**
* {@inheritDoc}
*/
public function generateFormField(FormMapper $formMapper) : void
{
$formMapper->add('date', DateType::class, ['required' => false]);
}
}
```
Do not forget to update database after adding new field :
```
app/console doctrine:schema:update --force
```
## Additional stuff
When including this bundle you get access to some twig filters I needed.
### Elapsed ###
In twig you can use `|elapsed` filter and you will get human readable time, it works with timestamps or DateTime objects.
```
{{ var|elapsed }}
#outputs "time" ago, 5 days ago, 5 minutes ago, just now, 1 month ago, etc.
```