Clever Geek Handbook

PHPの列挙

問題



ご存知のように、PHPには組み込みの列挙型はありません。また、複雑なサブジェクトエリアを持つプロジェクトでは、この事実により多くの問題が発生します。 次のSymfonyプロジェクトで転送が必要になったとき、独自の実装を作成することが決定されました。



列挙には、アプリケーションのさまざまなコンポーネントで使用できる柔軟性と機能が必要でした。 転送が解決するはずだったタスクは次のとおりです。





SplEnumを含む、時々 奇妙な myclabs / php-enumなど、列挙の実装がいくつかあります。 しかし、それらをアプリケーションの他の部分（doctrine、twig）と統合すると、特にDoctrineを使用する場合に問題が発生します。



Doctrineタイプシステムの特徴は、すべてのタイプがプライベート最終コンストラクターを持つTypeクラスから継承する必要があることです。 つまり それから継承してコンストラクタをオーバーロードして、列挙の値を取得することはできません。 それにもかかわらず、多少標準的ではない方法で、この問題は回避されました。



実装



Enum-列挙の基本クラス



Enum.php 
<?php namespace AppBundle\System\Component\Enum; use Doctrine\DBAL\Platforms\MySqlPlatform; use Doctrine\DBAL\Platforms\PostgreSqlPlatform; use Doctrine\DBAL\Platforms\SqlitePlatform; use Doctrine\DBAL\Types\Type; use Doctrine\DBAL\Platforms\AbstractPlatform; class Enum { private static $values = []; private static $valueMap = []; private $value; public function __construct($value) { $this->value = $value; } public function getValue() { return $this->value; } public function __toString() { return $this->value; } /** * @return Enum[] * @throws \Exception */ public static function getValues() { $className = get_called_class(); if (!array_key_exists($className, self::$values)) { throw new \Exception(sprintf("Enum is not initialized, enum=%s", $className)); } return self::$values[$className]; } public static function getEnumObject($value) { if (empty($value)) { return null; } $className = get_called_class(); return self::$valueMap[$className][$value]; } public static function init() { $className = get_called_class(); $class = new \ReflectionClass($className); if (array_key_exists($className, self::$values)) { throw new \Exception(sprintf("Enum has been already initialized, enum=%s", $className)); } self::$values[$className] = []; self::$valueMap[$className] = []; /** @var Enum[] $enumFields */ $enumFields = array_filter($class->getStaticProperties(), function ($property) { return $property instanceof Enum; }); if (count($enumFields) == 0) { throw new \Exception(sprintf("Enum has not values, enum=%s", $className)); } foreach ($enumFields as $property) { if (array_key_exists($property->getValue(), self::$valueMap[$className])) { throw new \Exception(sprintf("Duplicate enum value %s from enum %s", $property->getValue(), $className)); } self::$values[$className][] = $property; self::$valueMap[$className][$property->getValue()] = $property; } } }




特定のEnumは次のようになります。 



 class Format extends Enum { public static $WEB; public static $GOST; } Format::$WEB = new Format('web'); Format::$GOST = new Format('gost'); Format::init();


残念ながら、PHPでは静的フィールドに式を使用できないため、オブジェクトの作成はクラス外に移動する必要があります。



Doctrineの統合



プライベートコンストラクターのおかげで、EnumはTypeドクトリンから継承できません。 しかし、列挙をTypeにするにはどうすればよいでしょうか？ 答えは、Doctrineがエンティティのプロキシクラスを作成する方法を学習する過程で生じました。 各エンティティについて、Doctrineはエンティティクラスから継承するプロキシクラスを生成します。このプロキシクラスは遅延読み込みなどを実装します。 まあ、同じことを行います-各Enumクラスに対して、Typeを継承し、タイプを決定するために必要なロジックを実装するプロキシクラスを作成します。 これらのクラスは、必要に応じてキャッシュおよびロードできます。



Typeの基本的なロジックを実装するDoctrineEnumAbstractType



DoctrineEnumAbstractType.php 
 class DoctrineEnumAbstractType extends Type { /** @var Enum $enum */ protected static $enumClass = null; public function getSqlDeclaration(array $fieldDeclaration, AbstractPlatform $platform) { $enum = static::$enumClass; $values = implode( ", ", array_map(function (Enum $enum) { return "'" . $enum->getValue() . "'"; }, $enum::getValues())); if ($platform instanceof MysqlPlatform) { return sprintf('ENUM(%s)', $values); } elseif ($platform instanceof SqlitePlatform) { return sprintf('TEXT CHECK(%s IN (%s))', $fieldDeclaration['name'], $values); } elseif ($platform instanceof PostgreSqlPlatform) { return sprintf('VARCHAR(255) CHECK(%s IN (%s))', $fieldDeclaration['name'], $values); } else { throw new \Exception(sprintf("Sorry, platform %s currently not supported enums", $platform->getName())); } } public function getName() { $enum = static::$enumClass; return (new \ReflectionClass($enum))->getShortName(); } public function convertToPHPValue($value, AbstractPlatform $platform) { $enum = static::$enumClass; return $enum::getEnumObject($value); } public function convertToDatabaseValue($enum, AbstractPlatform $platform) { /** @var Enum $enum */ return $enum->getValue(); } public function requiresSQLCommentHint(AbstractPlatform $platform) { return true; } }




列挙のプロキシクラスを生成するDoctrineEnumProxyClassGenerator。



DoctrineEnumProxyClassGenerator.php 
 class DoctrineEnumProxyClassGenerator { public function proxyClassName($enumClass) { $enumClassName = (new \ReflectionClass($enumClass))->getShortName(); return $enumClassName . 'DoctrineEnum'; } public function proxyClassFullName($namespace, $enumClass) { return $namespace . '\\' . $this->proxyClassName($enumClass); } public function generateProxyClass($enumClass, $namespace) { $proxyClassTemplate = <<<EOF <?php namespace <namespace>; class <proxyClassName> extends \<proxyClassBase> { protected static \$enumClass = '\<enumClass>'; } EOF; $placeholders = [ 'namespace' => $namespace, 'proxyClassName' => self::proxyClassName($enumClass), 'proxyClassBase' => DoctrineEnumAbstractType::class, 'enumClass' => $enumClass, ]; return $this->generateCode($proxyClassTemplate, $placeholders); } private function generateCode($classTemplate, array $placeholders) { $placeholderNames = array_map(function ($placeholderName) { return '<' . $placeholderName . '>'; }, array_keys($placeholders)); $placeHolderValues = array_values($placeholders); return str_replace($placeholderNames, $placeHolderValues, $classTemplate); } }




列挙ごとに、ProxyClassGeneratorはエンティティクラスが実際の列挙になるようにDoctrineで使用できるプロキシクラスを生成します。



おわりに



その結果、Symfonyアプリケーションのさまざまなコンポーネント（Doctrine、Form、Twig）で使用できるEnumを取得しました。 この実装により、誰かが新しいソリューションを探したいと思うようになります。


More articles:


All Articles