feat: add to summit attendee serializer notes collection

Change-Id: I08aa734581ec852171a8d4f9a7b811c0fa535c1a

Author: smarcet

Libs/ModelSerializers/AbstractSerializer.php

@@ -277,6 +277,7 @@ public function serialize($expand = null, array $fields = [], array $relations =
         $values = [];
         $method_prefix = ['get', 'is'];
         if (!count($fields)) $fields = $this->getAllowedFields();
+        if (!count($relations)) $relations = $this->getAllowedRelations();
         $mappings = $this->getAttributeMappings();
         if (count($mappings)) {
             $new_values = [];
@@ -407,9 +408,10 @@ protected function _expand(array $values, ?string $expand, array $fields = [], a
                 $has = $serializerSpec['has'] ?? null;
                 $test_rule = $serializerSpec['test_rule'] ?? null;
                 $should_skip_rule = $serializerSpec['should_skip_rule'] ?? null;
+                $should_verify_relation = $serializerSpec['should_verify_relation'] ?? false;
                 $serializer_type = $serializerSpec['serializer_type'] ?? SerializerRegistry::SerializerType_Public;
                 $serializer = new $serializerClass($original_attribute, $attribute, $getter, $has, $serializer_type, $test_rule, $should_skip_rule);
-                $values = $serializer->serialize($this->object, $values, $expand, $fields, $relations, $params);
+                $values = $serializer->serialize($this->object, $values, $expand, $fields, $relations, $params, $should_verify_relation);
             }
         }
 

Libs/ModelSerializers/Many2OneExpandSerializer.php

@@ -19,20 +19,32 @@
  */
 class Many2OneExpandSerializer extends One2ManyExpandSerializer
 {
+
     /**
-     * @param mixed $entity
+     * @param $entity
      * @param array $values
      * @param string $expand
      * @param array $fields
      * @param array $relations
      * @param array $params
+     * @param bool $should_verify_relation
      * @return array
      */
-    public function serialize($entity, array $values, string $expand, array $fields = [], array $relations = [], array $params = []): array
-    {
+    public function serialize
+    (
+        $entity,
+        array $values,
+        string $expand,
+        array $fields = [],
+        array $relations = [],
+        array $params = [],
+        bool $should_verify_relation = false
+    ): array
+     {
         $testRuleRes = is_null($this->test_rule) ? true : call_user_func($this->test_rule, $entity);
         if(!$testRuleRes) return $values;
         $values = $this->unsetOriginalAttribute($values);
+        if($should_verify_relation && !in_array($this->attribute, $relations)) return $values;
         $res = [];
         foreach ($entity->{$this->getter}() as $item){
             $shouldSkip = is_null($this->should_skip_rule) ? false : call_user_func($this->should_skip_rule, $item, $params);

Libs/ModelSerializers/One2ManyExpandSerializer.php

@@ -109,15 +109,25 @@ protected function unsetOriginalAttribute(array $values)
     }
 
     /**
-     * @param mixed $entity
+     * @param $entity
      * @param array $values
      * @param string $expand
      * @param array $fields
      * @param array $relations
      * @param array $params
+     * @param bool $should_verify_relation
      * @return array
      */
-    public function serialize($entity, array $values, string $expand, array $fields = [], array $relations = [], array $params = []): array
+    public function serialize
+    (
+        $entity,
+        array $values,
+        string $expand,
+        array $fields = [],
+        array $relations = [],
+        array $params = [],
+        bool $should_verify_relation = false
+    ): array
     {
         Log::debug
         (

app/ModelSerializers/IExpandSerializer.php

@@ -19,10 +19,23 @@
 interface IExpandSerializer
 {
     /**
-     * @param mixed $entity
+     * @param $entity
      * @param array $values
      * @param string $expand
+     * @param array $fields
+     * @param array $relations
+     * @param array $params
+     * @param bool $should_verify_relation
      * @return array
      */
-    public function serialize($entity, array $values, string $expand): array;
+    public function serialize
+    (
+        $entity,
+        array $values,
+        string $expand,
+        array $fields = [],
+        array $relations = [],
+        array $params = [],
+        bool $should_verify_relation = false
+    ): array;
 }

app/ModelSerializers/Summit/Registration/SummitAttendeeAdminSerializer.php

@@ -1,4 +1,6 @@
 <?php namespace ModelSerializers;
+use Libs\ModelSerializers\Many2OneExpandSerializer;
+
 /**
  * Copyright 2016 OpenStack Foundation
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,7 +20,18 @@
 class SummitAttendeeAdminSerializer extends SummitAttendeeSerializer
 {
     protected static $array_mappings = [
-        'AdminNotes' => 'admin_notes:json_string',
         'VirtualCheckedIn' => 'has_virtual_check_in:json_boolean',
     ];
+
+    protected static $allowed_relations = [
+        'notes',
+    ];
+
+    protected static $expand_mappings = [
+        'notes' => [
+            'type' => Many2OneExpandSerializer::class,
+            'getter' => 'getNotes',
+            'should_verify_relation' => true
+        ],
+    ];
 }