View GitHub Repository postgresql-for-doctrine

Schedule Inspection
Subscribe
Passed
Push — new-postgis-functions ( b27060 )
by Martin
14:48
created

ST_Covers::customizeFunction()   A

↳ Parent: ST_Covers

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 1
Bugs 0 Features 1
Metric Value
eloc 3
c 1
b 0
f 1
dl 0
loc 5
ccs 4
cts 4
cp 1
rs 10
cc 1
nc 1
nop 0
crap 1
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_Covers() function.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
 * Tests if every point of B lies in A.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
 * @see https://postgis.net/docs/ST_Covers.html

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
 * @since 3.5

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
 * @author Martin Georgiev <[email protected]>

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
 * @example Using it in DQL: "WHERE ST_Covers(g.geometry1, g.geometry2) = TRUE"

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
 * Returns boolean, must be used with "= TRUE" or "= FALSE" in DQL.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
class ST_Covers extends BaseFunction

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
{

            


            
                                                                        
                            
            
                                    
            
            

                
                    24
                

                                    
                             1                         
                
                
                
    protected function customizeFunction(): void

            


            
                                                                        
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    {

            


            
                                                                        
                            
            
                                    
            
            

                
                    26
                

                                    
                             1                         
                
                
                
        $this->setFunctionPrototype('ST_Covers(%s, %s)');

            


            
                                                                        
                            
            
                                    
            
            

                
                    27
                

                                    
                             1                         
                
                
                
        $this->addNodeMapping('StringPrimary');

            


            
                                                                        
                            
            
                                    
            
            

                
                    28
                

                                    
                             1                         
                
                
                
        $this->addNodeMapping('StringPrimary');

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    31