Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/UPGRADE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Upgrade Instructions

## How to Upgrade to Version 3.0.0
## How to Upgrade to Version 3.0

### 1. Review type handling in your code
If your application relies on automatic type conversion between PostgreSQL and PHP (e.g., expecting string numbers to be converted to actual numbers or vice versa), you'll need to update your code to explicitly handle type conversion where needed.
Expand All @@ -16,7 +16,7 @@ $numericValue = (float)$tags[0] + 2; // Explicit conversion needed
```

### 2. Update your code to handle exceptions
If you're catching specific exception types when working with `JsonbArray`, update your exception handling to catch the new `InvalidJsonbArrayItemForPHPException`.
If you're catching specific exception types when working with `JsonbArray`, update your exception handling to catch the new `InvalidJsonItemForPHPException` and `InvalidJsonArrayItemForPHPException`.

```php
// Before
Expand All @@ -29,7 +29,7 @@ try {
// After
try {
$jsonArray = $jsonbArrayType->convertToPHPValue($postgresValue, $platform);
} catch (\MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidJsonbArrayItemForPHPException $e) {
} catch (\MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidJsonArrayItemForPHPException $e) {
// Handle exception
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

use Doctrine\DBAL\Types\ConversionException;

class InvalidJsonbArrayItemForPHPException extends ConversionException
class InvalidJsonArrayItemForPHPException extends ConversionException
{
private static function create(string $message, mixed $value): self
{
Expand All @@ -20,6 +20,6 @@ public static function forInvalidType(mixed $value): self

public static function forInvalidFormat(mixed $value): self
{
return self::create('Invalid JSONB format in array: %s', $value);
return self::create('Invalid JSON format in array: %s', $value);
}
}
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;

class InvalidJsonItemForPHPException 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('Postgres value must be single, valid JSON object, %s given', $value);
}

public static function forInvalidFormat(mixed $value): self
{
return self::create('Invalid JSON format: %s', $value);
}
}
4 changes: 2 additions & 2 deletions src/MartinGeorgiev/Doctrine/DBAL/Types/JsonTransformer.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace MartinGeorgiev\Doctrine\DBAL\Types;

use Doctrine\DBAL\Types\ConversionException;
use MartinGeorgiev\Utils\PostgresJsonToPHPArrayTransformer;

/**
* Helpers for converting PHP values into PostgreSQL JSON and vice versa.
Expand Down Expand Up @@ -33,7 +34,6 @@ protected function transformToPostgresJson(mixed $phpValue): string

protected function transformFromPostgresJson(string $postgresValue): null|array|bool|float|int|string
{
// @phpstan-ignore-next-line
return \json_decode($postgresValue, true, 512, JSON_THROW_ON_ERROR);
return PostgresJsonToPHPArrayTransformer::transformPostgresJsonEncodedValueToPHPValue($postgresValue);
}
}
25 changes: 3 additions & 22 deletions src/MartinGeorgiev/Doctrine/DBAL/Types/JsonbArray.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

namespace MartinGeorgiev\Doctrine\DBAL\Types;

use MartinGeorgiev\Doctrine\DBAL\Types\Exceptions\InvalidJsonbArrayItemForPHPException;
use MartinGeorgiev\Utils\PostgresJsonToPHPArrayTransformer;

/**
* Implementation of PostgreSQL JSONB[] data type.
Expand All @@ -27,33 +27,14 @@ protected function transformArrayItemForPostgres(mixed $item): string

protected function transformPostgresArrayToPHPArray(string $postgresArray): array
{
if ($postgresArray === '{}') {
return [];
}

$trimmedPostgresArray = \mb_substr($postgresArray, 2, -2);
$phpArray = \explode('},{', $trimmedPostgresArray);
foreach ($phpArray as &$item) {
$item = '{'.$item.'}';
}

return $phpArray;
return PostgresJsonToPHPArrayTransformer::transformPostgresArrayToPHPArray($postgresArray);
}

/**
* @param string $item
*/
public function transformArrayItemForPHP($item): array
{
try {
$transformedValue = $this->transformFromPostgresJson($item);
if (!\is_array($transformedValue)) {
throw InvalidJsonbArrayItemForPHPException::forInvalidType($item);
}

return $transformedValue;
} catch (\JsonException) {
throw InvalidJsonbArrayItemForPHPException::forInvalidFormat($item);
}
return PostgresJsonToPHPArrayTransformer::transformPostgresJsonEncodedValueToPHPArray($item);
}
}
7 changes: 4 additions & 3 deletions src/MartinGeorgiev/Doctrine/DBAL/Types/TextArray.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
namespace MartinGeorgiev\Doctrine\DBAL\Types;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use MartinGeorgiev\Utils\ArrayDataTransformer;
use MartinGeorgiev\Utils\PHPArrayToPostgresValueTransformer;
use MartinGeorgiev\Utils\PostgresArrayToPHPArrayTransformer;

/**
* Implementation of PostgreSQL TEXT[] data type.
Expand Down Expand Up @@ -42,7 +43,7 @@ protected function transformToPostgresTextArray(array $phpTextArray): string
return '{}';
}

return ArrayDataTransformer::transformPHPArrayToPostgresTextArray($phpTextArray);
return PHPArrayToPostgresValueTransformer::transformToPostgresTextArray($phpTextArray);
}

/**
Expand All @@ -65,6 +66,6 @@ protected function transformFromPostgresTextArray(string $postgresValue): array
return [];
}

return ArrayDataTransformer::transformPostgresTextArrayToPHPArray($postgresValue);
return PostgresArrayToPHPArrayTransformer::transformPostgresArrayToPHPArray($postgresValue);
}
}
170 changes: 0 additions & 170 deletions src/MartinGeorgiev/Utils/ArrayDataTransformer.php

This file was deleted.

Loading
Loading