View GitHub Repository formz

Schedule Inspection
Subscribe
Completed
Push — unit-test-form-view-helper ( 21ce8b...04fc41 )
by Romain
04:37
created

AbstractViewHelper::getVariableProvider()   A

↳ Parent: Project

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 7
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 4
nc 2
nop 0
1 
<?php
2 
/*
3 
 * 2017 Romain CANON <[email protected]>
4 
 *
5 
 * This file is part of the TYPO3 Formz project.
6 
 * It is free software; you can redistribute it and/or modify it
7 
 * under the terms of the GNU General Public License, either
8 
 * version 3 of the License, or any later version.
9 
 *
10 
 * For the full copyright and license information, see:
11 
 * http://www.gnu.org/licenses/gpl-3.0.html
12 
 */
13 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
namespace Romm\Formz\ViewHelpers;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
use TYPO3\CMS\Core\Utility\VersionNumberUtility;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
use TYPO3\CMS\Fluid\Core\ViewHelper\TemplateVariableContainer;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
use TYPO3Fluid\Fluid\Core\Variables\VariableProviderInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
abstract class AbstractViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
     * @return VariableProviderInterface|TemplateVariableContainer

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    protected function getVariableProvider()

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
        /** @noinspection PhpUndefinedMethodInspection */

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        return (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '8.0.0', '>='))

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            ? $this->renderingContext->getVariableProvider()

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
            : $this->renderingContext->getTemplateVariableContainer();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface TYPO3Fluid\Fluid\Core\Re...nderingContextInterface as the method getTemplateVariableContainer() does only exist in the following implementations of said interface: TYPO3\CMS\Fluid\Core\Rendering\RenderingContext.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


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

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    33