README

值对象和枚举

安装和文档

• 作为 [Composer] 包 [yomy/valueobject] 提供。

这个库是关于什么的

这个库添加了 ValueObject 和 EnumValueObject 类。

值对象的示例

创建对象

use YomY\ValueObject\ValueObject;
$object = ValueObject::instance(1);

从对象获取值

$value = $object->getValue();

具有相同值的对象将是同一个对象

$object1 = ValueObject::instance(1);
$object2 = ValueObject::instance(1);
//These two are the same objects ($object1 === $object2)

您可以在方法中使用类型提示

public function doSomething(ValueObject $valueObject) {
    $value = $valueObject->getValue();
    ...
}

您可以为更详细的类型提示扩展对象

class UserId extends ValueObject {}
class DataId extends ValueObject {}
...
public function doSomething(UserId $userId, DataId $dataId) {
    ...
}

不同类或变量类型的对象是不同的

$object1 = ValueObject::instance('');
$object2 = ValueObject::instance(null);
$object3 = ValueObject::instance(false);
$object4 = ExtendedValueObject::instance('');
$object5 = ExtendedValueObject::instance(null);
$object6 = ExtendedValueObject::instance(false);
//All of the above are different

除了强（===）比较运算符外，您还可以使用 equals() 方法

$object1 = ValueObject::instance(1);
$object2 = ValueObject::instance(1);
$same = $object1->equals($object2); //true

通常，值对象的反序列化是被禁止的，因为这会破坏通过引用比较对象的能力。然而，您可能有一个您不关心严格比较的情况，并且需要反序列化对象。您可以在自定义对象中添加 WeakValueObjectTrait 使用，这将允许您反序列化对象，并在使用 equals() 方法时通过值而不是引用来比较对象

class MyWeakObject extends ValueObject {
    use WeakValueObjectTrait;
}
...
$weakObject1 = MyWeakObject::instance(1);
$serializedWeakObject = serialize($weakObject1);
$weakObject2 = unserialize($serializedWeakObject);
//These two objects are "equal" but not the same
$weakObject1->equals($weakObject2); //true
//On regular value objects this would be false

枚举值对象的示例

创建枚举对象

use YomY\ValueObject\EnumValueObject;
class Category extends EnumValueObject {
    const FIRST = 1;
    const SECOND = 2;
    const THIRD = 3;
}

创建枚举对象

$category = Category::instance(Category::FIRST);

或通过引用键

$category = Category::FIRST();

如果尝试实例化无效值，将引发错误

$category = Category::instance('missing_value');
$category = Category::MISSING();

正整数值对象的示例

由于值对象通常用作具有整数键的数据库实体的标识符，正整数值对象确保了用于此目的的有效键对象

创建对象

use YomY\ValueObject\PositiveIntValueObject;
$object1 = PositiveIntValueObject::instance(1);
$object2 = PositiveIntValueObject::instance('1');
//These two are the same objects ($object1 === $object2)

通常，数据库中的 id 键不能为 0，因此这些对象是无效的

$object = PositiveIntValueObject::instance(0);
$object = PositiveIntValueObject::instance('0');

当然，与基本值对象一样，这些对象打算用于扩展类中。

class UserId extends PositiveIntValueObject {}
class DataId extends PositiveIntValueObject {}
$user = UserId::instance(42);
$data = DataId::instance(42);
//these two are not the same