Prend en charge les catégories pour les caractéristiques spéciales (API)

Robert-2 · Jan 27, 2021 · ae29df6 · ae29df6
1 parent ba9ea34
commit ae29df6
Show file tree

Hide file tree

Showing 11 changed files with 397 additions and 106 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ Ce projet adhère au principe du [Semantic Versioning](https://semver.org/spec/v
 ## 0.12.0 (unreleased)
 
 - Améliore le calcul du matériel restant dans les événements.
+- Ajoute la possibilité de limiter les caractéristiques spéciales du matériel par catégorie (#91).
 
 ## 0.11.0 (2021-01-14)
 

diff --git a/server/src/App/ApiRouter.php b/server/src/App/ApiRouter.php
@@ -7,6 +7,7 @@ class ApiRouter
 {
     private $_routes = [
         'get' => [
+            '/attributes[/]'                           => 'AttributeController:getAll',
             '/users[/]'                                => 'UserController:getAll',
             '/users/{id:[0-9]+}[/]'                    => 'UserController:getOne',
             '/users/{id:[0-9]+}/settings[/]'           => 'UserController:getSettings',
@@ -28,7 +29,6 @@ class ApiRouter
             '/materials[/]'                            => 'MaterialController:getAll',
             '/materials/{id:[0-9]+}[/]'                => 'MaterialController:getOne',
             '/materials/{id:[0-9]+}/tags[/]'           => 'MaterialController:getTags',
-            '/materials/attributes[/]'                 => 'MaterialController:getAttributes',
             '/events[/]'                               => 'EventController:getAll',
             '/events/{id:[0-9]+}[/]'                   => 'EventController:getOne',
             '/events/{id:[0-9]+}/missing-materials[/]' => 'EventController:getMissingMaterials',

diff --git a/server/src/App/Controllers/AttributeController.php b/server/src/App/Controllers/AttributeController.php
@@ -3,6 +3,48 @@
 
 namespace Robert2\API\Controllers;
 
+use Slim\Http\Request;
+use Slim\Http\Response;
+
 class AttributeController extends BaseController
 {
+    public function getAll(Request $request, Response $response): Response
+    {
+        $categoryId = $request->getQueryParam('category', null);
+
+        $attributes = $this->model->orderBy('name', 'asc');
+        if (!empty($categoryId)) {
+            $attributes
+                ->whereDoesntHave('categories')
+                ->orWhereHas('categories', function ($query) use ($categoryId) {
+                    $query->where('categories.id', $categoryId);
+                });
+        }
+
+        $results = $attributes->with('categories')->get()->toArray();
+
+        return $response->withJson($results);
+    }
+
+    public function create(Request $request, Response $response): Response
+    {
+        $postData = $request->getParsedBody();
+        if (empty($postData)) {
+            throw new \InvalidArgumentException(
+                "Missing request data to process validation",
+                ERROR_VALIDATION
+            );
+        }
+
+        $attribute = $this->model->edit(null, $postData);
+
+        if (isset($postData['categories'])) {
+            $attribute->Categories()->sync($postData['categories']);
+        }
+
+        $categories = $attribute->Categories()->get()->toArray();
+        $result = $attribute->toArray() + compact('categories');
+
+        return $response->withJson($result, SUCCESS_CREATED);
+    }
 }
diff --git a/server/src/App/Controllers/MaterialController.php b/server/src/App/Controllers/MaterialController.php
@@ -87,13 +87,6 @@ public function getAll(Request $request, Response $response): Response
         return $response->withJson($results);
     }
 
-    public function getAttributes(Request $request, Response $response): Response
-    {
-        $attributes = new Attribute();
-        $result = $attributes->getAll()->get();
-        return $response->withJson($result->toArray());
-    }
-
     // ------------------------------------------------------
     // -
     // -    Setters

diff --git a/server/src/App/Models/Attribute.php b/server/src/App/Models/Attribute.php
@@ -3,6 +3,7 @@
 
 namespace Robert2\API\Models;
 
+use Illuminate\Database\Eloquent\Builder;
 use Robert2\API\Validation\Validator as V;
 
 class Attribute extends BaseModel
@@ -21,7 +22,7 @@ public function __construct(array $attributes = [])
                 v::equals('float'),
                 v::equals('boolean')
             ),
-            'unit'       => V::optional(V::length(1, 8)),
+            'unit' => V::optional(V::length(1, 8)),
             'max_length' => V::optional(V::numeric()),
         ];
     }
@@ -40,16 +41,23 @@ public function Materials()
             ->select(['materials.id', 'name']);
     }
 
