Merge branch release/v2.6.0

Author: roadiz-ci

.github/workflows/run-test.yml

@@ -19,7 +19,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.2', '8.3']
+                php-version: ['8.3', '8.4']
         steps:
             - uses: shivammathur/setup-php@v2
               with:

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2024 Ambroise Maupate
+Copyright © 2025 Ambroise Maupate
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

composer.json

@@ -18,22 +18,24 @@
         }
     ],
     "require": {
-        "php": ">=8.2",
+        "php": ">=8.3",
         "doctrine/orm": "~2.20.0",
-        "jms/serializer": "^3.32.3",
-        "roadiz/nodetype-contracts": "^2.0.0",
-        "symfony/string": "6.4.*",
+        "api-platform/doctrine-orm": "^4.1.18",
+        "api-platform/metadata": "^4.1.18",
+        "roadiz/nodetype-contracts": "^3.0.0",
+        "symfony/string": "7.3.*",
         "symfony/translation-contracts": "^3.0",
-        "symfony/http-foundation": "6.4.*",
-        "symfony/serializer": "6.4.*",
-        "symfony/validator": "6.4.*"
+        "symfony/http-foundation": "7.3.*",
+        "symfony/serializer": "7.3.*",
+        "symfony/uid": "7.3.*",
+        "symfony/validator": "7.3.*"
     },
     "require-dev": {
         "doctrine/doctrine-bundle": "^2.8.1",
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
         "phpstan/phpdoc-parser": "<2",
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.6"
     },
     "autoload": {
         "psr-4": {
@@ -53,8 +55,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.5.x-dev",
-            "dev-develop": "2.6.x-dev"
+            "dev-master": "2.6.x-dev",
+            "dev-develop": "2.7.x-dev"
         }
     }
 }

src/Bag/LazyParameterBag.php

@@ -23,6 +23,7 @@ public function __construct()
      *
      * @return mixed|null
      */
