add array types

Author: pfilsx

README.md

@@ -8,25 +8,27 @@ PostgreSQL Doctrine
 Description
 ------------
 
-Provides extended Doctrine DBAL and Doctrine migration classes to allow you to use PostgreSQL 
-specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html) or JSON(B) with Doctrine.
+Provides extended Doctrine and Doctrine migrations PostgreSQL support with 
+specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html), arrays and aggregate and JSON(B) functions.
 
 Features
 --------
-* PostgreSQL enums support in DBAL and migrations
+* PostgreSQL enums support in DBAL, ORM and migrations
 * PHP8 enum support
 * Fix creating [default schema in down migrations for pgsql](https://github.com/doctrine/dbal/issues/1110)
 * [JSON(B) functions](https://www.postgresql.org/docs/current/functions-json.html) (in progress)
 * JSON(B) types based on object models (in progress, requires symfony/serializer)
 * [Trait](src/ORM/Trait/ExistsMethodRepositoryTrait.php) for easy use of [SELECT EXISTS(...)](https://www.postgresql.org/docs/current/functions-subquery.html#FUNCTIONS-SUBQUERY-EXISTS) in your entity repositories
+* Aggregate functions with filter condition support
+* Array types
 
 Requirement
 -----------
 * PHP ^8.1
 * doctrine/dbal ^3.5.1
 * doctrine/migrations ^3.5.2
 * symfony/serializer >=5.4.* (optional for json models)
-* symfony/property-info >=5.4.* (optional)
+* symfony/property-info >=5.4.* (optional for json models)
 
 Installation
 ------------
@@ -46,14 +48,16 @@ for instructions on how to override the default doctrine classes in your project
 Required steps:
 1. Register [PostgreSQLDriverMiddleware.php](src/DBAL/Middleware/PostgreSQLDriverMiddleware.php) as driver middleware
 2. Register [OrmSchemaProvider.php](src/Migrations/Provider/OrmSchemaProvider.php) as Doctrine\Migrations\Provider\SchemaProvider in Doctrine\Migrations\DependencyFactory
+3. Register types and functions on your needs
 
 For Symfony integration see [PostgreSQLDoctrineBundle](https://github.com/pfilsx/PostgreSQLDoctrineBundle)
 
 Documentation
 -------------
 
-* [ENUMS](docs/ENUMS.md)
-* [Functions](docs/FUNCTIONS-AND-OPERATORS.md)
+* [Enums](docs/Enums.md)
+* [Functions](docs/Functions-and-Operators.md)
+* [Types](docs/Types.md)
 
 License
 -------

docs/ENUMS.md docs/Enums.mddocs/ENUMS.md renamed to docs/Enums.md

@@ -0,0 +1,10 @@
+Available types
+===============
+
+| PostgreSQL type | Register as                                     | Implementation                                                                          |
+|---|-------------------------------------------------|-----------------------------------------------------------------------------------------|
+| _bool | bool[]                                          | [Pfilsx\PostgreSQLDoctrine\DBAL\Type\BooleanArray](../src/DBAL/Type/BooleanArray.php)   |
+| _int2 | smallint[]                                      | [Pfilsx\PostgreSQLDoctrine\DBAL\Type\SmallIntArray](../src/DBAL/Type/SmallIntArray.php) | 
+| _int4 | integer[]                                       | [Pfilsx\PostgreSQLDoctrine\DBAL\Type\IntegerArray](../src/DBAL/Type/IntegerArray.php)   | 
+| _int8 | bigint[]                                        | [Pfilsx\PostgreSQLDoctrine\DBAL\Type\BigIntArray](../src/DBAL/Type/BigIntArray.php)     | 
+| _text | text[]                                          | [Pfilsx\PostgreSQLDoctrine\DBAL\Type\TextArray](../src/DBAL/Type/TextArray.php)         |

docs/FUNCTIONS-AND-OPERATORS.md docs/Functions-and-Operators.mddocs/FUNCTIONS-AND-OPERATORS.md renamed to docs/Functions-and-Operators.md

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\ConversionException;
+use Doctrine\DBAL\Types\Type;
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+use Pfilsx\PostgreSQLDoctrine\Tools\ArrayTypeTool;
+
+abstract class AbstractArrayType extends Type
+{
+    /**
+     * @param array<string, mixed> $column
+     * @param AbstractPlatform     $platform
+     *
+     * @throws \Doctrine\DBAL\Exception
+     *
+     * @return string
+     */
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
+    {
+        return $platform->getDoctrineTypeMapping($this->getName());
+    }
+
+    public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!\is_array($value)) {
+            throw new ConversionException(\sprintf('Invalid value type. Expected "array", "%s" provided.', \get_debug_type($value)));
+        }
+
+        return ArrayTypeTool::convertPHPArrayToDatabaseArrayString($value, static::getArrayType());
+    }
+
+    /**
+     * @param mixed            $value
+     * @param AbstractPlatform $platform
+     *
+     * @throws ConversionException
+     *
+     * @return null|bool[]|int[]|string[]
+     */
+    public function convertToPHPValue(mixed $value, AbstractPlatform $platform): ?array
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (!\is_string($value)) {
+            throw new ConversionException(\sprintf('Invalid database value type. Expected "string", "%s" provided.', \get_debug_type($value)));
+        }
+
+        return ArrayTypeTool::convertDatabaseArrayStringToPHPArray($value, static::getArrayType());
+    }
+
+    abstract protected static function getArrayType(): ArrayTypeEnum;
+}

docs/Types.md

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+
+/**
+ * Implementation of PostgreSql BIGINT[] data type.
+ *
+ * @see https://www.postgresql.org/docs/current/arrays.html
+ */
+class BigIntArray extends AbstractArrayType
+{
+    protected static function getArrayType(): ArrayTypeEnum
+    {
+        return ArrayTypeEnum::BigIntArray;
+    }
+
+    public function getName(): string
+    {
+        return 'bigint[]';
+    }
+}

src/DBAL/Type/AbstractArrayType.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+
+/**
+ * Implementation of PostgreSql BOOL[] data type.
+ *
+ * @see https://www.postgresql.org/docs/current/arrays.html
+ */
+class BooleanArray extends AbstractArrayType
+{
+    protected static function getArrayType(): ArrayTypeEnum
+    {
+        return ArrayTypeEnum::BooleanArray;
+    }
+
+    public function getName(): string
+    {
+        return 'bool[]';
+    }
+}

src/DBAL/Type/BigIntArray.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+
+/**
+ * Implementation of PostgreSql INTEGER[] data type.
+ *
+ * @see https://www.postgresql.org/docs/current/arrays.html
+ */
+class IntegerArray extends AbstractArrayType
+{
+    protected static function getArrayType(): ArrayTypeEnum
+    {
+        return ArrayTypeEnum::IntArray;
+    }
+
+    public function getName(): string
+    {
+        return 'integer[]';
+    }
+}

src/DBAL/Type/BooleanArray.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+
+/**
+ * Implementation of PostgreSql SMALLINT[] data type.
+ *
+ * @see https://www.postgresql.org/docs/current/arrays.html
+ */
+class SmallIntArray extends AbstractArrayType
+{
+    protected static function getArrayType(): ArrayTypeEnum
+    {
+        return ArrayTypeEnum::SmallIntArray;
+    }
+
+    public function getName(): string
+    {
+        return 'smallint[]';
+    }
+}

src/DBAL/Type/IntegerArray.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Type;
+
+use Pfilsx\PostgreSQLDoctrine\Enum\ArrayTypeEnum;
+
+/**
+ * Implementation of PostgreSql TEXT[] data type.
+ *
+ * @see https://www.postgresql.org/docs/current/arrays.html
+ */
+class TextArray extends AbstractArrayType
+{
+    protected static function getArrayType(): ArrayTypeEnum
+    {
+        return ArrayTypeEnum::TextArray;
+    }
+
+    public function getName(): string
+    {
+        return 'text[]';
+    }
+}