210 lines
3.7 KiB
PHP
210 lines
3.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the Geocoder package.
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @license MIT License
|
|
*/
|
|
|
|
namespace Geocoder\Query;
|
|
|
|
use Geocoder\Exception\InvalidArgument;
|
|
use Geocoder\Geocoder;
|
|
use Geocoder\Model\Bounds;
|
|
|
|
/**
|
|
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
|
|
*/
|
|
final class GeocodeQuery implements Query
|
|
{
|
|
/**
|
|
* The address or text that should be geocoded.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $text;
|
|
|
|
/**
|
|
* @var Bounds|null
|
|
*/
|
|
private $bounds;
|
|
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
private $locale;
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
private $limit = Geocoder::DEFAULT_RESULT_LIMIT;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $data = [];
|
|
|
|
/**
|
|
* @param string $text
|
|
*/
|
|
private function __construct(string $text)
|
|
{
|
|
if ('' === $text) {
|
|
throw new InvalidArgument('Geocode query cannot be empty');
|
|
}
|
|
|
|
$this->text = $text;
|
|
}
|
|
|
|
/**
|
|
* @param string $text
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public static function create(string $text): self
|
|
{
|
|
return new self($text);
|
|
}
|
|
|
|
/**
|
|
* @param string $text
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public function withText(string $text): self
|
|
{
|
|
$new = clone $this;
|
|
$new->text = $text;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* @param Bounds $bounds
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public function withBounds(Bounds $bounds): self
|
|
{
|
|
$new = clone $this;
|
|
$new->bounds = $bounds;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* @param string $locale
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public function withLocale(string $locale): self
|
|
{
|
|
$new = clone $this;
|
|
$new->locale = $locale;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* @param int $limit
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public function withLimit(int $limit): self
|
|
{
|
|
$new = clone $this;
|
|
$new->limit = $limit;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*
|
|
* @return GeocodeQuery
|
|
*/
|
|
public function withData(string $name, $value): self
|
|
{
|
|
$new = clone $this;
|
|
$new->data[$name] = $value;
|
|
|
|
return $new;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getText(): string
|
|
{
|
|
return $this->text;
|
|
}
|
|
|
|
/**
|
|
* @return Bounds|null
|
|
*/
|
|
public function getBounds()
|
|
{
|
|
return $this->bounds;
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
public function getLocale()
|
|
{
|
|
return $this->locale;
|
|
}
|
|
|
|
/**
|
|
* @return int
|
|
*/
|
|
public function getLimit(): int
|
|
{
|
|
return $this->limit;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed|null $default
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getData(string $name, $default = null)
|
|
{
|
|
if (!array_key_exists($name, $this->data)) {
|
|
return $default;
|
|
}
|
|
|
|
return $this->data[$name];
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function getAllData(): array
|
|
{
|
|
return $this->data;
|
|
}
|
|
|
|
/**
|
|
* String for logging. This is also a unique key for the query.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return sprintf('GeocodeQuery: %s', json_encode([
|
|
'text' => $this->getText(),
|
|
'bounds' => $this->getBounds() ? $this->getBounds()->toArray() : 'null',
|
|
'locale' => $this->getLocale(),
|
|
'limit' => $this->getLimit(),
|
|
'data' => $this->getAllData(),
|
|
]));
|
|
}
|
|
}
|