+    public function Categories()
+    {
+        return $this->belongsToMany('Robert2\API\Models\Category', 'attribute_categories')
+            ->orderBy('name')
+            ->select(['categories.id', 'name']);
+    }
+
     // ——————————————————————————————————————————————————————
     // —
     // —    Mutators
     // —
     // ——————————————————————————————————————————————————————
 
     protected $casts = [
-        'name'       => 'string',
-        'type'       => 'string',
-        'unit'       => 'string',
+        'name' => 'string',
+        'type' => 'string',
+        'unit' => 'string',
         'max_length' => 'integer',
     ];
 
@@ -59,6 +67,23 @@ public function getMaterialsAttribute()
         return $materials ? $materials->toArray() : null;
     }
 
+    public function getCategoriesAttribute()
+    {
+        return $this->Categories()->get()->toArray();
+    }
+
+    // ——————————————————————————————————————————————————————
+    // —
+    // —    Getters
+    // —
+    // ——————————————————————————————————————————————————————
+
+    public function getAll(bool $withDeleted = false): Builder
+    {
+        $builder = parent::getAll($withDeleted);
+        return $builder->with('categories');
+    }
+
     // ——————————————————————————————————————————————————————
     // —
     // —    Setters

diff --git a/server/src/App/Models/Category.php b/server/src/App/Models/Category.php
@@ -42,7 +42,7 @@ public function SubCategories()
 
     public function Materials()
     {
-        $fields = [
+        return $this->hasMany('Robert2\API\Models\Material')->select([
             'id',
             'name',
             'description',
@@ -52,9 +52,14 @@ public function Materials()
             'stock_quantity',
             'out_of_order_quantity',
             'replacement_price',
-        ];
+        ]);
+    }
 
-        return $this->hasMany('Robert2\API\Models\Material')->select($fields);
+    public function Attributes()
+    {
+        return $this->belongsToMany('Robert2\API\Models\Attribute', 'attribute_categories')
+            ->using('Robert2\API\Models\AttributeCategoriesPivot')
+            ->select(['attributes.id', 'attributes.name', 'attributes.type', 'attributes.unit']);
     }
 
     // ——————————————————————————————————————————————————————

diff --git a/server/src/database/migrations/20210126172803_add_attributes_categories_relation.php b/server/src/database/migrations/20210126172803_add_attributes_categories_relation.php
@@ -0,0 +1,31 @@
+<?php
+use Phinx\Migration\AbstractMigration;
+
+class AddAttributesCategoriesRelation extends AbstractMigration
+{
+    public function up()
+    {
+        $table = $this->table('attribute_categories');
+        $table
+            ->addColumn('attribute_id', 'integer')
+            ->addColumn('category_id', 'integer')
+            ->addIndex(['attribute_id'])
+            ->addForeignKey('attribute_id', 'attributes', 'id', [
+                'delete'     => 'CASCADE',
+                'update'     => 'NO_ACTION',
+                'constraint' => 'fk_attribute_categories_attribute'
+            ])
+            ->addIndex(['category_id'])
+            ->addForeignKey('category_id', 'categories', 'id', [
+                'delete'     => 'CASCADE',
+                'update'     => 'NO_ACTION',
+                'constraint' => 'fk_attribute_categories_category'
+            ])
+            ->create();
+    }
+
+    public function down()
+    {
+        $this->table('attribute_categories')->drop()->save();
+    }
+}
diff --git a/server/tests/Fixtures/seed/attribute_categories.json b/server/tests/Fixtures/seed/attribute_categories.json
@@ -0,0 +1,14 @@
+[
+    {
+        "attribute_id": 1,
+        "category_id": 1
+    },
+    {
+        "attribute_id": 1,
+        "category_id": 2
+    },
+    {
+        "attribute_id": 3,
+        "category_id": 1
+    }
+]