Only include set fields in jsonSerlialize output

This is more similar to the previous version and the output is much more usable, particularly for things like Country.
maxmind · Oct 30, 2023 · 827e756 · 827e756
1 parent c39fad7
commit 827e756
Show file tree

Hide file tree

Showing 18 changed files with 257 additions and 139 deletions.
diff --git a/src/Model/AnonymousIp.php b/src/Model/AnonymousIp.php
@@ -58,15 +58,28 @@ public function __construct(array $raw)
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'is_anonymous' => $this->isAnonymous,
-            'is_anonymous_vpn' => $this->isAnonymousVpn,
-            'is_hosting_provider' => $this->isHostingProvider,
-            'is_public_proxy' => $this->isPublicProxy,
-            'is_residential_proxy' => $this->isResidentialProxy,
-            'is_tor_exit_node' => $this->isTorExitNode,
-            'ip_address' => $this->ipAddress,
-            'network' => $this->network,
-        ];
+        $js = [];
+        if ($this->isAnonymous !== null) {
+            $js['is_anonymous'] = $this->isAnonymous;
+        }
+        if ($this->isAnonymousVpn !== null) {
+            $js['is_anonymous_vpn'] = $this->isAnonymousVpn;
+        }
+        if ($this->isHostingProvider !== null) {
+            $js['is_hosting_provider'] = $this->isHostingProvider;
+        }
+        if ($this->isPublicProxy !== null) {
+            $js['is_public_proxy'] = $this->isPublicProxy;
+        }
+        if ($this->isResidentialProxy !== null) {
+            $js['is_residential_proxy'] = $this->isResidentialProxy;
+        }
+        if ($this->isTorExitNode !== null) {
+            $js['is_tor_exit_node'] = $this->isTorExitNode;
+        }
+        $js['ip_address'] = $this->ipAddress;
+        $js['network'] = $this->network;
+
+        return $js;
     }
 }
diff --git a/src/Model/Asn.php b/src/Model/Asn.php
@@ -42,11 +42,17 @@ public function __construct(array $raw)
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'autonomous_system_number' => $this->autonomousSystemNumber,
-            'autonomous_system_organization' => $this->autonomousSystemOrganization,
-            'ip_address' => $this->ipAddress,
-            'network' => $this->network,
-        ];
+        $js = [];
+
+        if ($this->autonomousSystemNumber !== null) {
+            $js['autonomous_system_number'] = $this->autonomousSystemNumber;
+        }
+        if ($this->autonomousSystemOrganization !== null) {
+            $js['autonomous_system_organization'] = $this->autonomousSystemOrganization;
+        }
+        $js['ip_address'] = $this->ipAddress;
+        $js['network'] = $this->network;
+
+        return $js;
     }
 }
diff --git a/src/Model/City.php b/src/Model/City.php
@@ -4,6 +4,8 @@
 
 namespace GeoIp2\Model;
 
