Add GeolocatorInterface so new geolocation implementations know what …

…to do
ibericode · Sep 6, 2023 · 133b166 · 133b166
1 parent a476f32
commit 133b166
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/src/Geolocation/GeolocatorInterface.php b/src/Geolocation/GeolocatorInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Ibericode\Vat\Geolocation;
+
+interface GeolocatorInterface {
+
+    /**
+     * @param string $ipAddress The IP address to geolocate
+     * @return string A ISO-3166-1-alpha2 country code or an empty string on failure
+     */
+    public function locateIpAddress(string $ipAddress) : string;
+
+}
diff --git a/src/Geolocation/IP2C.php b/src/Geolocation/IP2C.php
@@ -9,7 +9,7 @@
  *
  * @package Ibericode\Vat\Geolocation
  */
-class IP2C
+class IP2C implements GeolocatorInterface
 {
 
     /**

diff --git a/src/Geolocation/IP2Country.php b/src/Geolocation/IP2Country.php
@@ -9,7 +9,7 @@
  *
  * @package Ibericode\Vat\Geolocation
  */
-class IP2Country
+class IP2Country implements GeolocatorInterface
 {
     /**
      * @param string $ipAddress