Passed
Push — new-postgis-functions-2 ( 1e372d )
by Martin
12:50
created

ST_Area2D::customizeFunction()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 2
c 1
b 0
f 1
nc 1
nop 0
dl 0
loc 4
ccs 0
cts 3
cp 0
crap 2
rs 10
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 ST_Area2D() function.
11
 *
12
 * Returns the 2D area of the geometry if it is a polygon or multi-polygon.
13
 * For non-areal geometries, 0 is returned.
14
 * Ignores Z coordinates.
15
 *
16
 * @see https://postgis.net/docs/ST_Area2D.html
17
 * @since 3.5
18
 *
19
 * @author Martin Georgiev <[email protected]>
20
 *
21
 * @example Using it in DQL: "SELECT ST_AREA2D(g.geometry) FROM Entity g"
22
 * Returns numeric 2D area value.
23
 */
24
class ST_Area2D extends BaseFunction
25
{
26
    protected function customizeFunction(): void
27
    {
28
        $this->setFunctionPrototype('ST_Area2D(%s)');
29
        $this->addNodeMapping('StringPrimary');
30
    }
31
}
32