Add attributes to make the code work even if doctrine/annotations is …

…not installed
willdurand · Oct 22, 2024 · b3b5da5 · b3b5da5
1 parent 73fcb54
commit b3b5da5
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 0 deletions.
diff --git a/src/Representation/AbstractSegmentedRepresentation.php b/src/Representation/AbstractSegmentedRepresentation.php
@@ -9,6 +9,7 @@
 /**
  * @Serializer\ExclusionPolicy("all")
  */
+#[Serializer\ExclusionPolicy('all')]
 abstract class AbstractSegmentedRepresentation extends RouteAwareRepresentation
 {
     /**
@@ -18,6 +19,9 @@ abstract class AbstractSegmentedRepresentation extends RouteAwareRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\Type('integer')]
+    #[Serializer\XmlAttribute]
     private $limit;
 
     /**
@@ -27,6 +31,9 @@ abstract class AbstractSegmentedRepresentation extends RouteAwareRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\Type('integer')]
+    #[Serializer\XmlAttribute]
     private $total;
 
     /**

diff --git a/src/Representation/CollectionRepresentation.php b/src/Representation/CollectionRepresentation.php
@@ -16,6 +16,9 @@
  *     embedded = @Hateoas\Embedded("expr(object.getResources())")
  * )
  */
+#[Serializer\ExclusionPolicy('all')]
+#[Serializer\XmlRoot('collection')]
+#[Hateoas\Relation(name: 'items', embedded: new Hateoas\Embedded(content: 'expr(object.getResources())'))]
 class CollectionRepresentation
 {
     /**

diff --git a/src/Representation/OffsetRepresentation.php b/src/Representation/OffsetRepresentation.php
@@ -54,6 +54,13 @@
  *      )
  * )
  */
+#[Serializer\ExclusionPolicy('all')]
+#[Serializer\XmlRoot('collection')]
+#[Serializer\AccessorOrder(order: 'custom', custom: ['offset', 'limit', 'total'])]
+#[Hateoas\Relation(name: 'first', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(0))', absolute: 'expr(object.isAbsolute())'))]
+#[Hateoas\Relation(name: 'last', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters((object.getTotal() - 1) - (object.getTotal() - 1) % object.getLimit()))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getTotal() === null)'))]
+#[Hateoas\Relation(name: 'next', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(object.getOffset() + object.getLimit()))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getTotal() !== null && (object.getOffset() + object.getLimit()) >= object.getTotal())'))]
+#[Hateoas\Relation(name: 'previous', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters((object.getOffset() > object.getLimit()) ? object.getOffset() - object.getLimit() : 0))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr(! object.getOffset())'))]
 class OffsetRepresentation extends AbstractSegmentedRepresentation
 {
     /**
@@ -62,6 +69,8 @@ class OffsetRepresentation extends AbstractSegmentedRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\XmlAttribute]
     private $offset;
 
     /**

diff --git a/src/Representation/PaginatedRepresentation.php b/src/Representation/PaginatedRepresentation.php
@@ -54,6 +54,13 @@
  *      )
  * )
  */
+#[Serializer\ExclusionPolicy('all')]
+#[Serializer\XmlRoot('collection')]
+#[Serializer\AccessorOrder(order: 'custom', custom: ['page', 'limit', 'pages', 'total'])]
+#[Hateoas\Relation(name: 'first', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(1))', absolute: 'expr(object.isAbsolute())'))]
+#[Hateoas\Relation(name: 'last', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(object.getPages()))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getPages() === null)'))]
+#[Hateoas\Relation(name: 'next', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(object.getPage() + 1))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getPages() !== null && (object.getPage() + 1) > object.getPages())'))]
+#[Hateoas\Relation(name: 'previous', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters(object.getPage() - 1))', absolute: 'expr(object.isAbsolute())'), exclusion: new Hateoas\Exclusion(excludeIf: 'expr((object.getPage() - 1) < 1)'))]
 class PaginatedRepresentation extends AbstractSegmentedRepresentation
 {
     /**
@@ -63,6 +70,9 @@ class PaginatedRepresentation extends AbstractSegmentedRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\Type('integer')]
+    #[Serializer\XmlAttribute]
     private $page;
 
     /**
@@ -72,6 +82,9 @@ class PaginatedRepresentation extends AbstractSegmentedRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\Type('integer')]
+    #[Serializer\XmlAttribute]
     private $pages;
 
     /**

diff --git a/src/Representation/RouteAwareRepresentation.php b/src/Representation/RouteAwareRepresentation.php
@@ -19,6 +19,8 @@
  *      )
  * )
  */
+#[Serializer\ExclusionPolicy('all')]
+#[Hateoas\Relation(name: 'self', href: new Hateoas\Route(name: 'expr(object.getRoute())', parameters: 'expr(object.getParameters())', absolute: 'expr(object.isAbsolute())'))]
 class RouteAwareRepresentation
 {
     /**
@@ -27,6 +29,8 @@ class RouteAwareRepresentation
      *
      * @var mixed
      */
+    #[Serializer\Inline]
+    #[Serializer\Expose]
     private $inline;
 
     /**

diff --git a/src/Representation/VndErrorRepresentation.php b/src/Representation/VndErrorRepresentation.php
@@ -33,6 +33,11 @@
  *      )
  * )
  */
+#[Serializer\ExclusionPolicy('all')]
+#[Serializer\XmlRoot('resource')]
+#[Hateoas\Relation(name: 'help', href: 'expr(object.getHelp())', exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getHelp() === null)'))]
+#[Hateoas\Relation(name: 'describes', href: 'expr(object.getDescribes())', exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getDescribes() === null)'))]
+#[Hateoas\Relation(name: 'about', href: 'expr(object.getAbout())', exclusion: new Hateoas\Exclusion(excludeIf: 'expr(object.getAbout() === null)'))]
 class VndErrorRepresentation
 {
     /**
@@ -41,6 +46,8 @@ class VndErrorRepresentation
      *
      * @var string
      */
+    #[Serializer\Expose]
+    #[Serializer\Type('string')]
     private $message;
 
     /**
@@ -50,6 +57,9 @@ class VndErrorRepresentation
      *
      * @var int
      */
+    #[Serializer\Expose]
+    #[Serializer\XmlAttribute]
+    #[Serializer\Type('integer')]
     private $logref;
 
     /**