Commit 47010b67 authored by Anthony Gautreau's avatar Anthony Gautreau
Browse files

Sortie de l'état WIP, mise à niveau comme les autres bundle

parent dbc3e013
Loading
Loading
Loading
Loading
+1 −2
Changes for .php-cs-fixer.dist.php: 1 added line, 2 removed lines.
Original line number Diff line number Diff line
@@ -2,8 +2,7 @@

$finder = (new PhpCsFixer\Finder())
    ->in(__DIR__.'/src')
    ->exclude('var')
    ->exclude('vendor'); 
    ->exclude('vendor')
;

return (new PhpCsFixer\Config())

README.md

0 → 100644
+77 −0
Changes for README.md: 77 added lines, 0 removed lines.
Original line number Diff line number Diff line
# unicaen/parametre-bundle

Paramètres applicatifs rangés par catégorie, lisibles par l'application et administrables par
une API sécurisée par unicaen/privilege-bundle.

## Installation

```bash
composer require unicaen/parametre-bundle
```

Sans Symfony Flex, déclarer le bundle dans `config/bundles.php` :

```php
Unicaen\Parametre\UnicaenParametreBundle::class => ['all' => true],
```

Les entités sont mappées par `doctrine.orm.auto_mapping`. Les tables
`unicaen_parametre_categorie` et `unicaen_parametre_parametre` se créent par une migration de
l'application (`doctrine:migrations:diff`).

## Usage

```php
use Unicaen\Parametre\Service\ParametreService;

$duree = $parametreService->getValeur('MOBILITE', 'DUREE_MAX');      // int|float, type Number
$actif = $parametreService->getValeur('MOBILITE', 'INSCRIPTIONS');   // bool, type Boolean
$parametre = $parametreService->getParametre('MOBILITE', 'DUREE_MAX'); // entité, ou null
```

Le type d'un paramètre (`valeursPossibles`, colonne `valeurs_possibles`) vaut `String`,
`Boolean` ou `Number`. Sans type, la valeur est rendue telle quelle. Un booléen s'écrit
`true`/`false` (ou `1`/`0`). `getValeur()` lève `ParametreNotFoundException` si le paramètre
n'existe pas, `ParametreMalTypeException` si sa valeur ne correspond pas à son type. L'API
refuse de toute façon une valeur incompatible (422).

Un code de catégorie est unique, un code de paramètre l'est dans sa catégorie. Supprimer une
catégorie supprime ses paramètres.

`modifiable: false` verrouille un paramètre : l'API refuse sa modification et sa suppression
(403), il ne change que par l'application (référentiel, migration). `affichable: false` le
masque par défaut dans la page d'administration.

## API

Toutes les opérations sont protégées par `is_granted('UNICAEN_PRIVILEGE', object)` et
documentées sous le tag OpenAPI « Unicaen Paramètre ». Les collections ne sont pas paginées.

| Opération | Route | Privilège |
|---|---|---|
| Liste, détail | `GET /parametres[/{id}]` | `parametre_voir` |
| Création | `POST /parametres` | `parametre_creer` |
| Modification, si modifiable | `PATCH /parametres/{id}` | `parametre_modifier` |
| Suppression, si modifiable | `DELETE /parametres/{id}` | `parametre_supprimer` |
| Liste, détail | `GET /parametre-categories[/{id}]` | `parametre_categorie_voir` |
| Création | `POST /parametre-categories` | `parametre_categorie_creer` |
| Modification | `PATCH /parametre-categories/{id}` | `parametre_categorie_modifier` |
| Suppression, paramètres compris | `DELETE /parametre-categories/{id}` | `parametre_categorie_supprimer` |

Les codes suivent la convention de `unicaen:privilege:sync-routes --assign` : une fois les
privilèges créés, la commande relie chaque route au sien. Un référentiel prêt à copier est
fourni dans [docs/data/25_privilege_parametre.yaml](../docs/data/25_privilege_parametre.yaml),
avec la catégorie `unicaen_parametre` à déclarer.

## Migration depuis 1.x (unicaen-modern/parametre)

- Paquet renommé : `composer remove unicaen-modern/parametre` puis
  `composer require unicaen/parametre-bundle`. Le namespace `Unicaen\Parametre` ne change pas.
- Routes protégées par privilèges : créer les privilèges ci-dessus et lancer
  `unicaen:privilege:sync-routes --assign`.
- Schéma : codes uniques, catégorie obligatoire et supprimée en cascade, `valeur` et
  `valeurs_possibles` facultatives, `description` et `valeur` en texte long. Générer la
  migration avec `doctrine:migrations:diff`. Elle échoue s'il reste des paramètres sans
  catégorie ou des codes en double.
- Le champ JSON `valeurs_possibles` devient `valeursPossibles`.
- Collections non paginées.
+16 −6
Changes for composer.json: 16 added lines, 6 removed lines.
Original line number Diff line number Diff line
{
    "name": "unicaen-modern/parametre",
    "name": "unicaen/parametre-bundle",
    "type": "symfony-bundle",
    "description": "Bundle API Platform pour Unicaen Parametre",
    "description": "Bundle Unicaen Paramètre : paramètres applicatifs rangés par catégorie, API d'administration et lecture typée",
    "repositories": [
        {
            "type": "composer",
            "url": "https://gest.unicaen.fr/packagist"
            "url": "https://packagist.unicaen.fr"
        }
    ],
    "license": "MIT",
@@ -16,12 +16,22 @@
    },
    "require": {
        "php": "^8.2",
        "api-platform/core": "^4.1",
        "doctrine/orm": "^3.3",
        "api-platform/core": "^4.1"
        "symfony/config": "^7.4 || ^8.0",
        "symfony/dependency-injection": "^7.4 || ^8.0",
        "symfony/doctrine-bridge": "^7.4 || ^8.0",
        "symfony/expression-language": "^7.4 || ^8.0",
        "symfony/http-kernel": "^7.4 || ^8.0",
        "symfony/validator": "^7.4 || ^8.0",
        "symfony/yaml": "^7.4 || ^8.0",
        "unicaen/privilege-bundle": "^2.5"
    },
    "replace": {
        "unicaen-modern/parametre": "self.version"
    },
    "require-dev": {
        "friendsofphp/php-cs-fixer": "^3.75",
        "symfony/maker-bundle": "^1.62"
        "friendsofphp/php-cs-fixer": "^3.75"
    },
    "extra": {
        "symfony": {
+5 −0
Changes for config/services.yaml: 5 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -5,3 +5,8 @@ services:

  Unicaen\Parametre\:
    resource: '../src/*'
    exclude:
      - '../src/DependencyInjection/'
      - '../src/Entity/'
      - '../src/Exception/'
      - '../src/UnicaenParametreBundle.php'
+20 −0
Changes for src/DependencyInjection/UnicaenParametreExtension.php: 20 added lines, 0 removed lines.
Original line number Diff line number Diff line
<?php

namespace Unicaen\Parametre\DependencyInjection;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

class UnicaenParametreExtension extends Extension
{
    /**
     * @param array<array<mixed>> $configs configuration de l'application, inutilisée
     */
    public function load(array $configs, ContainerBuilder $container): void
    {
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config'));
        $loader->load('services.yaml');
    }
}
Loading