Merge pull request #3 from Vectorial1024/olc_contains

Add alternative way of calling contains()

Author: Vectorial1024

README.md

@@ -94,6 +94,7 @@ class OpenLocationCode implememts Stringable
     public function recover(float $referenceLatitude, float $referenceLongitude): self;
 
     public function contains(float $latitude, float $longitude): bool;
+    // note: if you need to call contains() many times on the same $this, consider decoding $this first, and then call contains() on the resulting CodeArea instance
 
     public static function isValidCode(string $code): bool;
     public function isValid(): bool;
@@ -121,6 +122,8 @@ class CodeArea
 
     public function getCenterLatitude(): float;
     public function getCenterLongitude(): float;
+
+    public function contains(float $latitude, float $longitude): float;
 }
 ```
 

src/CodeArea.php

@@ -38,4 +38,19 @@ public function getCenterLongitude(): float
     {
         return ($this->eastLongitude + $this->westLongitude) / 2;
     }
+
+    /**
+     * Returns whether the bounding box specified by the code area (from a decoded Open Location Code) contains the provided point.
+     * 
+     * @param float $latitude The provided latitude in degrees.
+     * @param float $longitude The provided longitude in degrees.
+     * @return bool True if the coordinates are contained by the code area.
+     */
+    public function contains(float $latitude, float $longitude): bool
+    {
+        return $this->southLatitude <= $latitude
+            && $latitude < $this->northLatitude
+            && $this->westLongitude <= $longitude
+            && $longitude < $this->eastLongitude;
+    }
 }

src/OpenLocationCode.php

@@ -349,17 +349,16 @@ public function recover(float $referenceLatitude, float $referenceLongitude): se
     /**
      * Returns whether the bounding box specified by the Open Location Code contains the provided point.
      * 
+     * @see CodeArea::contains() for the underlying implementation.
+     * 
      * @param float $latitude The provided latitude in degrees.
      * @param float $longitude The provided longitude in degrees.
-     * @return bool True if tge coordinates are contained by the code.
+     * @return bool True if the coordinates are contained by the code.
      */
     public function contains(float $latitude, float $longitude): bool
     {
         $codeArea = $this->decode();
-        return $codeArea->southLatitude <= $latitude
-            && $latitude < $codeArea->northLatitude
-            && $codeArea->westLongitude <= $longitude
-            && $longitude < $codeArea->eastLongitude;
+        return $codeArea->contains($latitude, $longitude);
     }
 
     // ---