+use GeoIp2\Record\Subdivision;
+
 /**
  * Model class for the data returned by City Plus web service and City
  * database.
@@ -94,15 +96,29 @@ public function jsonSerialize(): ?array
     {
         $js = parent::jsonSerialize();
 
-        $js['city'] = $this->city->jsonSerialize();
-        $js['location'] = $this->location->jsonSerialize();
-        $js['postal'] = $this->postal->jsonSerialize();
+        $city = $this->city->jsonSerialize();
+        if (!empty($city)) {
+            $js['city'] = $city;
+        }
+
+        $location = $this->location->jsonSerialize();
+        if (!empty($location)) {
+            $js['location'] = $location;
+        }
+
+        $postal =
+         $this->postal->jsonSerialize();
+        if (!empty($postal)) {
+            $js['postal'] = $postal;
+        }
 
         $subdivisions = [];
         foreach ($this->subdivisions as $sub) {
             $subdivisions[] = $sub->jsonSerialize();
         }
-        $js['subdivisions'] = $subdivisions;
+        if (!empty($subdivisions)) {
+            $js['subdivisions'] = $subdivisions;
+        }
 
         return $js;
     }

diff --git a/src/Model/ConnectionType.php b/src/Model/ConnectionType.php
@@ -37,10 +37,13 @@ public function __construct(array $raw)
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'connection_type' => $this->connectionType,
-            'ip_address' => $this->ipAddress,
-            'network' => $this->network,
-        ];
+        $js = [];
+        if ($this->connectionType !== null) {
+            $js['connection_type'] = $this->connectionType;
+        }
+        $js['ip_address'] = $this->ipAddress;
+        $js['network'] = $this->network;
+
+        return $js;
     }
 }
diff --git a/src/Model/Country.php b/src/Model/Country.php
@@ -64,13 +64,32 @@ public function __construct(array $raw, array $locales = ['en'])
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'continent' => $this->continent->jsonSerialize(),
-            'country' => $this->country->jsonSerialize(),
-            'maxmind' => $this->maxmind->jsonSerialize(),
-            'registered_country' => $this->registeredCountry->jsonSerialize(),
-            'represented_country' => $this->representedCountry->jsonSerialize(),
-            'traits' => $this->traits->jsonSerialize(),
-        ];
+        $js = [];
+        $continent = $this->continent->jsonSerialize();
+        if (!empty($continent)) {
+            $js['continent'] = $continent;
+        }
+        $country = $this->country->jsonSerialize();
+        if (!empty($country)) {
+            $js['country'] = $country;
+        }
+        $maxmind = $this->maxmind->jsonSerialize();
+        if (!empty($maxmind)) {
+            $js['maxmind'] = $maxmind;
+        }
+        $registeredCountry = $this->registeredCountry->jsonSerialize();
+        if (!empty($registeredCountry)) {
+            $js['registered_country'] = $registeredCountry;
+        }
+        $representedCountry = $this->representedCountry->jsonSerialize();
+        if (!empty($representedCountry)) {
+            $js['represented_country'] = $representedCountry;
+        }
+        $traits = $this->traits->jsonSerialize();
+        if (!empty($traits)) {
+            $js['traits'] = $traits;
+        }
+
+        return $js;
     }
 }
diff --git a/src/Model/Domain.php b/src/Model/Domain.php
@@ -37,10 +37,13 @@ public function __construct(array $raw)
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'domain' => $this->domain,
-            'ip_address' => $this->ipAddress,
-            'network' => $this->network,
-        ];
+        $js = [];
+        if ($this->domain !== null) {
+            $js['domain'] = $this->domain;
+        }
+        $js['ip_address'] = $this->ipAddress;
+        $js['network'] = $this->network;
+
+        return $js;
     }
 }
diff --git a/src/Model/Isp.php b/src/Model/Isp.php
@@ -61,15 +61,28 @@ public function __construct(array $raw)
 
     public function jsonSerialize(): ?array
     {
-        return [
-            'autonomous_system_number' => $this->autonomousSystemNumber,
-            'autonomous_system_organization' => $this->autonomousSystemOrganization,
-            'isp' => $this->isp,
-            'mobile_country_code' => $this->mobileCountryCode,
-            'mobile_network_code' => $this->mobileNetworkCode,
-            'organization' => $this->organization,
-            'ip_address' => $this->ipAddress,
-            'network' => $this->network,
-        ];
+        $js = [];
+        if ($this->autonomousSystemNumber !== null) {
+            $js['autonomous_system_number'] = $this->autonomousSystemNumber;
+        }
+        if ($this->autonomousSystemOrganization !== null) {
+            $js['autonomous_system_organization'] = $this->autonomousSystemOrganization;
+        }
+        if ($this->isp !== null) {
+            $js['isp'] = $this->isp;
+        }
+        if ($this->mobileCountryCode !== null) {
+            $js['mobile_country_code'] = $this->mobileCountryCode;
+        }
+        if ($this->mobileNetworkCode !== null) {
+            $js['mobile_network_code'] = $this->mobileNetworkCode;
+        }
+        if ($this->organization !== null) {
+            $js['organization'] = $this->organization;
+        }
+        $js['ip_address'] = $this->ipAddress;
+        $js['network'] = $this->network;
+
+        return $js;
     }
 }
diff --git a/src/Record/AbstractPlaceRecord.php b/src/Record/AbstractPlaceRecord.php
@@ -23,8 +23,13 @@ public function __construct(array $record, array $locales = ['en'])
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();
-        $js['confidence'] = $this->confidence;
-        $js['geoname_id'] = $this->geonameId;
+        if ($this->confidence !== null) {
+            $js['confidence'] = $this->confidence;
+        }
+
+        if ($this->geonameId !== null) {
+            $js['geoname_id'] = $this->geonameId;
+        }
 
         return $js;
     }

diff --git a/src/Record/Continent.php b/src/Record/Continent.php
@@ -40,8 +40,12 @@ public function __construct(array $record, array $locales = ['en'])
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();
-        $js['code'] = $this->code;
-        $js['geoname_id'] = $this->geonameId;
+        if ($this->code !== null) {
+            $js['code'] = $this->code;
+        }
+        if ($this->geonameId !== null) {
+            $js['geoname_id'] = $this->geonameId;
+        }
 
         return $js;
     }

diff --git a/src/Record/Country.php b/src/Record/Country.php
@@ -46,8 +46,12 @@ public function __construct(array $record, array $locales = ['en'])
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();
-        $js['is_in_european_union'] = $this->isInEuropeanUnion;
-        $js['iso_code'] = $this->isoCode;
+        if ($this->isInEuropeanUnion !== false) {
+            $js['is_in_european_union'] = $this->isInEuropeanUnion;
+        }
+        if ($this->isoCode !== null) {
+            $js['iso_code'] = $this->isoCode;
+        }
 
         return $js;
     }

diff --git a/src/Record/Location.php b/src/Record/Location.php
@@ -58,14 +58,29 @@ public function __construct(array $record)
 
     public function jsonSerialize(): array
     {
-        return [
-            'average_income' => $this->averageIncome,
-            'accuracy_radius' => $this->accuracyRadius,
-            'latitude' => $this->latitude,
-            'longitude' => $this->longitude,
-            'metro_code' => $this->metroCode,
-            'population_density' => $this->populationDensity,
-            'time_zone' => $this->timeZone,
-        ];
+        $js = [];
+        if ($this->averageIncome !== null) {
+            $js['average_income'] = $this->averageIncome;
+        }
+        if ($this->accuracyRadius !== null) {
+            $js['accuracy_radius'] = $this->accuracyRadius;
+        }
+        if ($this->latitude !== null) {
+            $js['latitude'] = $this->latitude;
+        }
+        if ($this->longitude !== null) {
+            $js['longitude'] = $this->longitude;
+        }
+        if ($this->metroCode !== null) {
+            $js['metro_code'] = $this->metroCode;
+        }
+        if ($this->populationDensity !== null) {
+            $js['population_density'] = $this->populationDensity;
+        }
+        if ($this->timeZone !== null) {
+            $js['time_zone'] = $this->timeZone;
+        }
+
+        return $js;
     }
 }
diff --git a/src/Record/MaxMind.php b/src/Record/MaxMind.php
@@ -23,8 +23,11 @@ public function __construct(array $record)
 
     public function jsonSerialize(): array
     {
-        return [
-            'queries_remaining' => $this->queriesRemaining,
-        ];
+        $js = [];
+        if ($this->queriesRemaining !== null) {
+            $js['queries_remaining'] = $this->queriesRemaining;
+        }
+
+        return $js;
     }
 }
diff --git a/src/Record/Postal.php b/src/Record/Postal.php
@@ -35,9 +35,14 @@ public function __construct(array $record)
 
     public function jsonSerialize(): array
     {
-        return [
-            'code' => $this->code,
-            'confidence' => $this->confidence,
-        ];
+        $js = [];
+        if ($this->code !== null) {
+            $js['code'] = $this->code;
+        }
+        if ($this->confidence !== null) {
+            $js['confidence'] = $this->confidence;
+        }
+
+        return $js;
     }
 }
diff --git a/src/Record/RepresentedCountry.php b/src/Record/RepresentedCountry.php
@@ -32,7 +32,9 @@ public function __construct(array $record, array $locales = ['en'])
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();
-        $js['type'] = $this->type;
+        if ($this->type !== null) {
+            $js['type'] = $this->type;
+        }
 
         return $js;
     }

diff --git a/src/Record/Subdivision.php b/src/Record/Subdivision.php
@@ -45,7 +45,9 @@ public function __construct(array $record, array $locales = ['en'])
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();
-        $js['iso_code'] = $this->isoCode;
+        if ($this->isoCode !== null) {
+            $js['iso_code'] = $this->isoCode;
+        }
 
         return $js;
     }