View GitHub Repository sulu-standard

Schedule Inspection
Subscribe
Completed
Pull Request — develop (#675)
by Wachter
05:15 queued 02:53
created

ScaffoldingController::indexAction()   A

↳ Parent: ScaffoldingController

Complexity

Conditions 1
Paths 1

Size

Total Lines 13
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 13
rs 9.4285
cc 1
eloc 8
nc 1
nop 3
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
/*

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                
 * This file is part of Sulu.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
 * (c) MASSIVE ART WebServices GmbH

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
 * This source file is subject to the MIT license that is bundled

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
 * with this source code in the file LICENSE.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
namespace Client\Bundle\WebsiteBundle\Controller;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
use Sulu\Bundle\WebsiteBundle\Controller\WebsiteController;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
use Sulu\Component\Content\Compat\StructureInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
class ScaffoldingController extends WebsiteController

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
    public function indexAction(StructureInterface $structure, $preview = false, $partial = false)

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
        $metadata = $this->get('sulu_document_manager.document_inspector')->getStructureMetadata(

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
            $structure->getDocument()

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface Sulu\Component\Content\Compat\StructureInterface as the method getDocument() does only exist in the following implementations of said interface: Sulu\Component\Content\Compat\Structure\PageBridge, Sulu\Component\Content\C...Structure\SnippetBridge, Sulu\Component\Content\C...ructure\StructureBridge.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
        );

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        return $this->renderStructure(

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
            $structure,

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
            ['metadata' => $metadata],

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
            $preview,

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            $partial

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        );

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    33