vendor/sonata-project/doctrine-extensions/src/Model/BaseManager.php line 54

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of the Sonata Project package.
  7. *
  8. * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9. *
  10. * For the full copyright and license information, please view the LICENSE
  11. * file that was distributed with this source code.
  12. */
  14. namespace Sonata\Doctrine\Model;
  16. use Doctrine\Persistence\ManagerRegistry;
  17. use Doctrine\Persistence\ObjectManager;
  18. use Doctrine\Persistence\ObjectRepository;
  20. /**
  21. * @author Hugo Briand <briand@ekino.com>
  22. *
  23. * @phpstan-template T of object
  24. * @phpstan-implements ManagerInterface<T>
  25. */
  26. abstract class BaseManager implements ManagerInterface, ClearableManagerInterface
  27. {
  28. /**
  29. * @phpstan-param class-string<T> $class
  30. */
  31. public function __construct(
  32. protected string $class,
  33. protected ManagerRegistry $registry,
  34. ) {
  35. }
  37. public function getClass(): string
  38. {
  39. return $this->class;
  40. }
  42. public function findAll(): array
  43. {
  44. return $this->getRepository()->findAll();
  45. }
  47. public function findBy(array $criteria, ?array $orderBy = null, ?int $limit = null, ?int $offset = null): array
  48. {
  49. return $this->getRepository()->findBy($criteria, $orderBy, $limit, $offset);
  50. }
  52. public function findOneBy(array $criteria): ?object
  53. {
  54. return $this->getRepository()->findOneBy($criteria);
  55. }
  57. public function find(mixed $id): ?object
  58. {
  59. return $this->getRepository()->find($id);
  60. }
  62. public function create(): object
  63. {
  64. return new $this->class();
  65. }
  67. public function save(object $entity, bool $andFlush = true): void
  68. {
  69. $this->checkObject($entity);
  71. $this->getObjectManager()->persist($entity);
  73. if ($andFlush) {
  74. $this->getObjectManager()->flush();
  75. }
  76. }
  78. public function delete(object $entity, bool $andFlush = true): void
  79. {
  80. $this->checkObject($entity);
  82. $this->getObjectManager()->remove($entity);
  84. if ($andFlush) {
  85. $this->getObjectManager()->flush();
  86. }
  87. }
  89. public function clear(): void
  90. {
  91. $this->getObjectManager()->clear();
  92. }
  94. /**
  95. * Returns the related Object Repository.
  96. *
  97. * @return ObjectRepository<object>
  98. *
  99. * @phpstan-return ObjectRepository<T>
  100. */
  101. protected function getRepository(): ObjectRepository
  102. {
  103. return $this->getObjectManager()->getRepository($this->class);
  104. }
  106. /**
  107. * @throws \InvalidArgumentException
  108. *
  109. * @phpstan-param T $object
  110. */
  111. protected function checkObject(object $object): void
  112. {
  113. if (!$object instanceof $this->class) {
  114. throw new \InvalidArgumentException(\sprintf(
  115. 'Object must be instance of %s, %s given',
  116. $this->class,
  117. get_debug_type($object)
  118. ));
  119. }
  120. }
  122. /**
  123. * @throws \RuntimeException
  124. */
  125. protected function getObjectManager(): ObjectManager
  126. {
  127. $manager = $this->registry->getManagerForClass($this->class);
  129. if (null === $manager) {
  130. throw new \RuntimeException(\sprintf(
  131. 'Unable to find the mapping information for the class %s.'
  132. .' Please check the `auto_mapping` option'
  133. .' (http://symfony.com/doc/current/reference/configuration/doctrine.html#configuration-overview)'
  134. .' or add the bundle to the `mappings` section in the doctrine configuration.',
  135. $this->class
  136. ));
  137. }
  139. return $manager;
  140. }
  141. }