View GitHub Repository hiapi

Schedule Inspection
Subscribe
Completed
Push — master ( 932cc5...b796f0 )
by Andrii
12:16
created

GetInfoHandler::buildSpecification()   A

↳ Parent: GetInfoHandler

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
rs 10
cc 1
eloc 2
nc 1
nop 1
1 
<?php
2 
/**
3 
 * HiAPI Yii2 base project for building API
4 
 *
5 
 * @link      https://github.com/hiqdev/hiapi
6 
 * @package   hiapi
7 
 * @license   BSD-3-Clause
8 
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
9 
 */
10 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
namespace hiapi\commands;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
use hiqdev\yii\DataMapper\components\EntityManagerInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
use hiqdev\yii\DataMapper\query\Specification;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
use hiqdev\yii\DataMapper\repositories\BaseRepository;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
 * Class GetInfoHandler

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
 * @author Andrii Vasyliev <[email protected]>

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
class GetInfoHandler extends SearchHandler

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
    public function handle(EntityCommandInterface $command)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        return $this->getRepository($command)->findOneOrFail($this->buildSpecification($command));

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                                                                        
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Compatibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
$command of type object<hiapi\commands\EntityCommandInterface> is not a sub-type of object<hiapi\commands\EntityCommand>. It seems like you assume a concrete implementation of the interface hiapi\commands\EntityCommandInterface to be always present.
                                                                                                                                                                                                                                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for parameters that are defined as one type in their type
hint or doc comment but seem to be used as a narrower type, i.e an
implementation of an interface or a subclass.


Consider changing the type of the parameter or doing an instanceof check before assuming
your parameter is of the expected type.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                            




    

        
            Bug
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The return type of return $this->getReposit...ecification($command)); (false|object) is incompatible with the return type of the parent method hiapi\commands\SearchHandler::handle of type object[].
                                                                                                                                                                                                                                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
If you return a value from a function or method, it should be a sub-type of the
type that is given by the parent type f.e. an interface, or abstract method.
This is more formally defined by the
Lizkov substitution principle,
and guarantees that classes that depend on the parent type can use any instance
of a child type interchangably. This principle also belongs to the
SOLID principles
for object oriented design.


Let’s take a look at an example:


class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}





Our function my_function expects a Post object, and outputs the author
of the post. The base class Post returns a simple string and outputting a
simple string will work just fine. However, the child class BlogPost which
is a sub-type of Post instead decided to return an object, and is
therefore violating the SOLID principles. If a BlogPost were passed to
my_function, PHP would not complain, but ultimately fail when executing the
strtoupper call in its body.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
    protected function buildSpecification(EntityCommandInterface $command)

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
        return $this->createSpecification()->where(['id' => $command->id])->limit(1);

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
Accessing id on the interface hiapi\commands\EntityCommandInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
If you access a property on an interface, you most likely code against a
concrete implementation of the interface.




Available Fixes


  1. Adding an additional type check:
    

    interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

    

    

    2. 

  2. Changing the type hint:
    

    interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeClass $object) {
    $a = $object->a;
}

    

    

    3. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    34