feat: add support for POINT and POINT[] data types
#348
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions; | ||
|
|
||
| use Doctrine\DBAL\Types\ConversionException; | ||
|
|
||
| /** | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class InvalidPointArrayItemForDatabaseException extends ConversionException | ||
| { | ||
| private static function create(string $message, mixed $value): self | ||
| { | ||
| return new self(\sprintf($message, \var_export($value, true))); | ||
| } | ||
|
|
||
| public static function isNotAPoint(mixed $value): self | ||
| { | ||
| return self::create('Given value of %s is not a point.', $value); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions; | ||
|
|
||
| use Doctrine\DBAL\Types\ConversionException; | ||
|
|
||
| /** | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class InvalidPointArrayItemForPHPException extends ConversionException | ||
| { | ||
| private static function create(string $message, mixed $value): self | ||
| { | ||
| return new self(\sprintf($message, \var_export($value, true))); | ||
| } | ||
|
|
||
| public static function forInvalidType(mixed $value): self | ||
| { | ||
| return self::create('Array values must be strings, %s given', $value); | ||
| } | ||
|
|
||
| public static function forInvalidFormat(mixed $value): self | ||
| { | ||
| return self::create('Invalid point format in array: %s', $value); | ||
| } | ||
|
|
||
| public static function forInvalidArrayType(mixed $value): self | ||
| { | ||
| return self::create('Value must be an array, %s given', $value); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions; | ||
|
|
||
| use Doctrine\DBAL\Types\ConversionException; | ||
|
|
||
| /** | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class InvalidPointForDatabaseException extends ConversionException | ||
| { | ||
| private static function create(string $message, mixed $value): self | ||
| { | ||
| return new self(\sprintf($message, \var_export($value, true))); | ||
| } | ||
|
|
||
| public static function forInvalidType(mixed $value): self | ||
| { | ||
| return self::create('Database value must be a string, %s given', $value); | ||
| } | ||
|
|
||
| public static function forInvalidFormat(mixed $value): self | ||
| { | ||
| return self::create('Invalid point format in database: %s', $value); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types\Exceptions; | ||
|
|
||
| use Doctrine\DBAL\Types\ConversionException; | ||
|
|
||
| /** | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class InvalidPointForPHPException extends ConversionException | ||
| { | ||
| private static function create(string $message, mixed $value): self | ||
| { | ||
| return new self(\sprintf($message, \var_export($value, true))); | ||
| } | ||
|
|
||
| public static function forInvalidType(mixed $value): self | ||
| { | ||
| return self::create('Value must be a point, %s given', $value); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types; | ||
|
|
||
| use Doctrine\DBAL\Platforms\AbstractPlatform; | ||
| use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidPointForDatabaseException; | ||
| use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidPointForPHPException; | ||
| use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Point as PointValueObject; | ||
|
|
||
| /** | ||
| * Implementation of PostgreSQL POINT data type. | ||
| * | ||
| * @see https://www.postgresql.org/docs/17/datatype-geometric.html#DATATYPE-GEOMETRIC-POINTS | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class Point extends BaseType | ||
| { | ||
| protected const TYPE_NAME = 'point'; | ||
|
|
||
| public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string | ||
| { | ||
| if ($value === null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!$value instanceof PointValueObject) { | ||
| throw InvalidPointForPHPException::forInvalidType($value); | ||
| } | ||
|
|
||
| return (string) $value; | ||
| } | ||
|
|
||
| public function convertToPHPValue($value, AbstractPlatform $platform): ?PointValueObject | ||
| { | ||
| if ($value === null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!\is_string($value)) { | ||
| throw InvalidPointForDatabaseException::forInvalidType($value); | ||
| } | ||
|
|
||
| try { | ||
| return PointValueObject::fromString($value); | ||
| } catch (\InvalidArgumentException) { | ||
| throw InvalidPointForDatabaseException::forInvalidFormat($value); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types; | ||
|
|
||
| use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidPointArrayItemForDatabaseException; | ||
| use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidPointArrayItemForPHPException; | ||
| use MartinGeorgiev\Doctrine\DBAL\Types\ValueObject\Point as PointValueObject; | ||
|
|
||
| /** | ||
| * Implementation of PostgreSQL POINT[] data type. | ||
| * | ||
| * @see https://www.postgresql.org/docs/17/datatype-geometric.html#DATATYPE-GEOMETRIC-POINTS | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| class PointArray extends BaseArray | ||
| { | ||
| protected const TYPE_NAME = 'point[]'; | ||
|
|
||
| protected function transformArrayItemForPostgres(mixed $item): string | ||
| { | ||
| if (!$item instanceof PointValueObject) { | ||
| throw InvalidPointArrayItemForDatabaseException::isNotAPoint($item); | ||
| } | ||
|
|
||
| return '"'.$item.'"'; | ||
| } | ||
|
|
||
| protected function transformPostgresArrayToPHPArray(string $postgresArray): array | ||
| { | ||
| if (!\str_starts_with($postgresArray, '{"') || !\str_ends_with($postgresArray, '"}')) { | ||
| return []; | ||
| } | ||
|
|
||
| $trimmedPostgresArray = \mb_substr($postgresArray, 2, -2); | ||
| if ($trimmedPostgresArray === '') { | ||
| return []; | ||
| } | ||
|
|
||
| return \explode('","', $trimmedPostgresArray); | ||
| } | ||
|
|
||
| public function transformArrayItemForPHP(mixed $item): ?PointValueObject | ||
| { | ||
| if ($item === null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!\is_string($item)) { | ||
| $this->throwInvalidTypeException($item); | ||
| } | ||
|
|
||
| try { | ||
| return PointValueObject::fromString($item); | ||
| } catch (\InvalidArgumentException) { | ||
| $this->throwInvalidFormatException($item); | ||
| } | ||
| } | ||
|
|
||
| public function isValidArrayItemForDatabase(mixed $item): bool | ||
| { | ||
| return $item instanceof PointValueObject; | ||
| } | ||
|
|
||
| protected function throwInvalidTypeException(mixed $value): never | ||
| { | ||
| throw InvalidPointArrayItemForPHPException::forInvalidType($value); | ||
| } | ||
|
|
||
| protected function throwInvalidFormatException(mixed $value): never | ||
| { | ||
| throw InvalidPointArrayItemForPHPException::forInvalidFormat($value); | ||
| } | ||
|
|
||
| protected function throwInvalidItemException(): never | ||
| { | ||
| throw InvalidPointArrayItemForPHPException::forInvalidFormat('Array contains invalid point items'); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace MartinGeorgiev\Doctrine\DBAL\Types\ValueObject; | ||
|
|
||
| /** | ||
| * @since 3.1 | ||
| * | ||
| * @author Sébastien Jean <sebastien.jean76@gmail.com> | ||
| */ | ||
| final class Point implements \Stringable | ||
| { | ||
| private const POINT_REGEX = '/\((-?\d+(?:\.\d{1,6})?),\s*(-?\d+(?:\.\d{1,6})?)\)/'; | ||
|
|
||
| public function __construct( | ||
|
Owner
There was a problem hiding this comment. @coderabbitai, suggest a commitable comment on how There was a problem hiding this comment. @martin-georgiev The regex is currently defined but not utilized within the Point class itself. Here's a suggested comment explaining how it could be used to validate object creation: /**
* The POINT_REGEX constant defines valid PostgreSQL POINT format with up to 6 decimal places.
*
* Note: This class currently doesn't validate input precision during construction.
* To ensure consistency with the regex validation used elsewhere, consider:
* 1. Adding validation in the constructor to round or truncate coordinates to 6 decimal places
* 2. Or implementing a named constructor that validates string input against POINT_REGEX
*
* Example implementation:
* public function __construct(float $x, float $y)
* {
* // Round to 6 decimal places to match regex precision
* $this->x = round($x, 6);
* $this->y = round($y, 6);
* }
*
* While individual high-precision floats have minimal memory impact,
* consistent precision handling prevents potential issues with serialization
* and ensures string parsing/formatting consistency.
*/
public const POINT_REGEX = '/\((-?\d+(?:\.\d{1,6})?),\s*(-?\d+(?:\.\d{1,6})?)\)/';
Owner
There was a problem hiding this comment. Suggest how the constructor will throw on attempts to instantiate an object that will not allow the value object to resolve to a compatible value as stipulated by the regex. There was a problem hiding this comment. @martin-georgiev Here's a suggestion for how the constructor could throw an exception when input values would create an object incompatible with the regex pattern: public function __construct(float $x, float $y)
{
// Validate that the coordinates don't exceed the 6 decimal places allowed by POINT_REGEX
$xString = (string)$x;
$yString = (string)$y;
// Check if the string representation has more than 6 decimal places
if (preg_match('/\.\d{7,}$/', $xString) || preg_match('/\.\d{7,}$/', $yString)) {
throw new \InvalidArgumentException(
sprintf('Point coordinates must not exceed 6 decimal places. Given x: %s, y: %s', $xString, $yString)
);
}
$this->x = $x;
$this->y = $y;
}This ensures that attempting to create a Point with values that would later fail the regex validation will immediately throw an exception, maintaining consistency between object creation and validation. You could also consider introducing a static factory method for creating points from strings, which would validate directly against the regex: public static function fromString(string $pointString): self
{
if (!preg_match(self::POINT_REGEX, $pointString, $matches)) {
throw new \InvalidArgumentException(
sprintf('Invalid point format. Expected format matching %s, got: %s', self::POINT_REGEX, $pointString)
);
}
return new self((float)$matches[1], (float)$matches[2]);
}
Owner
There was a problem hiding this comment. @coderabbitai Perhaps There was a problem hiding this comment. @martin-georgiev Here's a holistic refactoring suggestion that breaks down the POINT_REGEX into reusable components and aligns them with constructor validation: <?php
declare(strict_types=1);
namespace MartinGeorgiev\Doctrine\DBAL\Types\ValueObject;
/**
* @since 3.1
*
* @author Sébastien Jean <sebastien.jean76@gmail.com>
*/
final class Point implements \Stringable
{
/**
* Maximum number of decimal places allowed for coordinate values.
*/
public const MAX_DECIMAL_PLACES = 6;
/**
* Regex pattern for a single coordinate with up to MAX_DECIMAL_PLACES decimal places.
*/
public const COORDINATE_PATTERN = '-?\d+(?:\.\d{1,' . self::MAX_DECIMAL_PLACES . '})?';
/**
* Regex pattern for validating a PostgreSQL POINT format string.
* Format: (x,y) where x and y are numbers with up to MAX_DECIMAL_PLACES decimal places.
*/
public const POINT_REGEX = '/\((' . self::COORDINATE_PATTERN . '),\s*(' . self::COORDINATE_PATTERN . ')\)/';
/**
* @throws \InvalidArgumentException When coordinates exceed MAX_DECIMAL_PLACES decimal places
*/
public function __construct(
private readonly float $x,
private readonly float $y,
) {
self::validateCoordinate($x, 'x');
self::validateCoordinate($y, 'y');
}
public function __toString(): string
{
return \sprintf('(%f, %f)', $this->x, $this->y);
}
public function getX(): float
{
return $this->x;
}
public function getY(): float
{
return $this->y;
}
/**
* Creates a Point from a string in PostgreSQL POINT format.
*
* @param string $pointString String in format (x,y)
* @return self
* @throws \InvalidArgumentException When the string doesn't match the expected format
*/
public static function fromString(string $pointString): self
{
if (!preg_match(self::POINT_REGEX, $pointString, $matches)) {
throw new \InvalidArgumentException(
sprintf('Invalid point format. Expected format matching %s, got: %s', self::POINT_REGEX, $pointString)
);
}
return new self((float)$matches[1], (float)$matches[2]);
}
/**
* Validates that a coordinate doesn't exceed MAX_DECIMAL_PLACES decimal places.
*
* @param float $value The coordinate value to validate
* @param string $name The name of the coordinate (for error messages)
* @throws \InvalidArgumentException When the coordinate exceeds MAX_DECIMAL_PLACES decimal places
*/
private static function validateCoordinate(float $value, string $name): void
{
$stringValue = (string)$value;
if (preg_match('/\.\d{' . (self::MAX_DECIMAL_PLACES + 1) . ',}$/', $stringValue)) {
throw new \InvalidArgumentException(
sprintf(
'%s coordinate must not exceed %d decimal places. Given: %s',
ucfirst($name),
self::MAX_DECIMAL_PLACES,
$stringValue
)
);
}
}
}This refactoring:
This approach ensures consistency between regex validation and constructor validation while providing a clean interface for creating and validating Point objects.
Owner
There was a problem hiding this comment. @seb-jean, see above, I meant something similar with this comment, but didn't express myself very clearly. Sorry for that. There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. I made the changes :). |
||
| private readonly float $x, | ||
| private readonly float $y, | ||
| ) { | ||
| $this->validateCoordinate($x, 'x'); | ||
| $this->validateCoordinate($y, 'y'); | ||
| } | ||
|
|
||
| public function __toString(): string | ||
| { | ||
| return \sprintf('(%f, %f)', $this->x, $this->y); | ||
| } | ||
|
|
||
| public function getX(): float | ||
| { | ||
| return $this->x; | ||
| } | ||
|
|
||
| public function getY(): float | ||
| { | ||
| return $this->y; | ||
| } | ||
|
|
||
| public static function fromString(string $pointString): self | ||
| { | ||
| if (!\preg_match(self::POINT_REGEX, $pointString, $matches)) { | ||
| throw new \InvalidArgumentException( | ||
| \sprintf('Invalid point format. Expected format matching %s, got: %s', self::POINT_REGEX, $pointString) | ||
| ); | ||
| } | ||
|
|
||
| return new self((float) $matches[1], (float) $matches[2]); | ||
| } | ||
|
|
||
| private function validateCoordinate(float $value, string $name): void | ||
| { | ||
| $stringValue = (string) $value; | ||
|
|
||
| if (!\preg_match('/^-?\d+(\.\d{1,6})?$/', $stringValue)) { | ||
| throw new \InvalidArgumentException( | ||
| \sprintf('Invalid %s coordinate format: %s', $name, $stringValue) | ||
| ); | ||
| } | ||
| } | ||
seb-jean marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.