feat: First part of the exposition of the Asso, Event, and UE entities (#24)

* feat: First part of the exposition of the Asso Event and UE entities

* 🐛 (Asso) Fixed a few problems of PR#24

createdAt and keywords are now exposed. Fixed import errors. Linted a space. Merged both class annotations in the same #[]. Added a sort based on the asso name. Added a filter on keywords

* 🐛 (Routes /assos) Polished the PR

null values will now be returned in routes /assos, /events and /ues. Descriptions are now returned in route GET /assos (short description) and GET /assos/{id} (long description). Memberships and
membership count are now exposed.

* 🐛 (/ues and /events) These files should have been in the previous PR. null values were not sent

set attribute "skip_null_values" to false in the exposition of /ues and /events

* 🐛 (/ues, /events) Polishing

Added security for /ues and /events routes. Parameters of ApiResource are now in the right order for files UE, Event and Asso. Changed filter for UE searching from exact to partial

* ⬆️ (PHP) upgrading from PHP 8.0 to PHP 8.1

This may be the reason why build are failing in PR#24

* 🐛 (php version) changed php version for tests

* 🐛 (composer.lock) regenerated composer.lock

* 🚨 (Asso.php and Event.php) Linted the whole project

Co-authored-by: pierre <[email protected]>
Co-authored-by: Teddy Roncin <[email protected]>

Author: 3 people

.php-version

@@ -1 +1 @@
-8.0
+8.1

.travis.yml

@@ -3,7 +3,7 @@ dist: focal
 
 language: php
 php:
-  - 8.0
+  - 8.1
 
 cache:
     directories:

composer.json

@@ -66,7 +66,11 @@
         "preferred-install": {
             "*": "dist"
         },
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "symfony/flex": true,
+            "symfony/runtime": true
+        }
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -2,21 +2,68 @@
 
 namespace App\Entity;
 
+use ApiPlatform\Core\Annotation\ApiFilter;
+use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
+use App\Controller\SoftDeleteController;
 use App\Repository\AssoRepository;
 use DateTime;
 use DateTimeInterface;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Serializer\Annotation\SerializedName;
 use Symfony\Component\Uid\Uuid;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
+ *  The main entity that represents all Assos.
+ *
  * @ORM\Entity(repositoryClass=AssoRepository::class)
  * @ORM\Table(name="assos")
  */
+#[
+    ApiResource(
+        collectionOperations: [
+            'get' => [
+                'normalization_context' => [
+                    'groups' => ['asso:read:some'],
+                ],
+            ],
+        ],
+        itemOperations: [
+            'get' => [
+                'normalization_context' => [
+                    'groups' => ['asso:read:one'],
+                ],
+            ],
+            'delete' => [
+                'controller' => SoftDeleteController::class,
+                'security' => "is_granted('ROLE_ADMIN')",
+            ],
+            'patch' => [
+                'denormalization_context' => [
+                    'groups' => ['asso:write:update'],
+                ],
+                'normalization_context' => [
+                    'groups' => ['asso:read:one'],
+                ],
+                'security' => "object == user or is_granted('ROLE_ADMIN')",
+            ],
+        ],
+        shortName: 'asso',
+        attributes: [
+            'pagination_items_per_page' => 10,
+        ],
+        normalizationContext: [
+            'skip_null_values' => false,
+        ],
+        order: ['name'],
+    ),
+    ApiFilter(SearchFilter::class, properties: ['name' => 'partial', 'keywords' => 'exact']),
+]
 class Asso
 {
     /**
@@ -27,6 +74,10 @@ class Asso
      *
      * @Assert\Uuid
      */
+    #[Groups([
+        'asso:read:one',
+        'asso:read:some',
+    ])]
     private $id;
 
     /**
@@ -46,6 +97,10 @@ class Asso
      * @Assert\Type("string")
      * @Assert\Length(min=1, max=100)
      */
+    #[Groups([
+        'asso:read:one',
+        'asso:read:some',
+    ])]
     private $name;
 
     /**
@@ -54,6 +109,9 @@ class Asso
      * @ORM\ManyToOne(targetEntity=Translation::class, cascade={"persist", "remove"})
      */
     #[SerializedName('descriptionShort')]
+    #[Groups([
+        'asso:read:some',
+    ])]
     private $descriptionShortTranslation;
 
     /**
@@ -62,6 +120,9 @@ class Asso
      * @ORM\ManyToOne(targetEntity=Translation::class, cascade={"persist", "remove"})
      */
     #[SerializedName('description')]
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $descriptionTranslation;
 
     /**
@@ -73,6 +134,9 @@ class Asso
      * @Assert\Length(min=1, max=100)
      * @Assert\Email
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $mail;
 
     /**
@@ -84,6 +148,9 @@ class Asso
      * @Assert\Length(min=0, max=30)
      * @Assert\Regex("/^0[0-9]{9}$/")
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $phoneNumber;
 
     /**
@@ -95,6 +162,9 @@ class Asso
      * @Assert\Length(min=0, max=100)
      * @Assert\Url
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $website;
 
     /**
@@ -105,13 +175,20 @@ class Asso
      * @Assert\Type("string")
      * @Assert\Length(min=0, max=100)
      */
+    #[Groups([
+        'asso:read:some',
+        'asso:read:one',
+    ])]
     private $logo;
 
     /**
      * @ORM\Column(type="datetime")
      *
      * @Assert\Type("\DateTimeInterface")
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $createdAt;
 
     /**
@@ -138,6 +215,9 @@ class Asso
      *     inverseJoinColumns={@ORM\JoinColumn(name="keyword", referencedColumnName="name")}
      * )
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $keywords;
 
     /**
@@ -152,6 +232,9 @@ class Asso
      *
      * @ORM\ManyToMany(targetEntity=Event::class, mappedBy="assos")
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $events;
 
     /**
@@ -166,6 +249,9 @@ class Asso
      *
      * @ORM\OneToMany(targetEntity=AssoMembership::class, mappedBy="asso", orphanRemoval=true)
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $assoMemberships;
 
     public function __construct()
@@ -464,4 +550,12 @@ public function removeAssoMembership(AssoMembership $assoMember): self
 
         return $this;
     }
+
+    #[Groups([
+        'asso:read:some',
+    ])]
+    public function getMembershipsCount(): int
+    {
+        return $this->assoMemberships->count();
+    }
 }

src/Entity/Asso.php

@@ -6,6 +6,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -22,6 +23,9 @@ class AssoKeyword
      * @Assert\Length(min=1, max=30)
      * @Assert\Regex("/^[a-z]{1,30}$/")
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $name;
 
     /**

src/Entity/AssoKeyword.php

@@ -9,6 +9,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator;
+use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Uid\Uuid;
 use Symfony\Component\Validator\Constraints as Assert;
 
@@ -34,6 +35,9 @@ class AssoMembership
      * @ORM\ManyToOne(targetEntity=User::class, inversedBy="assoMembership")
      * @ORM\JoinColumn(nullable=false)
      */
+    #[Groups([
+        'asso:read:one',
+    ])]
     private $user;
 
     /**