entity: added experimental ImmutableValuePropertyContainer

src/Entity/ImmutableValuePropertyContainer.php

@@ -0,0 +1,92 @@
+<?php declare(strict_types = 1);
+
+/**
+ * This file is part of the Nextras\Orm library.
+ * @license    MIT
+ * @link       https://github.com/nextras/orm
+ */
+
+namespace Nextras\Orm\Entity;
+
+use Nextras\Orm\Entity\Reflection\PropertyMetadata;
+
+
+/**
+ * This class is experimental and may change in the future versions.
+ */
+abstract class ImmutableValuePropertyContainer implements IPropertyContainer
+{
+	/** @var null|mixed */
+	private $value;
+
+	/** @var IEntity */
+	private $entity;
+
+	/** @var PropertyMetadata */
+	private $propertyMetadata;
+
+
+	public function __construct(IEntity $entity, PropertyMetadata $propertyMetadata)
+	{
+		$this->entity = $entity;
+		$this->propertyMetadata = $propertyMetadata;
+	}
+
+
+	public function loadValue(array $values)
+	{
+		$this->setRawValue($values[$this->propertyMetadata->name]);
+	}
+
+
+	public function saveValue(array $values): array
+	{
+		$values[$this->propertyMetadata->name] = $this->getRawValue();
+		return $values;
+	}
+
+
+	public function setRawValue($value)
+	{
+		$this->value = $value === null ? null : $this->deserialize($value);
+	}
+
+
+	public function getRawValue()
+	{
+		return $this->value === null ? null : $this->serialize($this->value);
+	}
+
+
+	public function &getInjectedValue()
+	{
+		return $this->value;
+	}
+
+
+	public function hasInjectedValue(): bool
+	{
+		return $this->value !== null;
+	}
+
+
+	public function setInjectedValue($value)
+	{
+		if ($this->isModified($this->value, $value)) {
+			$this->entity->setAsModified($this->propertyMetadata->name);
+		}
+		$this->value = $value;
+	}
+
+
+	protected function isModified($oldValue, $newValue): bool
+	{
+		return $oldValue !== $newValue;
+	}
+
+
+	abstract protected function serialize($value);
+
+
+	abstract protected function deserialize($value);
+}