Passed
Push — new-postgis-functions ( fc1b14...a15d42 )
by Martin
13:28
created

StrictlyRight::customizeFunction()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 0
dl 0
loc 5
ccs 4
cts 4
cp 1
crap 1
rs 10
c 0
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\PostGIS;
6
7
use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\BaseFunction;
8
9
/**
10
 * Implementation of PostGIS bounding box strictly to the right operator (using >>).
11
 *
12
 * Returns TRUE if A's bounding box is strictly to the right of B's.
13
 *
14
 * @see https://postgis.net/docs/reference.html#Operators_Geometry
15
 * @since 3.5
16
 *
17
 * @author Martin Georgiev <[email protected]>
18
 *
19
 * @example Using it in DQL with boolean comparison: "WHERE STRICTLY_RIGHT(g1.geometry, g2.geometry) = TRUE"
20
 * Returns boolean, must be used with "= TRUE" or "= FALSE" in DQL.
21
 */
22
class StrictlyRight extends BaseFunction
23
{
24 1
    protected function customizeFunction(): void
25
    {
26 1
        $this->setFunctionPrototype('(%s >> %s)');
27 1
        $this->addNodeMapping('StringPrimary');
28 1
        $this->addNodeMapping('StringPrimary');
29
    }
30
}
31