Completed
Pull Request — master (#1419)
by Robert
11:09 queued 01:09
created

LockException::notVersioned()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
crap 1
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 MIT license. For more information, see
17
 * <http://www.doctrine-project.org>.
18
 */
19
20
namespace Doctrine\ODM\MongoDB;
21
22
/**
23
 * LockException
24
 *
25
 * @since 1.0
26
 */
27
class LockException extends MongoDBException
28
{
29
    private $document;
30
31 14
    public function __construct($msg, $document = null)
32
    {
33 14
        parent::__construct($msg);
34 14
        $this->document = $document;
35 14
    }
36
37
    /**
38
     * Gets the document that caused the exception.
39
     *
40
     * @return object
41
     */
42
    public function getDocument()
43
    {
44
        return $this->document;
45
    }
46
47 10
    public static function lockFailed($document)
48
    {
49 10
        return new self('A lock failed on a document.', $document);
50
    }
51
52 1
    public static function lockFailedVersionMissmatch($document, $expectedLockVersion, $actualLockVersion)
53
    {
54 1
        return new self('The optimistic lock failed, version ' . $expectedLockVersion . ' was expected, but is actually '.$actualLockVersion, $document);
55
    }
56
57 1
    public static function notVersioned($documentName)
58
    {
59 1
        return new self('Document ' . $documentName . ' is not versioned.');
60
    }
61
62 1
    public static function invalidLockFieldType($type)
63
    {
64 1
        return new self('Invalid lock field type '.$type.'. Lock field must be int.');
65
    }
66
67 1
    public static function invalidVersionFieldType($type)
68
    {
69 1
        return new self('Invalid version field type '.$type.'. Version field must be int or date.');
70
    }
71
}
72