View GitHub Repository composite-utils

Schedule Inspection
Subscribe

Equatable
last analyzed

↳ Parent: Project

Size/Duplication

Total Lines 10
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
dl 0
loc 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
equals() 0 1 ?
1 
<?php
2 
/**
3 
 * This file is part of the Composite Utils package.
4 
 *
5 
 * (c) Emily Shepherd <[email protected]>
6 
 *
7 
 * For the full copyright and license information, please view the
8 
 * LICENSE.md file that was distributed with this source code.
9 
 *
10 
 * @package spaark/composite-utils
11 
 * @author Emily Shepherd <[email protected]>
12 
 * @license MIT
13 
 */
14 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
namespace Spaark\CompositeUtils\Model\Common;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
 * Classes implementing this class can compare themselves to another to

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
 * determine equality

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
 * @generic Type

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
 */

            


            
                                                                        
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
interface Equatable

            


            
                                                                        
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
{

            


            
                                                                        
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                        
                            
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
     * Checks if the given class is equal to this one

            


            
                                                                        
                            
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
     *

            


            
                                                                        
                            
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
     * @param Type $oject

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Documentation
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
There is no parameter named $oject. Did you maybe mean $object?
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for PHPDoc comments describing methods or function parameters that
do not exist on the corresponding method or function. It has, however, found a
similar but not annotated parameter which might be a good fit.


Consider the following example. The parameter $ireland is not defined by
the method finale(...).


/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}





The most likely cause is that the parameter was changed, but the annotation was not.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                        
                            
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
     * @return boolean

            


            
                                                                        
                            
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
     */

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
    public function equals($object) : bool;

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    33