vim/symfony-settings


Keywords
symfony 5, php 8, symfony-settings
License
Other

Documentation

Installation

composer require vim/symfony-settings

Configuration

config/packages/settings.yaml

settings:
  pool: app.cache.settings
  settings:
    #- { type: integer, code: some_code_integer, name: 'Some title - integer', value: 1 }
    #- { type: float, code: some_code_float, name: 'Some title - float', value: 1.0 }
    #- { type: text, code: some_code_text, name: 'Some title - text', value: 'some big text' }
    #- { type: string, code: some_code_string, name: 'Some title - string', value: '' }
    #- { type: array, code: some_code_array, name: 'Some title - array', value: [] }
    #- { type: boolean, code: some_code_boolean, name: 'Some title - boolean', value: true }
    #- { type: choice, code: some_code_choice, name: 'Some title - choice', value: 1, choiceList: [1, 2, 3] }

config/packages/cache.yaml

framework:
  cache:
    pools:
      #...
      app.cache.settings:
        adapter: cache.adapter.redis
        default_lifetime: 2592000 # 30 days

api/config/bundles.php

<?php
return [
  // ...
  Vim\Settings\SettingsBundle::class => ['all' => true],
];

config/packages/doctrine.yaml

doctrine:
  # ...
  orm:
    # ...
    mappings:
      # ...
      SettingsBundle:
        is_bundle: true
        type: annotation
        prefix: 'Vim\Settings\Entity'

config/routes.yaml

settings_list:
  path: /api/v1/settings
  methods: GET
  controller: Vim\Settings\Controller\SettingsController::index
settings_save:
  path: /api/v1/settings
  methods: POST
  controller: Vim\Settings\Controller\SettingsController::save

Example

/** @var \Vim\Settings\Service\SettingsServiceInterface $settingsService **/
$value = $settingsService->get('some_code');