Completed
Push — master ( 00cd4d...138695 )
by Maciej
10:37
created

invalidReturnTypeHint()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 12
ccs 0
cts 12
cp 0
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 8
nc 1
nop 3
crap 2
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\PersistentCollection;
21
22
use Doctrine\ODM\MongoDB\MongoDBException;
23
24
/**
25
 * MongoDB ODM PersistentCollection Exception.
26
 *
27
 * @since 1.1
28
 */
29
class PersistentCollectionException extends MongoDBException
30
{
31
    public static function directoryNotWritable()
32
    {
33
        return new self('Your PersistentCollection directory must be writable.');
34
    }
35
36
    public static function directoryRequired()
37
    {
38
        return new self('You must configure a PersistentCollection directory. See docs for details.');
39
    }
40
41
    public static function namespaceRequired()
42
    {
43
        return new self('You must configure a PersistentCollection namespace. See docs for details');
44
    }
45
46
    /**
47
     * @param string          $className
48
     * @param string          $methodName
49
     * @param string          $parameterName
50
     * @param \Exception|null $previous
51
     *
52
     * @return self
53
     */
54
    public static function invalidParameterTypeHint(
55
        $className,
56
        $methodName,
57
        $parameterName,
58
        \Exception $previous = null
59
    ) {
60
        return new self(
61
            sprintf(
62
                'The type hint of parameter "%s" in method "%s" in class "%s" is invalid.',
63
                $parameterName,
64
                $methodName,
65
                $className
66
            ),
67
            0,
68
            $previous
69
        );
70
    }
71
72
    /**
73
     * @param $className
74
     * @param $methodName
75
     * @param \Exception|null $previous
76
     *
77
     * @return self
78
     */
79
    public static function invalidReturnTypeHint($className, $methodName, \Exception $previous = null)
80
    {
81
        return new self(
82
            sprintf(
83
                'The return type of method "%s" in class "%s" is invalid.',
84
                $methodName,
85
                $className
86
            ),
87
            0,
88
            $previous
89
        );
90
    }
91
}
92