+    #[\Override]
     public function get(string $key, $default = null): mixed
     {
         if (!$this->ready) {
@@ -32,6 +33,7 @@ public function get(string $key, $default = null): mixed
         return parent::get($key, $default);
     }
 
+    #[\Override]
     public function all(?string $key = null): array
     {
         if (!$this->ready) {
@@ -41,6 +43,7 @@ public function all(?string $key = null): array
         return parent::all();
     }
 
+    #[\Override]
     public function has(string $key): bool
     {
         if (!$this->ready) {
@@ -50,6 +53,7 @@ public function has(string $key): bool
         return parent::has($key);
     }
 
+    #[\Override]
     public function keys(): array
     {
         if (!$this->ready) {
@@ -60,6 +64,7 @@ public function keys(): array
     }
 
     #[\ReturnTypeWillChange]
+    #[\Override]
     public function getIterator(): \ArrayIterator
     {
         if (!$this->ready) {
@@ -70,6 +75,7 @@ public function getIterator(): \ArrayIterator
     }
 
     #[\ReturnTypeWillChange]
+    #[\Override]
     public function count(): int
     {
         if (!$this->ready) {
@@ -83,6 +89,7 @@ public function count(): int
      * @param null  $default
      * @param array $options
      */
+    #[\Override]
     public function filter(string $key, $default = null, int $filter = \FILTER_DEFAULT, $options = []): mixed
     {
         if (!$this->ready) {

src/Core/AbstractEntities/AbstractDateTimed.php

@@ -5,11 +5,11 @@
 namespace RZ\Roadiz\Core\AbstractEntities;
 
 use Doctrine\ORM\Mapping as ORM;
-use JMS\Serializer\Annotation as Serializer;
-use Symfony\Component\Serializer\Annotation as SymfonySerializer;
 
 /**
  * An AbstractEntity with datetime fields to keep track of time with your items.
+ *
+ * @deprecated since 2.6, use composition with DateTimedTrait instead.
  */
 #[
     ORM\MappedSuperclass,
@@ -18,81 +18,7 @@
     ORM\Index(columns: ['created_at']),
     ORM\Index(columns: ['updated_at']),
 ]
-abstract class AbstractDateTimed extends AbstractEntity
+abstract class AbstractDateTimed extends AbstractEntity implements DateTimedInterface
 {
-    #[
-        ORM\Column(name: 'created_at', type: 'datetime', nullable: true),
-        Serializer\Groups(['timestamps']),
-        SymfonySerializer\Groups(['timestamps']),
-    ]
-    protected ?\DateTime $createdAt = null;
-
-    #[
-        ORM\Column(name: 'updated_at', type: 'datetime', nullable: true),
-        Serializer\Groups(['timestamps']),
-        SymfonySerializer\Groups(['timestamps']),
-    ]
-    protected ?\DateTime $updatedAt = null;
-
-    public function getCreatedAt(): ?\DateTime
-    {
-        return $this->createdAt;
-    }
-
-    /**
-     * @return $this
-     */
-    public function setCreatedAt(?\DateTime $createdAt): self
-    {
-        $this->createdAt = $createdAt;
-
-        return $this;
-    }
-
-    public function getUpdatedAt(): ?\DateTime
-    {
-        return $this->updatedAt;
-    }
-
-    /**
-     * @return $this
-     */
-    public function setUpdatedAt(?\DateTime $updatedAt): self
-    {
-        $this->updatedAt = $updatedAt;
-
-        return $this;
-    }
-
-    protected function initAbstractDateTimed(): void
-    {
-        $this->setUpdatedAt(new \DateTime('now'));
-        $this->setCreatedAt(new \DateTime('now'));
-    }
-
-    #[ORM\PreUpdate]
-    public function preUpdate(): void
-    {
-        $this->setUpdatedAt(new \DateTime('now'));
-    }
-
-    #[ORM\PrePersist]
-    public function prePersist(): void
-    {
-        $this->setUpdatedAt(new \DateTime('now'));
-        $this->setCreatedAt(new \DateTime('now'));
-    }
-
-    /**
-     * Set creation and update date to *now*.
-     *
-     * @return $this
-     */
-    public function resetDates(): self
-    {
-        $this->setCreatedAt(new \DateTime('now'));
-        $this->setUpdatedAt(new \DateTime('now'));
-
-        return $this;
-    }
+    use DateTimedTrait;
 }

src/Core/AbstractEntities/AbstractEntity.php

@@ -5,37 +5,17 @@
 namespace RZ\Roadiz\Core\AbstractEntities;
 
 use Doctrine\ORM\Mapping as ORM;
-use JMS\Serializer\Annotation as Serializer;
-use Symfony\Component\Serializer\Annotation as SymfonySerializer;
 
 /**
  * Base entity implementing PersistableInterface to offer a unique ID.
+ *
+ * @deprecated since 2.6, use composition with PersistableInterface and SequentialIdTrait or UuidTrait instead.
  */
 #[
     ORM\MappedSuperclass,
     ORM\Table
 ]
 abstract class AbstractEntity implements PersistableInterface
 {
-    #[
-        ORM\Id,
-        ORM\Column(type: 'integer'),
-        ORM\GeneratedValue,
-        Serializer\Groups(['id']),
-        Serializer\Type('integer'),
-        SymfonySerializer\Groups(['id'])
-    ]
-    protected int|string|null $id = null;
-
-    public function getId(): int|string|null
-    {
-        return $this->id;
-    }
-
-    public function setId(int|string|null $id): self
-    {
-        $this->id = $id;
-
-        return $this;
-    }
+    use SequentialIdTrait;
 }

src/Core/AbstractEntities/AbstractHuman.php

@@ -4,9 +4,11 @@
 
 namespace RZ\Roadiz\Core\AbstractEntities;
 
+use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
+use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Metadata\ApiFilter;
 use Doctrine\ORM\Mapping as ORM;
-use JMS\Serializer\Annotation as Serializer;
-use Symfony\Component\Serializer\Annotation as SymfonySerializer;
+use Symfony\Component\Serializer\Attribute as Serializer;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -19,17 +21,20 @@
     ORM\Table,
     ORM\HasLifecycleCallbacks
 ]
-abstract class AbstractHuman extends AbstractDateTimed
+abstract class AbstractHuman implements DateTimedInterface, PersistableInterface
 {
-    #[
-        ORM\Column(type: 'string', length: 200, unique: true),
-        Serializer\Groups(['user_personal', 'human']),
-        SymfonySerializer\Groups(['user_personal', 'human']),
-        Assert\NotNull(),
-        Assert\NotBlank(),
-        Assert\Length(max: 200),
-        Assert\Email()
-    ]
+    use SequentialIdTrait;
+    use DateTimedTrait;
+
+    #[ORM\Column(type: 'string', length: 200, unique: true, nullable: false)]
+    #[Serializer\Groups(['user_personal', 'human'])]
+    #[Assert\NotNull]
+    #[Assert\NotBlank]
+    #[Assert\Length(max: 200)]
+    #[Assert\Email]
+    #[ApiFilter(OrderFilter::class)]
+    #[ApiFilter(SearchFilter::class)]
+    // @phpstan-ignore-next-line
     protected ?string $email = null;
 
     /**
@@ -38,31 +43,27 @@ abstract class AbstractHuman extends AbstractDateTimed
     #[
         ORM\Column(name: 'publicName', type: 'string', length: 250, nullable: true),
         Serializer\Groups(['user_public', 'human']),
-        SymfonySerializer\Groups(['user_public', 'human']),
         Assert\Length(max: 250)
     ]
     protected ?string $publicName = null;
 
     #[
         ORM\Column(name: 'firstName', type: 'string', length: 250, nullable: true),
         Serializer\Groups(['user_personal', 'human']),
-        SymfonySerializer\Groups(['user_personal', 'human']),
         Assert\Length(max: 250)
     ]
     protected ?string $firstName = null;
 
     #[
         ORM\Column(name: 'lastName', type: 'string', length: 250, nullable: true),
         Serializer\Groups(['user_personal', 'human']),
-        SymfonySerializer\Groups(['user_personal', 'human']),
         Assert\Length(max: 250)
     ]
     protected ?string $lastName = null;
 
     #[
         ORM\Column(type: 'string', length: 250, nullable: true),
         Serializer\Groups(['user_personal', 'human']),
-        SymfonySerializer\Groups(['user_personal', 'human']),
         Assert\Length(max: 250)
     ]
     protected ?string $company = null;

src/Core/AbstractEntities/AbstractPositioned.php

@@ -4,29 +4,27 @@
 
 namespace RZ\Roadiz\Core\AbstractEntities;
 
-use Doctrine\Common\Comparable;
 use Doctrine\ORM\Mapping as ORM;
-use JMS\Serializer\Annotation as Serializer;
-use Symfony\Component\Serializer\Annotation as SymfonySerializer;
+use Symfony\Component\Serializer\Attribute as Serializer;
 
 /**
  * Combined AbstractEntity and PositionedTrait.
+ *
+ * @deprecated since 2.6, use composition with PositionedTrait and PositionedInterface instead.
  */
 #[
     ORM\MappedSuperclass,
     ORM\HasLifecycleCallbacks,
     ORM\Table,
     ORM\Index(columns: ['position'])
 ]
-abstract class AbstractPositioned extends AbstractEntity implements PositionedInterface, Comparable
+abstract class AbstractPositioned extends AbstractEntity implements PositionedInterface
 {
     use PositionedTrait;
 
     #[
         ORM\Column(type: 'float'),
         Serializer\Groups(['position']),
-        SymfonySerializer\Groups(['position']),
-        Serializer\Type('float')
     ]
     protected float $position = 0.0;
 }

src/Core/AbstractEntities/DateTimedInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\Core\AbstractEntities;
+
+interface DateTimedInterface
+{
+    public function getCreatedAt(): ?\DateTime;
+
+    /**
+     * @return $this
+     */
+    public function setCreatedAt(?\DateTime $createdAt): self;
+
+    public function getUpdatedAt(): ?\DateTime;
+
+    /**
+     * @return $this
+     */
+    public function setUpdatedAt(?\DateTime $updatedAt): self;
+}