OptimisticLockException.php 2.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <?php
  2. /*
  3. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. *
  15. * This software consists of voluntary contributions made by many individuals
  16. * and is licensed under the LGPL. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\ORM;
  20. /**
  21. * An OptimisticLockException is thrown when a version check on an object
  22. * that uses optimistic locking through a version field fails.
  23. *
  24. * @author Roman Borschel <roman@code-factory.org>
  25. * @author Benjamin Eberlei <kontakt@beberlei.de>
  26. * @since 2.0
  27. */
  28. class OptimisticLockException extends ORMException
  29. {
  30. private $entity;
  31. public function __construct($msg, $entity)
  32. {
  33. parent::__construct($msg);
  34. $this->entity = $entity;
  35. }
  36. /**
  37. * Gets the entity that caused the exception.
  38. *
  39. * @return object
  40. */
  41. public function getEntity()
  42. {
  43. return $this->entity;
  44. }
  45. public static function lockFailed($entity)
  46. {
  47. return new self("The optimistic lock on an entity failed.", $entity);
  48. }
  49. public static function lockFailedVersionMissmatch($entity, $expectedLockVersion, $actualLockVersion)
  50. {
  51. return new self("The optimistic lock failed, version " . $expectedLockVersion . " was expected, but is actually ".$actualLockVersion, $entity);
  52. }
  53. public static function notVersioned($entityName)
  54. {
  55. return new self("Cannot obtain optimistic lock on unversioned entity " . $entityName, null);
  56. }
  57. }