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 

    20 namespace Doctrine\ORM;

    21 

    22 /**

    23  * An OptimisticLockException is thrown when a version check on an object

    24  * that uses optimistic locking through a version field fails.

    25  *

    26  * @author Roman Borschel <roman@code-factory.org>

    27  * @author Benjamin Eberlei <kontakt@beberlei.de>

    28  * @since 2.0

    29  */

    30 class OptimisticLockException extends ORMException

    31 {

    32     private $entity;

    33 

    34     public function __construct($msg, $entity)

    35     {

    36         parent::__construct($msg);

    37         $this->entity = $entity;

    38     }

    39 

    40     /**

    41      * Gets the entity that caused the exception.

    42      *

    43      * @return object

    44      */

    45     public function getEntity()

    46     {

    47         return $this->entity;

    48     }

    49 

    50     public static function lockFailed($entity)

    51     {

    52         return new self("The optimistic lock on an entity failed.", $entity);

    53     }

    54 

    55     public static function lockFailedVersionMissmatch($entity, $expectedLockVersion, $actualLockVersion)

    56     {

    57         return new self("The optimistic lock failed, version " . $expectedLockVersion . " was expected, but is actually ".$actualLockVersion, $entity);

    58     }

    59 

    60     public static function notVersioned($entityName)

    61     {

    62         return new self("Cannot obtain optimistic lock on unversioned entity " . $entityName, null);

    63     }

    64 }