initial commit. hope no bugs

Author: Gusarov

.gitignore

@@ -1,6 +1,6 @@
-composer.phar
+.idea/
+.vscode/
+/coverage/
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+.phpunit.result.cache
+composer.lock

README.md

@@ -1 +1,92 @@
-# php-enum-doctrine
+# Php Enum doctrine
+
+* Allows to add you custom php enums as doctrine type.
+* Supports generation of correct alter SQL when updating enum values.
+
+Extension for [php-enum](https://github.com/gusarov112/php-enum) (myclabs fork)
+
+## Installation
+
+Add github repository to composer.json
+```json
+{
+   "repositories": [
+        {
+            "type": "vcs",
+            "url": "[email protected]:gusarov112/php-enum-doctrine.git"
+        }
+    ]
+}
+```
+Than require package
+```bash
+composer require gusarov112/php-enum-doctrine
+```
+
+## Symfony configuration
+```
+  Gusarov112\PhpEnumDoctrine\EventListener\EnumUpdaterSubscriber:
+    tags:
+      - { name: doctrine.event_subscriber }
+```
+
+## Example
+
+### Create enum
+```php
+class PetEnum extends \Gusarov112\Enum\Enum
+{
+    const CAT = 'CAT';
+    const DOG = 'DOG';
+}
+```
+### Create corresponding enum type by extending abstract type
+```php
+class PetType extends \Gusarov112\PhpEnumDoctrine\DBAL\EnumType
+{
+    public function getEnumClassName(): string
+    {
+        return PetEnum::class;
+    }
+
+    public function getName()
+    {
+        return 'pet_type';
+    }
+}
+```
+### Use your column type in doctrine entity
+```php
+use Doctrine\ORM\Mapping as ORM;
+
+class PetEntity {
+    /**
+     * @var PetEnum
+     * @ORM\Column(type="pet_type")
+     */
+    private $type;
+
+    public function getType(): PetEnum
+    {
+        return $this->type;
+    }
+
+    public function setType(PetEnum $type): self
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+}
+```
+### Do not forger to register your type
+```php
+\Doctrine\DBAL\Types\Type::addType('pet_type', PetType::class);
+```
+### Add event subscriber if you have migrations bundle and want to autogenerate enum list alter SQL's
+```php
+$eventManager = new \Doctrine\Common\EventManager();
+$eventManager->addEventSubscriber(new \Gusarov112\PhpEnumDoctrine\EventListener\EnumUpdaterSubscriber());
+
+#!/bin/bash ./vendor/bin/doctrine migrations:diff
+```

composer.json

@@ -0,0 +1,34 @@
+{
+  "name": "gusarov112/php-enum-doctrine",
+  "description": "Allows to add you custom php enums as doctrine type",
+  "keywords": [
+    "generic",
+    "collection"
+  ],
+  "homepage": "http://github.com/gusarov112/php-enum-doctrine",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Anatolii Husarov",
+      "email": "[email protected]"
+    }
+  ],
+  "repositories":[
+    {
+      "type": "vcs",
+      "url": "[email protected]:gusarov112/php-enum.git"
+    }
+  ],
+  "require": {
+    "php": "^7.1",
+    "ext-json": "*",
+    "ext-pdo": "*",
+    "gusarov112/php-enum": "v1.0.0",
+    "doctrine/orm": "^2.7"
+  },
+  "autoload": {
+    "psr-4": {
+      "Gusarov112\\PhpEnumDoctrine\\": "src/"
+    }
+  }
+}

doc.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+class PetEnum extends \Gusarov112\Enum\Enum
+{
+    const CAT = 'CAT';
+    const DOG = 'DOG';
+}
+
+class PetType extends \Gusarov112\PhpEnumDoctrine\DBAL\EnumType
+{
+    public function getEnumClassName(): string
+    {
+        return PetEnum::class;
+    }
+
+    public function getName()
+    {
+        return 'pet_type';
+    }
+}
+
+use Doctrine\ORM\Mapping as ORM;
+
+class PetEntity {
+    /**
+     * @var PetEnum
+     * @ORM\Column(type="pet_type")
+     */
+    private $type;
+
+    public function getType(): PetEnum
+    {
+        return $this->type;
+    }
+
+    public function setType(PetEnum $type): self
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+}
+
+\Doctrine\DBAL\Types\Type::addType('pet_type', PetType::class);
+
+$eventManager = new \Doctrine\Common\EventManager();
+$eventManager->addEventSubscriber(new \Gusarov112\PhpEnumDoctrine\EventListener\EnumUpdaterSubscriber());
+#!/bin/bash ./vendor/bin/doctrine migrations:diff
+
+

src/DBAL/EnumType.php

