View GitHub Repository SyliusShopApiPlugin

Schedule Inspection
Subscribe
Completed
Pull Request — master (#169)
by Łukasz
02:47
created

ProductBreadcrumbGenerator::generate()   A

↳ Parent: ProductBreadcrumbGenerator

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 11
rs 9.4285
cc 2
eloc 5
nc 2
nop 2
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
declare(strict_types = 1);

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
namespace Sylius\ShopApiPlugin\Generator;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
use Sylius\Component\Core\Model\ProductInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
final class ProductBreadcrumbGenerator implements ProductBreadcrumbGeneratorInterface

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    public function generate(ProductInterface $product, string $locale): string

            


            
                                                        
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        $breadcrumb = $product->getTranslation($locale)->getSlug();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface Sylius\Component\Resourc...el\TranslationInterface as the method getSlug() does only exist in the following implementations of said interface: Sylius\Component\Core\Model\ProductTranslation, Sylius\Component\Product\Model\ProductTranslation, Sylius\Component\Taxonomy\Model\TaxonTranslation.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}





In the above example, the authenticate() method works fine as long as you just pass
instances of MyUser. However, if you now also want to pass a different implementation
of User which does not have a getDisplayName() method, the code will break.




Available Fixes


  1. Change the type-hint for the parameter:
    

    class AuthSystem
{
    public function authenticate(MyUser $user) { /* ... */ }
}

    

    

    2. 

  2. Add an additional type-check:
    

    class AuthSystem
{
    public function authenticate(User $user)
    {
        if ($user instanceof MyUser) {
            $this->logger->info(/** ... */);
        }

        // or alternatively
        if ( ! $user instanceof MyUser) {
            throw new \LogicException(
                '$user must be an instance of MyUser, '
               .'other instances are not supported.'
            );
        }

    }
}

    

    

    3. 




 Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.


  1. Add the method to the interface:
    

    interface User
{
    /** @return string */
    public function getPassword();

    /** @return string */
    public function getDisplayName();
}

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
        if (null !== $taxon = $product->getMainTaxon())

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        {

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
            $breadcrumb = sprintf('%s/%s', $taxon->getTranslation($locale)->getSlug(), $breadcrumb);

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        return $breadcrumb;

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    23