fix(ZMS): show alternative locations for offices (#820)

Co-authored-by: Thomas Fink <tom@Thomass-MacBook-Air.local>
it-at-m · Feb 6, 2025 · a7b3a64 · a7b3a64
1 parent 160dae9
commit a7b3a64
Show file tree

Hide file tree

Showing 11 changed files with 132 additions and 29 deletions.
diff --git a/zmscitizenapi/src/Zmscitizenapi/Models/Office.php b/zmscitizenapi/src/Zmscitizenapi/Models/Office.php
@@ -24,6 +24,9 @@ class Office extends Entity implements JsonSerializable
     /** @var array|null */
     public ?array $displayNameAlternatives = null;
 
+    /** @var bool|null */
+    public ?bool $showAlternativeLocations = null;
+
     /** @var string|null */
     public ?string $organization = null;
 
@@ -43,6 +46,7 @@ public function __construct(
         int $id,
         string $name,
         ?array $address = null,
+        ?bool $showAlternativeLocations = null,
         ?array $displayNameAlternatives = null,
         ?string $organization = null,
         ?string $organizationUnit = null,
@@ -53,6 +57,7 @@ public function __construct(
         $this->id = $id;
         $this->name = $name;
         $this->address = $address;
+        $this->showAlternativeLocations = $showAlternativeLocations;
         $this->displayNameAlternatives = $displayNameAlternatives;
         $this->organization = $organization;
         $this->organizationUnit = $organizationUnit;
@@ -81,6 +86,7 @@ public function toArray(): array
             'id' => $this->id,
             'name' => $this->name,
             'address' => $this->address,
+            'showAlternativeLocations' => $this->showAlternativeLocations,
             'displayNameAlternatives' => $this->displayNameAlternatives,
             'organization' => $this->organization,
             'organizationUnit' => $this->organizationUnit,

diff --git a/zmscitizenapi/src/Zmscitizenapi/Services/Core/MapperService.php b/zmscitizenapi/src/Zmscitizenapi/Services/Core/MapperService.php
@@ -63,6 +63,7 @@ public static function mapOfficesWithScope(ProviderList $providerList): OfficeLi
                 id: isset($provider->id) ? (int) $provider->id : 0,
                 name: isset($provider->displayName) ? $provider->displayName : (isset($provider->name) ? $provider->name : null),
                 address: isset($provider->data['address']) ? $provider->data['address'] : null,
+                showAlternativeLocations: isset($provider->data['showAlternativeLocations']) ? $provider->data['showAlternativeLocations'] : null,
                 displayNameAlternatives: $provider->data['displayNameAlternatives'] ?? [],
                 organization: $provider->data['organization'] ?? null,
                 organizationUnit: $provider->data['organizationUnit'] ?? null,

diff --git a/zmscitizenapi/src/Zmscitizenapi/Services/Core/ZmsApiFacadeService.php b/zmscitizenapi/src/Zmscitizenapi/Services/Core/ZmsApiFacadeService.php
@@ -63,6 +63,7 @@ public static function getOffices(): OfficeList
                 id: (int) $provider->id,
                 name: $provider->displayName ?? $provider->name,
                 address: $provider->data['address'] ?? null,
+                showAlternativeLocations: $provider->data['showAlternativeLocations'] ?? null,
                 displayNameAlternatives: $provider->data['displayNameAlternatives'] ?? [],
                 organization: $provider->data['organization'] ?? null,
                 organizationUnit: $provider->data['organizationUnit'] ?? null,
@@ -251,6 +252,11 @@ public static function getOfficeListByServiceId(int $serviceId): OfficeList|arra
                 $offices[] = new Office(
                     id: (int) $provider->id,
                     name: $provider->name,
+                    showAlternativeLocations: $provider->data['showAlternativeLocations'] ?? null,
+                    displayNameAlternatives: $provider->data['displayNameAlternatives'] ?? [],
+                    organization: $provider->data['organization'] ?? null,
+                    organizationUnit: $provider->data['organizationUnit'] ?? null,
+                    slotTimeInMinutes: $provider->data['slotTimeInMinutes'] ?? null,
                     address: $provider->address ?? null,
                     geo: $provider->geo ?? null,
                     scope: $scope
@@ -373,6 +379,7 @@ public static function getOfficesThatProvideService(int $serviceId): OfficeList|
                         id: (int) $provider->id,
                         name: $provider->displayName ?? $provider->name,
                         address: $provider->data['address'] ?? null,
+                        showAlternativeLocations: $provider->data['showAlternativeLocations'] ?? null,
                         displayNameAlternatives: $provider->data['displayNameAlternatives'] ?? [],
                         organization: $provider->data['organization'] ?? null,
                         organizationUnit: $provider->data['organizationUnit'] ?? null,

diff --git a/zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficeListByServiceControllerTest.php b/zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficeListByServiceControllerTest.php
@@ -42,7 +42,8 @@ public function testRendering()
                     "id" => 9999999,
                     "name" => "Unittest Source Dienstleister 2",
                     "address" => null,
-                    "displayNameAlternatives" => null,
+                    "showAlternativeLocations" => true,
+                    "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,
                     "slotTimeInMinutes" => null,
@@ -102,7 +103,8 @@ public function testRenderingRequestRelation()
                     "id" => 9999998,
                     "name" => "Unittest Source Dienstleister",
                     "address" => null,
-                    "displayNameAlternatives" => null,
+                    "showAlternativeLocations" => false,
+                    "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,
                     "slotTimeInMinutes" => null,
@@ -139,7 +141,8 @@ public function testRenderingRequestRelation()
                     "id" => 9999999,
                     "name" => "Unittest Source Dienstleister 2",
                     "address" => null,
-                    "displayNameAlternatives" => null,
+                    "showAlternativeLocations" => true,
+                    "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,
                     "slotTimeInMinutes" => null,

diff --git a/zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesListControllerTest.php b/zmscitizenapi/tests/Zmscitizenapi/Controllers/Office/OfficesListControllerTest.php
@@ -41,6 +41,7 @@ public function testRendering()
                     "id" => 9999998,
                     "name" => "Unittest Source Dienstleister",
                     "address" => null,
+                    "showAlternativeLocations" => false,
                     "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,
@@ -81,6 +82,7 @@ public function testRendering()
                     "id" => 9999999,
                     "name" => "Unittest Source Dienstleister 2",
                     "address" => null,
+                    "showAlternativeLocations" => true,
                     "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,

diff --git a/...izenapi/tests/Zmscitizenapi/Controllers/Office/OfficesServicesRelationsControllerTest.php b/...izenapi/tests/Zmscitizenapi/Controllers/Office/OfficesServicesRelationsControllerTest.php
@@ -41,6 +41,7 @@ public function testRendering()
                     "id" => 9999998,
                     "name" => "Unittest Source Dienstleister",
                     "address" => null,
+                    "showAlternativeLocations" => false,
                     "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,
@@ -81,6 +82,7 @@ public function testRendering()
                     "id" => 9999999,
                     "name" => "Unittest Source Dienstleister 2",
                     "address" => null,
+                    "showAlternativeLocations" => true,
                     "displayNameAlternatives" => [],
                     "organization" => null,
                     "organizationUnit" => null,

diff --git a/zmscitizenapi/tests/Zmscitizenapi/Services/Core/ZmsApiFacadeServiceTest.php b/zmscitizenapi/tests/Zmscitizenapi/Services/Core/ZmsApiFacadeServiceTest.php
@@ -64,7 +64,8 @@ public function testGetOfficesSuccess(): void
                 'city' => 'Test City',
                 'postal_code' => '12345'
             ],
-            'geo' => ['lat' => 48.137154, 'lon' => 11.576124]
+            'geo' => ['lat' => 48.137154, 'lon' => 11.576124],
+            'showAlternativeLocations' => false
         ];
 
         $scope = new Scope();

diff --git a/zmscitizenapi/tests/Zmscitizenapi/fixtures/GET_SourceGet_dldb.json b/zmscitizenapi/tests/Zmscitizenapi/fixtures/GET_SourceGet_dldb.json
@@ -24,7 +24,8 @@
           "geo": {
             "lat": "48.12750898398659",
             "lon": "11.604317899956524"
-          }
+          },
+          "showAlternativeLocations": false
         },
         "contact": {
           "city": "Berlin",
@@ -46,7 +47,8 @@
           "geo": {
             "lat": "48.12750898398659",
             "lon": "11.604317899956524"
-          }
+          },
+          "showAlternativeLocations": true
         },
         "contact": {
           "city": "Berlin",

diff --git a/zmsentities/schema/citizenapi/collections/officeList.json b/zmsentities/schema/citizenapi/collections/officeList.json
@@ -1,5 +1,9 @@
 {
-  "type": ["array", "object", "null"],
+  "type": [
+    "array",
+    "object",
+    "null"
+  ],
   "properties": {
     "offices": {
       "type": "array",
@@ -21,6 +25,13 @@
             ],
             "description": "The name of the office"
           },
+          "showAlternativeLocations": {
+            "type": [
+              "boolean",
+              "null"
+            ],
+            "description": "Show alternative office locations in the citizen calendar"
+          },
           "address": {
             "type": [
               "array",
@@ -59,19 +70,31 @@
             }
           },
           "displayNameAlternatives": {
-            "type": ["array", "null"],
+            "type": [
+              "array",
+              "null"
+            ],
             "description": "Alternative names of the office"
           },
           "organization": {
-            "type": ["string", "null"],
+            "type": [
+              "string",
+              "null"
+            ],
             "description": "The name of the Organization"
           },
           "organizationUnit": {
-            "type": ["string", "null"],
+            "type": [
+              "string",
+              "null"
+            ],
             "description": "The name of the organization"
           },
           "slotTimeInMinutes": {
-            "type": ["integer", "null"],
+            "type": [
+              "integer",
+              "null"
+            ],
             "description": "Slot time in minutes"
           },
           "geo": {

diff --git a/zmsentities/schema/citizenapi/collections/officeServiceAndRelationList.json b/zmsentities/schema/citizenapi/collections/officeServiceAndRelationList.json
@@ -26,6 +26,13 @@
             ],
             "description": "The name of the office"
           },
+          "showAlternativeLocations": {
+            "type": [
+              "boolean",
+              "null"
+            ],
+            "description": "Show alternative office locations in the citizen calendar"
+          },
           "address": {
             "type": [
               "array",
@@ -64,19 +71,31 @@
             }
           },
           "displayNameAlternatives": {
-            "type": ["array", "null"],
+            "type": [
+              "array",
+              "null"
+            ],
             "description": "Alternative names of the office"
           },
           "organization": {
-            "type": ["string", "null"],
+            "type": [
+              "string",
+              "null"
+            ],
             "description": "The name of the Organization"
           },
           "organizationUnit": {
-            "type": ["string", "null"],
+            "type": [
+              "string",
+              "null"
+            ],
             "description": "The name of the organization"
           },
           "slotTimeInMinutes": {
-            "type": ["integer", "null"],
+            "type": [
+              "integer",
+              "null"
+            ],
             "description": "Slot time in minutes"
           },
           "geo": {

diff --git a/zmsentities/schema/citizenapi/office.json b/zmsentities/schema/citizenapi/office.json
@@ -1,20 +1,41 @@
 {
     "title": "Office",
-    "type": ["array", "object"],
+    "type": [
+        "array",
+        "object"
+    ],
     "properties": {
         "id": {
             "type": "integer",
             "description": "Unique identifier for the office"
         },
         "name": {
-            "type": ["string", "null"],
+            "type": [
+                "string",
+                "null"
+            ],
             "description": "The name of the office"
         },
+        "showAlternativeLocations": {
+            "type": [
+                "boolean",
+                "null"
+            ],
+            "description": "Show alternative office locations in the citizen calendar"
+        },
         "address": {
-            "type": ["array", "object", "null"],
+            "type": [
+                "array",
+                "object",
+                "null"
+            ],
             "description": "The address of the office",
             "items": {
-                "type": ["array", "object", "null"],
+                "type": [
+                    "array",
+                    "object",
+                    "null"
+                ],
                 "properties": {
                     "house_number": {
                         "type": "string",
@@ -40,23 +61,39 @@
             }
         },
         "displayNameAlternatives": {
-            "type": ["array", "null"],
+            "type": [
+                "array",
+                "null"
+            ],
             "description": "Alternative names of the office"
         },
         "organization": {
-            "type": ["string", "null"],
+            "type": [
+                "string",
+                "null"
+            ],
             "description": "The name of the Organization"
         },
         "organizationUnit": {
-            "type": ["string", "null"],
+            "type": [
+                "string",
+                "null"
+            ],
             "description": "The name of the organization"
         },
         "slotTimeInMinutes": {
-            "type": ["integer", "null"],
+            "type": [
+                "integer",
+                "null"
+            ],
             "description": "Slot time in minutes"
         },
         "geo": {
-            "type": ["array", "object", "null"],
+            "type": [
+                "array",
+                "object",
+                "null"
+            ],
             "description": "Geographical coordinates of the office",
             "properties": {
                 "lat": {
@@ -73,10 +110,10 @@
                 }
             }
         },
-        "scope": {
-
-        }
+        "scope": {}
     },
-    "required": ["id"],
+    "required": [
+        "id"
+    ],
     "description": "Schema definition for the Office entity"
-}
+}