Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
306414e24b | |||
35228c8496 | |||
61b8a68705 | |||
7040fd5ea7 | |||
a2fe3584be |
@ -1,13 +0,0 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Ardent\ParameterBundle;
|
||||
|
||||
use Symfony\Component\HttpKernel\Bundle\Bundle;
|
||||
|
||||
/**
|
||||
* Bundle.
|
||||
*/
|
||||
class ArdentParameterBundle extends Bundle
|
||||
{
|
||||
}
|
@ -1,26 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Ardent\ParameterBundle\DependencyInjection;
|
||||
|
||||
use Symfony\Component\Config\FileLocator;
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\DependencyInjection\Extension\Extension;
|
||||
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
|
||||
|
||||
class ArdentParameterExtension extends Extension
|
||||
{
|
||||
public function load(array $configs, ContainerBuilder $container)
|
||||
{
|
||||
$loader = new YamlFileLoader(
|
||||
$container,
|
||||
new FileLocator(dirname(__DIR__).'/Resources/config')
|
||||
);
|
||||
$loader->load('services.yaml');
|
||||
|
||||
$configuration = new Configuration();
|
||||
$config = $this->processConfiguration($configuration, $configs);
|
||||
|
||||
$def = $container->findDefinition('ardent.parameter');
|
||||
$def->setArgument('$config', $config['parameters']);
|
||||
}
|
||||
}
|
@ -1,39 +0,0 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Ardent\ParameterBundle\DependencyInjection;
|
||||
|
||||
|
||||
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
||||
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
||||
|
||||
class Configuration implements ConfigurationInterface
|
||||
{
|
||||
public const TYPE_TEXT = 'text';
|
||||
public const TYPE_NUMBER = 'number';
|
||||
public const TYPE_BOOL = 'bool';
|
||||
|
||||
public function getConfigTreeBuilder()
|
||||
{
|
||||
$treeBuilder = new TreeBuilder('ardent_parameter');
|
||||
|
||||
$treeBuilder->getRootNode()
|
||||
->children()
|
||||
->arrayNode('parameters')
|
||||
->arrayPrototype()
|
||||
->arrayPrototype()
|
||||
->children()
|
||||
->scalarNode('name')->end()
|
||||
->enumNode('type')
|
||||
->values([self::TYPE_TEXT, self::TYPE_NUMBER, self::TYPE_BOOL])
|
||||
->defaultValue(self::TYPE_TEXT)
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end();
|
||||
|
||||
return $treeBuilder;
|
||||
}
|
||||
}
|
@ -1,75 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Ardent\ParameterBundle\Entity;
|
||||
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
|
||||
/**
|
||||
* @ORM\Entity
|
||||
* @ORM\Table(name="parameter_bundle_parameters")
|
||||
*/
|
||||
class Parameter
|
||||
{
|
||||
/**
|
||||
* @ORM\Id
|
||||
* @ORM\GeneratedValue(strategy="AUTO")
|
||||
* @ORM\Column(type="integer")
|
||||
*/
|
||||
private $id;
|
||||
|
||||
/**
|
||||
* @ORM\Column(type="string")
|
||||
*/
|
||||
private $name;
|
||||
|
||||
/**
|
||||
* @ORM\Column(type="string")
|
||||
*/
|
||||
private $value;
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
public function getId()
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $name
|
||||
* @return Parameter
|
||||
*/
|
||||
public function setName($name)
|
||||
{
|
||||
$this->name = $name;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
public function getValue()
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $value
|
||||
* @return Parameter
|
||||
*/
|
||||
public function setValue($value)
|
||||
{
|
||||
$this->value = $value;
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
}
|
@ -3,13 +3,14 @@
|
||||
"description": "Simple bundle for storing parameters in a database",
|
||||
"type": "symfony-bundle",
|
||||
"require": {
|
||||
"php": "^8.1",
|
||||
"doctrine/orm": "^2.0",
|
||||
"symfony/form": "^5.0|^6.0",
|
||||
"symfony/twig-bundle": "^5.0|^6.0"
|
||||
"symfony/form": "^5.0|^6.0|^7.0",
|
||||
"symfony/twig-bundle": "^5.0|^6.0|^7.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Ardent\\ParameterBundle\\": ""
|
||||
"Ardent\\ParameterBundle\\": "src/"
|
||||
}
|
||||
},
|
||||
"license": "GPL-3.0-only"
|
||||
|
@ -7,6 +7,6 @@ services:
|
||||
autowire: true
|
||||
|
||||
Ardent\ParameterBundle\Controller\:
|
||||
resource: '../../Controller'
|
||||
tags: ['controller.service_arguments']
|
||||
resource: '../src/Controller'
|
||||
tags: ['controller.service_arguments', 'container.service_subscriber']
|
||||
autowire: true
|
52
src/ArdentParameterBundle.php
Normal file
52
src/ArdentParameterBundle.php
Normal file
@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Ardent\ParameterBundle;
|
||||
|
||||
use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
|
||||
use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
|
||||
|
||||
class ArdentParameterBundle extends AbstractBundle
|
||||
{
|
||||
|
||||
public const TYPE_TEXT = 'text';
|
||||
public const TYPE_NUMBER = 'number';
|
||||
public const TYPE_BOOL = 'bool';
|
||||
public const TYPE_CHOICE = 'choice';
|
||||
|
||||
public function configure(DefinitionConfigurator $definition): void
|
||||
{
|
||||
// $treeBuilder = new TreeBuilder('ardent_parameter');
|
||||
|
||||
$definition->rootNode()
|
||||
->children()
|
||||
->arrayNode('parameters')
|
||||
->arrayPrototype()
|
||||
->arrayPrototype()
|
||||
->children()
|
||||
->scalarNode('name')->end()
|
||||
->enumNode('type')
|
||||
->values([self::TYPE_TEXT, self::TYPE_NUMBER, self::TYPE_BOOL, self::TYPE_CHOICE])
|
||||
->defaultValue(self::TYPE_TEXT)
|
||||
->end()
|
||||
->arrayNode('choices')
|
||||
->scalarPrototype()->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end();
|
||||
}
|
||||
|
||||
public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
|
||||
{
|
||||
$container->import('../config/services.yaml');
|
||||
|
||||
// Retrieves the parameters from the config and injects them info the ardent.parameter service
|
||||
$def = $builder->findDefinition('ardent.parameter');
|
||||
$def->setArgument('$config', $config['parameters']);
|
||||
}
|
||||
}
|
@ -9,21 +9,17 @@ use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
|
||||
use Symfony\Component\Form\FormBuilderInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
|
||||
abstract class BaseController extends AbstractController
|
||||
{
|
||||
/**
|
||||
* @param ParameterService $param
|
||||
* @param Request $request
|
||||
* @param [] $configuration
|
||||
*/
|
||||
public function baseIndex(ParameterService $param, Request $request, $configuration)
|
||||
public function baseIndex(ParameterService $param, Request $request, array $configuration): Response
|
||||
{
|
||||
// gather the values
|
||||
$data = [];
|
||||
foreach ($configuration as $config) {
|
||||
$name = $config['name'];
|
||||
$data[$name] = $this->valueParser($config['type'], $param->get($name, false));
|
||||
$data[$name] = $param->get($name, false);
|
||||
}
|
||||
|
||||
// build the form
|
||||
@ -51,34 +47,26 @@ abstract class BaseController extends AbstractController
|
||||
}
|
||||
|
||||
return $this->render('@ArdentParameter/form.html.twig', [
|
||||
'parameter_form' => $form->createView(),
|
||||
]);
|
||||
}
|
||||
|
||||
private function valueParser($type, $value)
|
||||
{
|
||||
switch ($type) {
|
||||
case CheckboxType::class:
|
||||
return boolval($value);
|
||||
default:
|
||||
return $value;
|
||||
}
|
||||
'parameter_form' => $form->createView(),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $config
|
||||
* @param $config
|
||||
* @param FormBuilderInterface $formBuilder
|
||||
*/
|
||||
private function configParser($config, &$formBuilder)
|
||||
private function configParser($config, FormBuilderInterface $formBuilder): void
|
||||
{
|
||||
$type = $config['type'];
|
||||
$options = [];
|
||||
switch ($type) {
|
||||
case ChoiceType::class:
|
||||
if (is_callable($config['choices'])) {
|
||||
$options['choices'] = $config['choices']();
|
||||
$choices = array_combine($config['choices'], $config['choices']);
|
||||
|
||||
if (is_callable($choices)) {
|
||||
$options['choices'] = $choices();
|
||||
} else {
|
||||
$options['choices'] = $config['choices'];
|
||||
$options['choices'] = $choices;
|
||||
}
|
||||
break;
|
||||
case CheckboxType::class:
|
@ -6,16 +6,17 @@ namespace Ardent\ParameterBundle\Controller;
|
||||
|
||||
use Ardent\ParameterBundle\Service\ParameterService;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\Routing\Annotation\Route;
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\Routing\Attribute\Route;
|
||||
|
||||
class ParameterController extends BaseController
|
||||
{
|
||||
/**
|
||||
* @Route("/{category}", name="parameter_bundle_parameters")
|
||||
*/
|
||||
public function parameters($category = 'categories',
|
||||
ParameterService $param,
|
||||
Request $request)
|
||||
#[Route('/{category}', name: 'parameter_bundle_parameters')]
|
||||
public function parameters(
|
||||
ParameterService $param,
|
||||
Request $request,
|
||||
?string $category = 'categories',
|
||||
): Response
|
||||
{
|
||||
$configs = $param->getConfig();
|
||||
|
61
src/Entity/Parameter.php
Normal file
61
src/Entity/Parameter.php
Normal file
@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
namespace Ardent\ParameterBundle\Entity;
|
||||
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\NumberType;
|
||||
|
||||
#[ORM\Entity()]
|
||||
#[ORM\Table(name: 'parameter_bundle_parameters')]
|
||||
class Parameter
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
private ?int $id = null;
|
||||
|
||||
#[ORM\Column]
|
||||
private ?string $name;
|
||||
|
||||
#[ORM\Column(type: 'string')]
|
||||
private mixed $value;
|
||||
|
||||
public function getId(): int
|
||||
{
|
||||
return $this->id;
|
||||
}
|
||||
|
||||
public function getName(): string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
public function setName(string $name): self
|
||||
{
|
||||
$this->name = $name;
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getValue(): mixed
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
static function parseValue(mixed $value, string $type): mixed
|
||||
{
|
||||
return match ($type) {
|
||||
NumberType::class => intval($value),
|
||||
CheckboxType::class => boolval($value),
|
||||
default => $value,
|
||||
};
|
||||
}
|
||||
|
||||
public function setValue(mixed $value): self
|
||||
{
|
||||
$this->value = $value;
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
}
|
@ -2,46 +2,44 @@
|
||||
|
||||
namespace Ardent\ParameterBundle\Service;
|
||||
|
||||
use Ardent\ParameterBundle\DependencyInjection\Configuration;
|
||||
use Ardent\ParameterBundle\ArdentParameterBundle;
|
||||
use Ardent\ParameterBundle\Entity\Parameter;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
|
||||
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\NumberType;
|
||||
use Symfony\Component\Form\Extension\Core\Type\TextType;
|
||||
|
||||
class ParameterService
|
||||
{
|
||||
/** @var EntityManagerInterface */
|
||||
private $em;
|
||||
private array $config;
|
||||
|
||||
/** @var ParameterBagInterface */
|
||||
private $parameter;
|
||||
private $config;
|
||||
private array $cache = [];
|
||||
|
||||
/**
|
||||
* ParameterService constructor.
|
||||
*
|
||||
* @param EntityManagerInterface $em
|
||||
* @param ParameterBagInterface $parameter
|
||||
* @param $config
|
||||
*/
|
||||
public function __construct(EntityManagerInterface $em, ParameterBagInterface $parameter, $config)
|
||||
public function __construct(
|
||||
private readonly EntityManagerInterface $em,
|
||||
private readonly ParameterBagInterface $parameter,
|
||||
array $config
|
||||
)
|
||||
{
|
||||
$this->em = $em;
|
||||
$this->parameter = $parameter;
|
||||
$this->config = $this->supplementConfig($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name The name of the parameter in the format <group>_<parameter>
|
||||
* @param bool $parse Whether to parse embedded %parameter%'s
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function get($name, $parse = true)
|
||||
public function get(string $name, bool $parse = true): mixed
|
||||
{
|
||||
if (array_key_exists($name, $this->cache)) {
|
||||
return $this->cache[$name];
|
||||
}
|
||||
|
||||
$split = explode('_', $name);
|
||||
$category = array_shift($split);
|
||||
|
||||
$paramRepo = $this->em->getRepository(Parameter::class);
|
||||
/** @var Parameter $parameter */
|
||||
$parameter = $paramRepo->findOneBy(['name' => $name]);
|
||||
if ($parameter) {
|
||||
if ($parse) {
|
||||
@ -61,7 +59,8 @@ class ParameterService
|
||||
$value = $parameter->getValue();
|
||||
}
|
||||
|
||||
return $value;
|
||||
$this->cache[$name] = Parameter::parseValue($value, $this->config[$category][$name]['type']);
|
||||
return $this->cache[$name];
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
@ -69,9 +68,8 @@ class ParameterService
|
||||
|
||||
/**
|
||||
* @param string $name The name of the parameter in the format <group>_<parameter>
|
||||
* @param mixed $value
|
||||
*/
|
||||
public function set($name, $value)
|
||||
public function set(string $name, mixed $value): void
|
||||
{
|
||||
$paramRepo = $this->em->getRepository(Parameter::class);
|
||||
/* @var Parameter $parameter */
|
||||
@ -82,37 +80,39 @@ class ParameterService
|
||||
$parameter->setValue($value);
|
||||
$this->em->persist($parameter);
|
||||
$this->em->flush();
|
||||
$this->cache[$name] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces the types in the config by their classes
|
||||
*
|
||||
* @param $config
|
||||
* @return array
|
||||
*/
|
||||
private function supplementConfig($config)
|
||||
private function supplementConfig(array $rawConfig): array
|
||||
{
|
||||
foreach ($config as $groupName => &$group) {
|
||||
foreach ($group as &$value) {
|
||||
$config = [];
|
||||
foreach ($rawConfig as $groupName => $rawGroup) {
|
||||
$group = [];
|
||||
foreach ($rawGroup as &$value) {
|
||||
switch ($value['type']) {
|
||||
default:
|
||||
case Configuration::TYPE_TEXT:
|
||||
case ArdentParameterBundle::TYPE_TEXT:
|
||||
$class = TextType::class;
|
||||
break;
|
||||
case Configuration::TYPE_NUMBER:
|
||||
case ArdentParameterBundle::TYPE_NUMBER:
|
||||
$class = NumberType::class;
|
||||
break;
|
||||
case Configuration::TYPE_BOOL:
|
||||
case ArdentParameterBundle::TYPE_BOOL:
|
||||
$class = CheckboxType::class;
|
||||
break;
|
||||
case ArdentParameterBundle::TYPE_CHOICE:
|
||||
$class = ChoiceType::class;
|
||||
break;
|
||||
}
|
||||
|
||||
// Add the group name in front of the parameter name
|
||||
$value['name'] = sprintf('%s_%s', $groupName, $value['name']);
|
||||
$value['type'] = $class;
|
||||
|
||||
$group[$value['name']] = $value;
|
||||
unset($value);
|
||||
}
|
||||
unset($group);
|
||||
$config[$groupName] = $group;
|
||||
}
|
||||
return $config;
|
||||
}
|
Loading…
Reference in New Issue
Block a user