1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
<?php
declare(strict_types=1);
namespace Doctrine\ORM;
use DateTimeInterface;
use Doctrine\ORM\Exception\ORMException;
/**
* An OptimisticLockException is thrown when a version check on an object
* that uses optimistic locking through a version field fails.
*/
class OptimisticLockException extends ORMException
{
/** @var object|string|null */
private $entity;
/**
* @param string $msg
* @param object|string|null $entity
*/
public function __construct($msg, $entity)
{
parent::__construct($msg);
$this->entity = $entity;
}
/**
* Gets the entity that caused the exception.
*
* @return object|string|null
*/
public function getEntity()
{
return $this->entity;
}
/**
* @param object|class-string $entity
*
* @return OptimisticLockException
*/
public static function lockFailed($entity)
{
return new self('The optimistic lock on an entity failed.', $entity);
}
/**
* @param object $entity
* @param int|string|DateTimeInterface $expectedLockVersion
* @param int|string|DateTimeInterface $actualLockVersion
*
* @return OptimisticLockException
*/
public static function lockFailedVersionMismatch($entity, $expectedLockVersion, $actualLockVersion)
{
$expectedLockVersion = $expectedLockVersion instanceof DateTimeInterface ? $expectedLockVersion->getTimestamp() : $expectedLockVersion;
$actualLockVersion = $actualLockVersion instanceof DateTimeInterface ? $actualLockVersion->getTimestamp() : $actualLockVersion;
return new self('The optimistic lock failed, version ' . $expectedLockVersion . ' was expected, but is actually ' . $actualLockVersion, $entity);
}
/**
* @param string $entityName
*
* @return OptimisticLockException
*/
public static function notVersioned($entityName)
{
return new self('Cannot obtain optimistic lock on unversioned entity ' . $entityName, null);
}
}
|
