README

这是一个提供对独立包 consistence/consistence-doctrine 集成的Symfony 扩展包，如果你不使用Symfony，请遵循那里的说明。

此扩展包提供了Consistence值对象与Doctrine ORM的集成，以便你可以在实体中使用它们。

目前，所需的唯一集成是枚举，以下是一些示例。

使用方法

枚举代表一组预定义的值，当然，你也会希望将这些值存储到你的数据库中。由于Enums是对象，而你只想存储代表值，因此需要进行某种映射。

以下是一个示例，其中你想要为User存储性别

<?php

namespace Consistence\Doctrine\Example\User;

class Sex extends \Consistence\Enum\Enum
{

	public const FEMALE = 'female';
	public const MALE = 'male';

}

现在你可以在你的User实体中使用Sex枚举。有两个重要的事情要注意

1. 在ORM\Column中使用type="string_enum" - 这将用于将值映射到数据库，这意味着如果你有一个基于字符串的枚举（参看Sex中的值），请使用string_enum

你可以像通常一样指定任何其他ORM\Column参数（null性、长度...）。

还有integer_enum、float_enum和boolean_enum，可以分别用于其类型。

1. @Enum(class=Sex::class) - 这将用于从数据库加载值时重新构造Sex枚举对象

class注解参数使用与其他Doctrine注解相同的命名空间解析过程，所以它实际上与你在关联映射中指定targetEntity时相同。

<?php

namespace Consistence\Doctrine\Example\User;

use Consistence\Doctrine\Enum\EnumAnnotation as Enum;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class User extends \Consistence\ObjectPrototype
{

	// ...

	/**
	 * @Enum(class=Sex::class)
	 * @ORM\Column(type="string_enum", nullable=true)
	 * @var \Consistence\Doctrine\Example\User\Sex|null
	 */
	private $sex;

	// ...

	public function __construct(
		// ...
		Sex $sex = null
		// ...
	)
	{
		// ...
		$this->sex = $sex;
		// ...
	}

	// ...

}

现在一切准备就绪，当你调用flush时，只有female会被保存

<?php

namespace Consistence\Doctrine\Example\User;

$user = new User(
	// ...
	Sex::get(Sex::FEMALE)
	// ...
);
/** @var \Doctrine\ORM\EntityManager $entityManager */
$entityManager->persist($user);

// when persisting User::$sex to database, `female` will be saved
$entityManager->flush();

当你从数据库中检索实体时，你将再次收到Sex枚举对象

<?php

namespace Consistence\Doctrine\Example\User;

/** @var \Doctrine\ORM\EntityManager $entityManager */
$user = $entityManager->find(User::class, 1);
var_dump($user->getSex());

/*

class Consistence\Doctrine\Example\User\Sex#5740 (1) {
  private $value =>
  string(6) "female"
}

*/

这意味着对象API是对称的（你得到你设置的相同类型），你可以开始利用枚举的优点，例如，确保你得到的是有效的值，以及在代表值上定义方法的可能性。

配置

你可以覆盖内部使用的服务，例如，如果你想在生产中使用更有效的缓存（这是推荐的），你可以提供带有alias的自定义实例

services:
    mycache:
        class: Doctrine\Common\Cache\FilesystemCache
        arguments:
            - '%kernel.cache_dir%/mycache'

    consistence.doctrine.enum.enum_fields_cache: '@mycache'

安装

1. 使用Composer安装包consistence/consistence-doctrine-symfony

composer require consistence/consistence-doctrine-symfony

1. 在你的应用程序中注册扩展包

// config/bundles.php
return [
	// ...
	Consistence\Doctrine\SymfonyBundle\ConsistenceDoctrineBundle::class => ['all' => true],
];

这就完成了，你可以开始了！