Completed
Pull Request — master (#6365)
by Daniel Tome
10:44
created

LocateFunction   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 50
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 6

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 6
dl 0
loc 50
ccs 0
cts 25
cp 0
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A getSql() 0 12 2
A parse() 0 20 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\ORM\Query\AST\Functions;
21
22
use Doctrine\ORM\Query\Lexer;
23
24
/**
25
 * "LOCATE" "(" StringPrimary "," StringPrimary ["," SimpleArithmeticExpression]")"
26
 *
27
 * 
28
 * @link    www.doctrine-project.org
29
 * @since   2.0
30
 * @author  Guilherme Blanco <[email protected]>
31
 * @author  Jonathan Wage <[email protected]>
32
 * @author  Roman Borschel <[email protected]>
33
 * @author  Benjamin Eberlei <[email protected]>
34
 */
35
class LocateFunction extends FunctionNode
36
{
37
    public $firstStringPrimary;
38
    public $secondStringPrimary;
39
40
    /**
41
     * @var \Doctrine\ORM\Query\AST\SimpleArithmeticExpression|bool
42
     */
43
    public $simpleArithmeticExpression = false;
44
45
    /**
46
     * @override
47
     */
48
    public function getSql(\Doctrine\ORM\Query\SqlWalker $sqlWalker)
49
    {
50
51
        return $sqlWalker->getConnection()->getDatabasePlatform()->getLocateExpression(
52
            $sqlWalker->walkStringPrimary($this->secondStringPrimary), // its the other way around in platform
53
            $sqlWalker->walkStringPrimary($this->firstStringPrimary),
54
            (($this->simpleArithmeticExpression)
0 ignored issues
show
Bug introduced by
It seems like $this->simpleArithmeticE...eticExpression) : false can also be of type string; however, Doctrine\DBAL\Platforms\...::getLocateExpression() does only seem to accept integer|boolean, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
55
                ? $sqlWalker->walkSimpleArithmeticExpression($this->simpleArithmeticExpression)
0 ignored issues
show
Bug introduced by
It seems like $this->simpleArithmeticExpression can also be of type boolean; however, Doctrine\ORM\Query\SqlWa...eArithmeticExpression() does only seem to accept object<Doctrine\ORM\Quer...leArithmeticExpression>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
56
                : false
57
            )
58
        );
59
    }
60
61
    /**
62
     * @override
63
     */
64
    public function parse(\Doctrine\ORM\Query\Parser $parser)
65
    {
66
        $parser->match(Lexer::T_IDENTIFIER);
67
        $parser->match(Lexer::T_OPEN_PARENTHESIS);
68
69
        $this->firstStringPrimary = $parser->StringPrimary();
70
71
        $parser->match(Lexer::T_COMMA);
72
73
        $this->secondStringPrimary = $parser->StringPrimary();
74
75
        $lexer = $parser->getLexer();
76
        if ($lexer->isNextToken(Lexer::T_COMMA)) {
77
            $parser->match(Lexer::T_COMMA);
78
79
            $this->simpleArithmeticExpression = $parser->SimpleArithmeticExpression();
80
        }
81
82
        $parser->match(Lexer::T_CLOSE_PARENTHESIS);
83
    }
84
}
85