EntityManager.php — MailPoet – Newsletters, Email Marketing, and Automation 5.36.0

mailpoet / vendor-prefixed / doctrine / orm / src / EntityManager.php

mailpoet / vendor-prefixed / doctrine / orm / src Last commit date

EntityManager.php

526 lines

1	<?php
2	declare (strict_types=1);
3	namespace MailPoetVendor\Doctrine\ORM;
4	if (!defined('ABSPATH')) exit;
5	use BackedEnum;
6	use BadMethodCallException;
7	use MailPoetVendor\Doctrine\Common\Cache\Psr6\CacheAdapter;
8	use MailPoetVendor\Doctrine\Common\EventManager;
9	use MailPoetVendor\Doctrine\Common\Persistence\PersistentObject;
10	use MailPoetVendor\Doctrine\DBAL\Connection;
11	use MailPoetVendor\Doctrine\DBAL\DriverManager;
12	use MailPoetVendor\Doctrine\DBAL\LockMode;
13	use MailPoetVendor\Doctrine\Deprecations\Deprecation;
14	use MailPoetVendor\Doctrine\ORM\Exception\EntityManagerClosed;
15	use MailPoetVendor\Doctrine\ORM\Exception\InvalidHydrationMode;
16	use MailPoetVendor\Doctrine\ORM\Exception\MismatchedEventManager;
17	use MailPoetVendor\Doctrine\ORM\Exception\MissingIdentifierField;
18	use MailPoetVendor\Doctrine\ORM\Exception\MissingMappingDriverImplementation;
19	use MailPoetVendor\Doctrine\ORM\Exception\NotSupported;
20	use MailPoetVendor\Doctrine\ORM\Exception\ORMException;
21	use MailPoetVendor\Doctrine\ORM\Exception\UnrecognizedIdentifierFields;
22	use MailPoetVendor\Doctrine\ORM\Mapping\ClassMetadata;
23	use MailPoetVendor\Doctrine\ORM\Mapping\ClassMetadataFactory;
24	use MailPoetVendor\Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
25	use MailPoetVendor\Doctrine\ORM\Proxy\ProxyFactory;
26	use MailPoetVendor\Doctrine\ORM\Query\Expr;
27	use MailPoetVendor\Doctrine\ORM\Query\FilterCollection;
28	use MailPoetVendor\Doctrine\ORM\Query\ResultSetMapping;
29	use MailPoetVendor\Doctrine\ORM\Repository\RepositoryFactory;
30	use MailPoetVendor\Doctrine\Persistence\Mapping\MappingException;
31	use InvalidArgumentException;
32	use function array_keys;
33	use function class_exists;
34	use function get_debug_type;
35	use function gettype;
36	use function is_array;
37	use function is_callable;
38	use function is_object;
39	use function is_string;
40	use function ltrim;
41	use function sprintf;
42	use function strpos;
43	class EntityManager implements EntityManagerInterface
44	{
45	private $config;
46	private $conn;
47	private $metadataFactory;
48	private $unitOfWork;
49	private $eventManager;
50	private $proxyFactory;
51	private $repositoryFactory;
52	private $expressionBuilder;
53	private $closed = \false;
54	private $filterCollection;
55	private $cache;
56	public function __construct(Connection $conn, Configuration $config, ?EventManager $eventManager = null)
57	{
58	if (!$config->getMetadataDriverImpl()) {
59	throw MissingMappingDriverImplementation::create();
60	}
61	$this->conn = $conn;
62	$this->config = $config;
63	// @phpstan-ignore method.deprecated
64	$this->eventManager = $eventManager ?? $conn->getEventManager();
65	$metadataFactoryClassName = $config->getClassMetadataFactoryName();
66	$this->metadataFactory = new $metadataFactoryClassName();
67	$this->metadataFactory->setEntityManager($this);
68	$this->configureMetadataCache();
69	$this->repositoryFactory = $config->getRepositoryFactory();
70	$this->unitOfWork = new UnitOfWork($this);
71	$this->proxyFactory = new ProxyFactory($this, $config->getProxyDir(), $config->getProxyNamespace(), $config->getAutoGenerateProxyClasses());
72	if ($config->isSecondLevelCacheEnabled()) {
73	$cacheConfig = $config->getSecondLevelCacheConfiguration();
74	$cacheFactory = $cacheConfig->getCacheFactory();
75	$this->cache = $cacheFactory->createCache($this);
76	}
77	}
78	public function getConnection()
79	{
80	return $this->conn;
81	}
82	public function getMetadataFactory()
83	{
84	return $this->metadataFactory;
85	}
86	public function getExpressionBuilder()
87	{
88	if ($this->expressionBuilder === null) {
89	$this->expressionBuilder = new Query\Expr();
90	}
91	return $this->expressionBuilder;
92	}
93	public function beginTransaction()
94	{
95	$this->conn->beginTransaction();
96	}
97	public function getCache()
98	{
99	return $this->cache;
100	}
101	public function transactional($func)
102	{
103	if (!is_callable($func)) {
104	throw new InvalidArgumentException('Expected argument of type "callable", got "' . gettype($func) . '"');
105	}
106	$this->conn->beginTransaction();
107	$successful = \false;
108	try {
109	$return = $func($this);
110	$this->flush();
111	$this->conn->commit();
112	$successful = \true;
113	return $return ?: \true;
114	} finally {
115	if (!$successful) {
116	$this->close();
117	if ($this->conn->isTransactionActive()) {
118	$this->conn->rollBack();
119	}
120	}
121	}
122	}
123	public function wrapInTransaction(callable $func)
124	{
125	$this->conn->beginTransaction();
126	$successful = \false;
127	try {
128	$return = $func($this);
129	$this->flush();
130	$this->conn->commit();
131	$successful = \true;
132	return $return;
133	} finally {
134	if (!$successful) {
135	$this->close();
136	if ($this->conn->isTransactionActive()) {
137	$this->conn->rollBack();
138	}
139	}
140	}
141	}
142	public function commit()
143	{
144	$this->conn->commit();
145	}
146	public function rollback()
147	{
148	$this->conn->rollBack();
149	}
150	public function getClassMetadata($className)
151	{
152	return $this->metadataFactory->getMetadataFor($className);
153	}
154	public function createQuery($dql = '')
155	{
156	$query = new Query($this);
157	if (!empty($dql)) {
158	$query->setDQL($dql);
159	}
160	return $query;
161	}
162	public function createNamedQuery($name)
163	{
164	return $this->createQuery($this->config->getNamedQuery($name));
165	}
166	public function createNativeQuery($sql, ResultSetMapping $rsm)
167	{
168	$query = new NativeQuery($this);
169	$query->setSQL($sql);
170	$query->setResultSetMapping($rsm);
171	return $query;
172	}
173	public function createNamedNativeQuery($name)
174	{
175	[$sql, $rsm] = $this->config->getNamedNativeQuery($name);
176	return $this->createNativeQuery($sql, $rsm);
177	}
178	public function createQueryBuilder()
179	{
180	return new QueryBuilder($this);
181	}
182	public function flush($entity = null)
183	{
184	if ($entity !== null) {
185	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8459', 'Calling %s() with any arguments to flush specific entities is deprecated and will not be supported in Doctrine ORM 3.0.', __METHOD__);
186	}
187	$this->errorIfClosed();
188	$this->unitOfWork->commit($entity);
189	}
190	public function find($className, $id, $lockMode = null, $lockVersion = null)
191	{
192	$class = $this->metadataFactory->getMetadataFor(ltrim($className, '\\'));
193	if ($lockMode !== null) {
194	$this->checkLockRequirements($lockMode, $class);
195	}
196	if (!is_array($id)) {
197	if ($class->isIdentifierComposite) {
198	throw ORMInvalidArgumentException::invalidCompositeIdentifier();
199	}
200	$id = [$class->identifier[0] => $id];
201	}
202	foreach ($id as $i => $value) {
203	if (is_object($value)) {
204	$className = DefaultProxyClassNameResolver::getClass($value);
205	if ($this->metadataFactory->hasMetadataFor($className)) {
206	$id[$i] = $this->unitOfWork->getSingleIdentifierValue($value);
207	if ($id[$i] === null) {
208	throw ORMInvalidArgumentException::invalidIdentifierBindingEntity($className);
209	}
210	}
211	}
212	}
213	$sortedId = [];
214	foreach ($class->identifier as $identifier) {
215	if (!isset($id[$identifier])) {
216	throw MissingIdentifierField::fromFieldAndClass($identifier, $class->name);
217	}
218	if ($id[$identifier] instanceof BackedEnum) {
219	$sortedId[$identifier] = $id[$identifier]->value;
220	} else {
221	$sortedId[$identifier] = $id[$identifier];
222	}
223	unset($id[$identifier]);
224	}
225	if ($id) {
226	throw UnrecognizedIdentifierFields::fromClassAndFieldNames($class->name, array_keys($id));
227	}
228	$unitOfWork = $this->getUnitOfWork();
229	$entity = $unitOfWork->tryGetById($sortedId, $class->rootEntityName);
230	// Check identity map first
231	if ($entity !== \false) {
232	if (!$entity instanceof $class->name) {
233	return null;
234	}
235	switch (\true) {
236	case $lockMode === LockMode::OPTIMISTIC:
237	$this->lock($entity, $lockMode, $lockVersion);
238	break;
239	case $lockMode === LockMode::NONE:
240	case $lockMode === LockMode::PESSIMISTIC_READ:
241	case $lockMode === LockMode::PESSIMISTIC_WRITE:
242	$persister = $unitOfWork->getEntityPersister($class->name);
243	$persister->refresh($sortedId, $entity, $lockMode);
244	break;
245	}
246	return $entity;
247	// Hit!
248	}
249	$persister = $unitOfWork->getEntityPersister($class->name);
250	switch (\true) {
251	case $lockMode === LockMode::OPTIMISTIC:
252	$entity = $persister->load($sortedId);
253	if ($entity !== null) {
254	$unitOfWork->lock($entity, $lockMode, $lockVersion);
255	}
256	return $entity;
257	case $lockMode === LockMode::PESSIMISTIC_READ:
258	case $lockMode === LockMode::PESSIMISTIC_WRITE:
259	return $persister->load($sortedId, null, null, [], $lockMode);
260	default:
261	return $persister->loadById($sortedId);
262	}
263	}
264	public function getReference($entityName, $id)
265	{
266	$class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
267	if (!is_array($id)) {
268	$id = [$class->identifier[0] => $id];
269	}
270	$sortedId = [];
271	foreach ($class->identifier as $identifier) {
272	if (!isset($id[$identifier])) {
273	throw MissingIdentifierField::fromFieldAndClass($identifier, $class->name);
274	}
275	$sortedId[$identifier] = $id[$identifier];
276	unset($id[$identifier]);
277	}
278	if ($id) {
279	throw UnrecognizedIdentifierFields::fromClassAndFieldNames($class->name, array_keys($id));
280	}
281	$entity = $this->unitOfWork->tryGetById($sortedId, $class->rootEntityName);
282	// Check identity map first, if its already in there just return it.
283	if ($entity !== \false) {
284	return $entity instanceof $class->name ? $entity : null;
285	}
286	if ($class->subClasses) {
287	return $this->find($entityName, $sortedId);
288	}
289	$entity = $this->proxyFactory->getProxy($class->name, $sortedId);
290	$this->unitOfWork->registerManaged($entity, $sortedId, []);
291	return $entity;
292	}
293	public function getPartialReference($entityName, $identifier)
294	{
295	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/10987', 'Method %s is deprecated and will be removed in 3.0.', __METHOD__);
296	$class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
297	$entity = $this->unitOfWork->tryGetById($identifier, $class->rootEntityName);
298	// Check identity map first, if its already in there just return it.
299	if ($entity !== \false) {
300	return $entity instanceof $class->name ? $entity : null;
301	}
302	if (!is_array($identifier)) {
303	$identifier = [$class->identifier[0] => $identifier];
304	}
305	$entity = $class->newInstance();
306	$class->setIdentifierValues($entity, $identifier);
307	$this->unitOfWork->registerManaged($entity, $identifier, []);
308	$this->unitOfWork->markReadOnly($entity);
309	return $entity;
310	}
311	public function clear($entityName = null)
312	{
313	if ($entityName !== null && !is_string($entityName)) {
314	// @phpstan-ignore staticMethod.deprecated
315	throw ORMInvalidArgumentException::invalidEntityName($entityName);
316	}
317	if ($entityName !== null) {
318	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8460', 'Calling %s() with any arguments to clear specific entities is deprecated and will not be supported in Doctrine ORM 3.0.', __METHOD__);
319	}
320	$this->unitOfWork->clear($entityName === null ? null : $this->metadataFactory->getMetadataFor($entityName)->getName());
321	}
322	public function close()
323	{
324	$this->clear();
325	$this->closed = \true;
326	}
327	public function persist($entity)
328	{
329	if (!is_object($entity)) {
330	throw ORMInvalidArgumentException::invalidObject('EntityManager#persist()', $entity);
331	}
332	$this->errorIfClosed();
333	$this->unitOfWork->persist($entity);
334	}
335	public function remove($entity)
336	{
337	if (!is_object($entity)) {
338	throw ORMInvalidArgumentException::invalidObject('EntityManager#remove()', $entity);
339	}
340	$this->errorIfClosed();
341	$this->unitOfWork->remove($entity);
342	}
343	public function refresh($entity, ?int $lockMode = null)
344	{
345	if (!is_object($entity)) {
346	throw ORMInvalidArgumentException::invalidObject('EntityManager#refresh()', $entity);
347	}
348	$this->errorIfClosed();
349	$this->unitOfWork->refresh($entity, $lockMode);
350	}
351	public function detach($entity)
352	{
353	if (!is_object($entity)) {
354	throw ORMInvalidArgumentException::invalidObject('EntityManager#detach()', $entity);
355	}
356	$this->unitOfWork->detach($entity);
357	}
358	public function merge($entity)
359	{
360	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8461', 'Method %s() is deprecated and will be removed in Doctrine ORM 3.0.', __METHOD__);
361	if (!is_object($entity)) {
362	throw ORMInvalidArgumentException::invalidObject('EntityManager#merge()', $entity);
363	}
364	$this->errorIfClosed();
365	return $this->unitOfWork->merge($entity);
366	}
367	public function copy($entity, $deep = \false)
368	{
369	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8462', 'Method %s() is deprecated and will be removed in Doctrine ORM 3.0.', __METHOD__);
370	throw new BadMethodCallException('Not implemented.');
371	}
372	public function lock($entity, $lockMode, $lockVersion = null)
373	{
374	$this->unitOfWork->lock($entity, $lockMode, $lockVersion);
375	}
376	public function getRepository($entityName)
377	{
378	if (strpos($entityName, ':') !== \false) {
379	if (class_exists(PersistentObject::class)) {
380	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/8818', 'Short namespace aliases such as "%s" are deprecated and will be removed in Doctrine ORM 3.0.', $entityName);
381	} else {
382	throw NotSupported::createForPersistence3(sprintf('Using short namespace alias "%s" when calling %s', $entityName, __METHOD__));
383	}
384	}
385	$repository = $this->repositoryFactory->getRepository($this, $entityName);
386	if (!$repository instanceof EntityRepository) {
387	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/9533', 'Not returning an instance of %s from %s::getRepository() is deprecated and will cause a TypeError on 3.0.', EntityRepository::class, get_debug_type($this->repositoryFactory));
388	}
389	return $repository;
390	}
391	public function contains($entity)
392	{
393	return $this->unitOfWork->isScheduledForInsert($entity) \|\| $this->unitOfWork->isInIdentityMap($entity) && !$this->unitOfWork->isScheduledForDelete($entity);
394	}
395	public function getEventManager()
396	{
397	return $this->eventManager;
398	}
399	public function getConfiguration()
400	{
401	return $this->config;
402	}
403	private function errorIfClosed() : void
404	{
405	if ($this->closed) {
406	throw EntityManagerClosed::create();
407	}
408	}
409	public function isOpen()
410	{
411	return !$this->closed;
412	}
413	public function getUnitOfWork()
414	{
415	return $this->unitOfWork;
416	}
417	public function getHydrator($hydrationMode)
418	{
419	return $this->newHydrator($hydrationMode);
420	}
421	public function newHydrator($hydrationMode)
422	{
423	switch ($hydrationMode) {
424	case Query::HYDRATE_OBJECT:
425	return new Internal\Hydration\ObjectHydrator($this);
426	case Query::HYDRATE_ARRAY:
427	return new Internal\Hydration\ArrayHydrator($this);
428	case Query::HYDRATE_SCALAR:
429	return new Internal\Hydration\ScalarHydrator($this);
430	case Query::HYDRATE_SINGLE_SCALAR:
431	return new Internal\Hydration\SingleScalarHydrator($this);
432	case Query::HYDRATE_SIMPLEOBJECT:
433	return new Internal\Hydration\SimpleObjectHydrator($this);
434	case Query::HYDRATE_SCALAR_COLUMN:
435	return new Internal\Hydration\ScalarColumnHydrator($this);
436	default:
437	$class = $this->config->getCustomHydrationMode($hydrationMode);
438	if ($class !== null) {
439	return new $class($this);
440	}
441	}
442	throw InvalidHydrationMode::fromMode((string) $hydrationMode);
443	}
444	public function getProxyFactory()
445	{
446	return $this->proxyFactory;
447	}
448	public function initializeObject($obj)
449	{
450	$this->unitOfWork->initializeObject($obj);
451	}
452	public function isUninitializedObject($obj) : bool
453	{
454	return $this->unitOfWork->isUninitializedObject($obj);
455	}
456	public static function create($connection, Configuration $config, ?EventManager $eventManager = null)
457	{
458	Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/pull/9961', '%s() is deprecated. To bootstrap a DBAL connection, call %s::getConnection() instead. Use the constructor to create an instance of %s.', __METHOD__, DriverManager::class, self::class);
459	$connection = static::createConnection($connection, $config, $eventManager);
460	return new EntityManager($connection, $config);
461	}
462	protected static function createConnection($connection, Configuration $config, ?EventManager $eventManager = null)
463	{
464	Deprecation::triggerIfCalledFromOutside('doctrine/orm', 'https://github.com/doctrine/orm/pull/9961', '%s() is deprecated, call %s::getConnection() instead.', __METHOD__, DriverManager::class);
465	if (is_array($connection)) {
466	return DriverManager::getConnection($connection, $config, $eventManager ?: new EventManager());
467	}
468	if (!$connection instanceof Connection) {
469	throw new InvalidArgumentException(sprintf('Invalid $connection argument of type %s given%s.', get_debug_type($connection), is_object($connection) ? '' : ': "' . $connection . '"'));
470	}
471	if ($eventManager !== null && $connection->getEventManager() !== $eventManager) {
472	throw MismatchedEventManager::create();
473	}
474	return $connection;
475	}
476	public function getFilters()
477	{
478	if ($this->filterCollection === null) {
479	$this->filterCollection = new FilterCollection($this);
480	}
481	return $this->filterCollection;
482	}
483	public function isFiltersStateClean()
484	{
485	return $this->filterCollection === null \|\| $this->filterCollection->isClean();
486	}
487	public function hasFilters()
488	{
489	return $this->filterCollection !== null;
490	}
491	private function checkLockRequirements(int $lockMode, ClassMetadata $class) : void
492	{
493	switch ($lockMode) {
494	case LockMode::OPTIMISTIC:
495	if (!$class->isVersioned) {
496	throw OptimisticLockException::notVersioned($class->name);
497	}
498	break;
499	case LockMode::PESSIMISTIC_READ:
500	case LockMode::PESSIMISTIC_WRITE:
501	if (!$this->getConnection()->isTransactionActive()) {
502	throw TransactionRequiredException::transactionRequired();
503	}
504	}
505	}
506	private function configureMetadataCache() : void
507	{
508	$metadataCache = $this->config->getMetadataCache();
509	if (!$metadataCache) {
510	$this->configureLegacyMetadataCache();
511	return;
512	}
513	$this->metadataFactory->setCache($metadataCache);
514	}
515	private function configureLegacyMetadataCache() : void
516	{
517	// @phpstan-ignore method.deprecated
518	$metadataCache = $this->config->getMetadataCacheImpl();
519	if (!$metadataCache) {
520	return;
521	}
522	// Wrap doctrine/cache to provide PSR-6 interface
523	$this->metadataFactory->setCache(CacheAdapter::wrap($metadataCache));
524	}
525	}
526