From 7719e14d8082a8a86f563866f4e25797dd515069 Mon Sep 17 00:00:00 2001
From: Michael Moravec <mail@majkl578.cz>
Date: Tue, 3 Oct 2017 19:25:56 +0200
Subject: [PATCH] BooleanEnum

---
 readme.md                                   |  4 ++-
 src/Enum/Type/BooleanEnumType.php           | 34 +++++++++++++++++++++
 tests/Enum/Type/EnumTypeIntegrationTest.php |  4 +++
 tests/Enum/Type/data/FooBooleanEnum.php     | 13 ++++++++
 tests/bootstrap.php                         |  2 ++
 5 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 src/Enum/Type/BooleanEnumType.php
 create mode 100644 tests/Enum/Type/data/FooBooleanEnum.php

diff --git a/readme.md b/readme.md
index 23c760d..d784f2a 100644
--- a/readme.md
+++ b/readme.md
@@ -32,7 +32,7 @@ Now you can use the `Sex` enum in your `User` entity. There are two important th
 
 You can specify any other parameters for `ORM\Column` as you would usually (nullability, length...).
 
-There is also `integer_enum` and `float_enum` which can be used respectively for their types.
+There is also `integer_enum`, `float_enum` and `boolean_enum` which can be used respectively for their types.
 
 2) `@Enum(class=Sex::class)` - this will be used for reconstructing the `Sex`
  enum object when loading the value back from database
@@ -139,6 +139,7 @@ composer require consistence/consistence-doctrine
 ```php
 <?php
 
+use Consistence\Doctrine\Enum\Type\BooleanEnumType;
 use Consistence\Doctrine\Enum\Type\FloatEnumType;
 use Consistence\Doctrine\Enum\Type\IntegerEnumType;
 use Consistence\Doctrine\Enum\Type\StringEnumType;
@@ -154,6 +155,7 @@ $loader = require __DIR__ . '/../vendor/autoload.php';
 AnnotationRegistry::registerLoader([$loader, 'loadClass']);
 
 // register Doctrine DBAL types
+DoctrineType::addType(BooleanEnumType::NAME, BooleanEnumType::class); // boolean_enum
 DoctrineType::addType(FloatEnumType::NAME, FloatEnumType::class); // float_enum
 DoctrineType::addType(IntegerEnumType::NAME, IntegerEnumType::class); // integer_enum
 DoctrineType::addType(StringEnumType::NAME, StringEnumType::class); // string_enum
diff --git a/src/Enum/Type/BooleanEnumType.php b/src/Enum/Type/BooleanEnumType.php
new file mode 100644
index 0000000..542af16
--- /dev/null
+++ b/src/Enum/Type/BooleanEnumType.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Consistence\Doctrine\Enum\Type;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+
+class BooleanEnumType extends \Doctrine\DBAL\Types\BooleanType
+{
+
+	const NAME = 'boolean_enum';
+
+	public function getName(): string
+	{
+		return self::NAME;
+	}
+
+	/**
+	 * @param \Consistence\Enum\Enum|bool|null $value
+	 * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
+	 * @return bool|null
+	 */
+	public function convertToDatabaseValue($value, AbstractPlatform $platform)
+	{
+		return EnumType::convertToDatabaseValue($value);
+	}
+
+	public function requiresSQLCommentHint(AbstractPlatform $platform): bool
+	{
+		return true;
+	}
+
+}
diff --git a/tests/Enum/Type/EnumTypeIntegrationTest.php b/tests/Enum/Type/EnumTypeIntegrationTest.php
index 4a19bc4..679315e 100644
--- a/tests/Enum/Type/EnumTypeIntegrationTest.php
+++ b/tests/Enum/Type/EnumTypeIntegrationTest.php
@@ -20,6 +20,7 @@ public function convertEnumToDatabaseProvider(): array
 			[DoctrineType::getType(IntegerEnumType::NAME), FooFloatEnum::get(FooFloatEnum::ONE), FooFloatEnum::ONE],
 			[DoctrineType::getType(IntegerEnumType::NAME), FooIntegerEnum::get(FooIntegerEnum::ONE), FooIntegerEnum::ONE],
 			[DoctrineType::getType(StringEnumType::NAME), FooStringEnum::get(FooStringEnum::ONE), FooStringEnum::ONE],
+			[DoctrineType::getType(BooleanEnumType::NAME), FooBooleanEnum::get(FooBooleanEnum::ENABLED), FooBooleanEnum::ENABLED],
 		];
 	}
 
@@ -45,6 +46,7 @@ public function enumTypesProvider(): array
 			[DoctrineType::getType(FloatEnumType::NAME)],
 			[DoctrineType::getType(IntegerEnumType::NAME)],
 			[DoctrineType::getType(StringEnumType::NAME)],
+			[DoctrineType::getType(BooleanEnumType::NAME)],
 		];
 	}
 
@@ -68,6 +70,7 @@ public function convertScalarValueToDatabaseProvider(): array
 			[DoctrineType::getType(FloatEnumType::NAME), FooFloatEnum::ONE],
 			[DoctrineType::getType(IntegerEnumType::NAME), FooIntegerEnum::ONE],
 			[DoctrineType::getType(StringEnumType::NAME), FooStringEnum::ONE],
+			[DoctrineType::getType(BooleanEnumType::NAME), FooBooleanEnum::ENABLED],
 		];
 	}
 
@@ -92,6 +95,7 @@ public function enumTypeClassesProvider(): array
 			[FloatEnumType::class],
 			[IntegerEnumType::class],
 			[StringEnumType::class],
+			[BooleanEnumType::class],
 		];
 	}
 
diff --git a/tests/Enum/Type/data/FooBooleanEnum.php b/tests/Enum/Type/data/FooBooleanEnum.php
new file mode 100644
index 0000000..4b0705d
--- /dev/null
+++ b/tests/Enum/Type/data/FooBooleanEnum.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Consistence\Doctrine\Enum\Type;
+
+class FooBooleanEnum extends \Consistence\Enum\Enum
+{
+
+	const ENABLED = true;
+	const DISABLED = false;
+
+}
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
index 7436e45..93eb59f 100644
--- a/tests/bootstrap.php
+++ b/tests/bootstrap.php
@@ -2,6 +2,7 @@
 
 declare(strict_types = 1);
 
+use Consistence\Doctrine\Enum\Type\BooleanEnumType;
 use Consistence\Doctrine\Enum\Type\FloatEnumType;
 use Consistence\Doctrine\Enum\Type\IntegerEnumType;
 use Consistence\Doctrine\Enum\Type\StringEnumType;
@@ -17,3 +18,4 @@
 DoctrineType::addType(FloatEnumType::NAME, FloatEnumType::class);
 DoctrineType::addType(IntegerEnumType::NAME, IntegerEnumType::class);
 DoctrineType::addType(StringEnumType::NAME, StringEnumType::class);
+DoctrineType::addType(BooleanEnumType::NAME, BooleanEnumType::class);