LazyEntityGetter replaced with EntityFinderByPrimary

Author: MartkCz

src/DI/UtilityExtension.php

@@ -11,6 +11,7 @@
 use Utilitte\Doctrine\FetchByIdentifiers;
 use Utilitte\Doctrine\Query\RawQueryFactory;
 use Utilitte\Doctrine\QueryMetadataExtractor;
+use Utilitte\Nette\Doctrine\EntityFinderByPrimaryFactory;
 use Utilitte\Nette\Http\MaxUploadSize;
 use Utilitte\Nette\Latte\Macros;
 use Utilitte\Nette\UI\FlexibleMultiplierByIdentifierFactory;
@@ -44,6 +45,9 @@ public function loadConfiguration(): void
 		$builder->addDefinition($this->prefix('flexibleTransferObjectMultiplier'))
 			->setFactory(FlexibleTransferObjectMultiplier::class);
 
+		$builder->addFactoryDefinition($this->prefix('entityPresenterFinder'))
+			->setImplement(EntityFinderByPrimaryFactory::class);
+
 		if (interface_exists(EntityManagerInterface::class) && class_exists(DoctrineIdentityExtractor::class)) {
 			$builder->addDefinition($this->prefix('doctrine.identityExtractor'))
 				->setType(DoctrineIdentityExtractor::class);

src/Doctrine/EntityFinderByPrimary.php

@@ -0,0 +1,164 @@
+<?php declare(strict_types = 1);
+
+namespace Utilitte\Nette\Doctrine;
+
+use Doctrine\ORM\EntityManagerInterface;
+use LogicException;
+use Nette\Application\IPresenter;
+use Nette\Application\UI\Presenter;
+use Nette\Utils\Strings;
+use Utilitte\Nette\Exceptions\EntityIsNotValid;
+use Utilitte\Nette\Exceptions\EntityNotFound;
+use Utilitte\Nette\Exceptions\InvalidArgumentException;
+
+final class EntityFinderByPrimary
+{
+
+	/** @var callable[] */
+	private array $validators = [];
+
+	/** @var array{parameter:mixed, class:string, object:object}|null */
+	private ?array $previous = null;
+
+	private Presenter $presenter;
+
+	private string|int|null $parameterValue;
+
+	private bool $parameterSet = false;
+
+	private string $parameterName = 'id';
+
+	public function __construct(
+		IPresenter $presenter,
+		private EntityManagerInterface $em,
+
+	)
+	{
+		if (!$presenter instanceof Presenter) {
+			throw new \InvalidArgumentException(sprintf('Supported only %s.', Presenter::class));
+		}
+
+		$this->presenter = $presenter;
+	}
+
+	private function getParameterValue(): string|int|null
+	{
+		if (!$this->parameterSet) {
+			$this->parameterValue = $this->presenter->getParameter($this->parameterName);
+		}
+
+		return $this->parameterValue;
+	}
+
+	public function setParameterValue(string|int|null $parameterValue): self
+	{
+		if ($this->parameterSet) {
+			throw new LogicException('Cannot set parameter value, parameter value already set.');
+		}
+
+		$this->parameterSet = true;
+		$this->parameterValue = $parameterValue;
+
+		return $this;
+	}
+
+	public function setParameterName(string $parameterName): self
+	{
+		if ($this->parameterSet) {
+			throw new LogicException('Cannot set parameter name, parameter value already set.');
+		}
+
+		$this->parameterName = $parameterName;
+
+		return $this;
+	}
+
+	public function addValidator(callable $validator): self
+	{
+		$this->validators[] = $validator;
+
+		return $this;
+	}
+
+	/**
+	 * @template T
+	 * @param class-string<T> $class
+	 * @param mixed[] $checkParameters
+	 * @return T|null
+	 */
+	public function getEntityIfParameterPresented(string $class): ?object
+	{
+		if ($this->getParameterValue() === null) {
+			return null;
+		}
+
+		return $this->getEntity($class);
+	}
+
+	/**
+	 * @template T
+	 * @param class-string<T> $class
+	 * @param mixed[] $checkParameters
+	 * @return T|null
+	 */
+	public function getNullableEntity(string $class): ?object
+	{
+		$id = $this->getParameterValue();
+		if ($this->previous === null) {
+			if ($id === null) {
+				return null;
+			}
+
+			$object = $this->em->find($class, $id);
+
+			if (!$object) {
+				return null;
+			}
+
+			foreach ($this->validators as $validator) {
+				if ($validator($object) === false) {
+					throw new EntityIsNotValid($class, $id);
+				}
+			}
+
+			$this->previous = [
+				'parameter' => $id,
+				'class' => $class,
+				'object' => $object,
+			];
+		} elseif ($this->previous['class'] !== $class) {
+			throw new InvalidArgumentException(
+				sprintf('Entity %s already requested, cannot request %s entity.', $this->previous['class'], $class)
+			);
+		} elseif ($this->previous['parameter'] !== $id) {
+			throw new LogicException(
+				sprintf(
+					'Entity %s with id %s requested, cannot change id to %s.',
+					$this->previous['class'],
+					(string) $this->previous['parameter'],
+					(string) $id,
+				)
+			);
+		}
+
+		return $this->previous['object'];
+	}
+
+	/**
+	 * @template T
+	 * @param class-string<T> $class
+	 * @param mixed[] $checkParameters
+	 * @return T
+	 */
+	public function getEntity(string $class): object
+	{
+		$object = $this->getNullableEntity($class);
+
+		if (!$object) {
+			throw new EntityNotFound($class, $id);
+		}
+
+		return $object;
+	}
+
+}

src/Doctrine/EntityFinderByPrimaryFactory.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types = 1);
+
+namespace Utilitte\Nette\Doctrine;
+
+use Nette\Application\IPresenter;
+
+interface EntityFinderByPrimaryFactory
+{
+
+	public function create(IPresenter $presenter): EntityFinderByPrimary;
+
+}

src/Traits/Application/EntityFinderByPrimaryTrait.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace Utilitte\Nette\Traits\Application;
+
+use Utilitte\Nette\Doctrine\EntityFinderByPrimary;
+use Utilitte\Nette\Doctrine\EntityFinderByPrimaryFactory;
+
+trait EntityFinderByPrimaryTrait
+{
+
+	private EntityFinderByPrimary $entityFinderByPrimary;
+	
+	final public function injectEntityFinderByPrimary(EntityFinderByPrimaryFactory $factory): void
+	{
+		$this->entityFinderByPrimary = $factory->create($this);
+	}
+
+}