@@ -0,0 +1,81 @@
+<?php
+declare(strict_types=1);
+
+namespace Gusarov112\PhpEnumDoctrine\DBAL;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\ConversionException;
+use Doctrine\DBAL\Types\Type;
+use Exception;
+use Gusarov112\Enum\Enum;
+
+/**
+ * @package WL\CommonBundle\DBAL\Type
+ */
+abstract class EnumType extends Type
+{
+    /**
+     * @return string Enum class name
+     */
+    abstract public function getEnumClassName(): string;
+
+    /**
+     * Gets the SQL declaration snippet for a field of this type.
+     *
+     * @param array $fieldDeclaration The field declaration.
+     * @param AbstractPlatform $platform The currently used database platform.
+     *
+     * @return string
+     */
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        /** @var Enum $enumClass */
+        $enumClass = $this->getEnumClassName();
+        $phpEnumValues = array_values($enumClass::toArray());
+        $currentDbEnumValues = $fieldDeclaration['currentDbEnumValues'] ?? [];
+        $resultEnumValues = array_merge($currentDbEnumValues, array_diff($phpEnumValues, $currentDbEnumValues));
+
+        return sprintf('ENUM(%s)', '"'.implode('","', $resultEnumValues).'"');
+    }
+
+    /**
+     * @param Enum $value
+     * @param AbstractPlatform $platform
+     * @return mixed
+     */
+    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    {
+        return is_null($value) ? null : $value->getValue();
+    }
+
+    /**
+     * @param mixed $value
+     * @param AbstractPlatform $platform
+     * @return Enum
+     * @throws ConversionException
+     */
+    public function convertToPHPValue($value, AbstractPlatform $platform)
+    {
+        $result = null;
+        if (!is_null($value)) {
+            $className = $this->getEnumClassName();
+            try {
+                $result = new $className($this->castEnumValue($value));
+            } catch (Exception $e) {
+                throw new ConversionException($e->getMessage(), $e->getCode(), $e);
+            }
+        }
+
+        return $result;
+    }
+
+    public function requiresSQLCommentHint(AbstractPlatform $platform)
+    {
+        return true;
+    }
+
+    protected function castEnumValue($value)
+    {
+        return (string)$value;
+    }
+}

src/DBAL/Schema/MysqlEnumUpdater.php

@@ -0,0 +1,74 @@
+<?php
+declare(strict_types=1);
+
+namespace Gusarov112\PhpEnumDoctrine\DBAL\Schema;
+
+use Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs;
+use Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs;
+use Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs;
+use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Gusarov112\Enum\Enum;
+use Gusarov112\PhpEnumDoctrine\DBAL\EnumType;
+use PDO;
+
+class MysqlEnumUpdater implements PlatformEventEnumValueUpdaterInterface
+{
+    public function getPlatformName(): string
+    {
+        return 'mysql';
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs, Table $table, Column $column)
+    {
+        /** @var EnumType $type */
+        $type = $column->getType();
+        /** @var Enum $enumClassName */
+        $enumClassName = $type->getEnumClassName();
+
+        $query = $eventArgs->getEntityManager()
+            ->getConnection()
+            ->createQueryBuilder()
+            ->select('column_type')
+            ->from('information_schema.COLUMNS')
+            ->where('TABLE_NAME = :table AND COLUMN_NAME = :column')
+            ->setParameters(
+                [
+                    'table' => $table->getName(),
+                    'column' => $column->getName(),
+                ]
+            )
+        ;
+        $statement = $query->execute();
+        $result = $statement->fetch(PDO::FETCH_NUM);
+        if (false !== $result) {
+            $columnType = $result[0];
+            $dbEnum = preg_replace('/^enum\(|\)$/i', '', $columnType);
+            $currentDbEnumValues = array_map(
+                function ($value) {
+                    return trim($value, '\'"');
+                },
+                explode(',', $dbEnum)
+            );
+            $phpEnumValues = array_values($enumClassName::toArray());
+            if (!empty(array_diff($phpEnumValues, $currentDbEnumValues))) {
+                $resultEnumValues = array_merge($currentDbEnumValues, array_diff($phpEnumValues, $currentDbEnumValues));
+                $enumTypeDeclaration = sprintf('ENUM(%s)', '"'.implode('","', $resultEnumValues).'"');
+                $column->setCustomSchemaOption('enumTypeDeclaration', $enumTypeDeclaration);
+            }
+        }
+    }
+
+    public function onSchemaCreateTableColumn(SchemaCreateTableColumnEventArgs $eventArgs)
+    {
+    }
+
+    public function onSchemaAlterTableChangeColumn(SchemaAlterTableChangeColumnEventArgs $eventArgs)
+    {
+    }
+
+    public function onSchemaAlterTableAddColumn(SchemaAlterTableAddColumnEventArgs $eventArgs)
+    {
+    }
+}

src/DBAL/Schema/PlatformEventEnumValueUpdaterInterface.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+namespace Gusarov112\PhpEnumDoctrine\DBAL\Schema;
+
+use Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs;
+use Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs;
+use Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs;
+use Doctrine\DBAL\Schema\Column;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+
+interface PlatformEventEnumValueUpdaterInterface
+{
+    public function getPlatformName(): string;
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs, Table $table, Column $column);
+
+    public function onSchemaCreateTableColumn(SchemaCreateTableColumnEventArgs $eventArgs);
+
+    public function onSchemaAlterTableChangeColumn(SchemaAlterTableChangeColumnEventArgs $eventArgs);
+
+    public function onSchemaAlterTableAddColumn(SchemaAlterTableAddColumnEventArgs $eventArgs);
+}