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

GeometryDistance::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 2D distance between geometries operator (using <->).
11
 *
12
 * Returns the 2D distance between A and B geometries.
13
 * This differs from BoundingBoxDistance (using <#>), which measures distance between
14
 * bounding boxes only. The <-> operator is commonly used for KNN nearest-neighbor
15
 * ordering, and on PostgreSQL 9.5+ with PostGIS 2.2+ it returns true geometry distance;
16
 * on older stacks it behaved as a centroid-of-bounding-box distance approximation.
17
 *
18
 * @see https://postgis.net/docs/reference.html#Operators
19
 * @see https://postgis.net/docs/geometry_distance_knn.html
20
 * @since 3.5
21
 *
22
 * @author Martin Georgiev <[email protected]>
23
 *
24
 * @example Using it in DQL: "SELECT GEOMETRY_DISTANCE(g1.geometry, g2.geometry) FROM Entity g1, Entity g2"
25
 * Returns numeric distance value.
26
 */
27
class GeometryDistance extends BaseFunction
28
{
29 1
    protected function customizeFunction(): void
30
    {
31 1
        $this->setFunctionPrototype('(%s <-> %s)');
32 1
        $this->addNodeMapping('StringPrimary');
33 1
        $this->addNodeMapping('StringPrimary');
34
    }
35
}
36