pcm-libraries/pcm-geocode-bundle
2
0
Fork 0
Code Issues 2 Releases Activity

Update docblocks

Browse Source
This commit is contained in:
brabli
2024-08-05 14:50:26 +01:00
parent 8b662ebfa3
commit 10d1d3c318
3 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Interface/Entity/GeocodeInterface.php
View File

@@ -4,6 +4,9 @@ declare(strict_types=1);
namespace Pcm\GeocodeBundle\Interface\Entity; namespace Pcm\GeocodeBundle\Interface\Entity;
/**
* Defines latitude and longitude getters and setters
*/
interface GeocodeInterface interface GeocodeInterface
{ {
public function getLatitude(): ?float; public function getLatitude(): ?float;
@@ -14,5 +17,9 @@ interface GeocodeInterface
public function setLongitude(float $lon): self; public function setLongitude(float $lon): self;
/**
* @return bool True if both latitude and longitude is set
*/
public function isGeocoded(): bool; public function isGeocoded(): bool;
} }

13
src/Service/Geocoder.php
View File

@@ -10,6 +10,9 @@ use Pcm\GeocodeBundle\Model\GeoCoordinates;
use Symfony\Contracts\HttpClient\HttpClientInterface; use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface; use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* Find the geo-coordinates of a postcode
*/
final class Geocoder final class Geocoder
{ {
private const string API_URL = "https://nominatim.openstreetmap.org/search"; private const string API_URL = "https://nominatim.openstreetmap.org/search";
@@ -17,12 +20,16 @@ final class Geocoder
public function __construct(private HttpClientInterface $client) {} public function __construct(private HttpClientInterface $client) {}
/** /**
* Convert a postcode into latitude and longitude. Returns null if conversion failed. * Find and return the geo-coordinates of a postcode
* *
* @param string $postcode * @param string $postcode
* @return null|GeoCoordinates *
* @return GeoCoordinates
*
* @throws NoResultsFoundException when no results were found for the provided postcode
* @throws ApiErrorException when the API response contains an error
*/ */
public function geocodePostcode(string $postcode): ?GeoCoordinates public function geocodePostcode(string $postcode): GeoCoordinates
{ {
$client = $this->createClient(); $client = $this->createClient();
$response = $this->makeApiRequest($client, $postcode); $response = $this->makeApiRequest($client, $postcode);

5
src/Trait/Entity/GeocodeTrait.php
View File

@@ -43,11 +43,6 @@ trait GeocodeTrait
return $this; return $this;
} }
/**
* Returns true if both latitude and longitude have been set
*
* @return bool
*/
public function isGeocoded(): bool public function isGeocoded(): bool
{ {
return null !== $this->getLatitude() && null !== $this->getLongitude(); return null !== $this->getLatitude() && null !== $this->getLongitude();