View GitHub Repository mqueue

Schedule Inspection
Subscribe
Completed
Push — master ( ca1336...ce2897 )
by Adrien
07:43
created

CacheStamp::cacheStamp()   A

↳ Parent: CacheStamp

Complexity

Conditions 3
Paths 4

Size

Total Lines 14
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 3.0261

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 3
eloc 7
c 1
b 0
f 0
nc 4
nop 1
dl 0
loc 14
ccs 6
cts 7
cp 0.8571
crap 3.0261
rs 9.4285
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace mQueue\View\Helper;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use Zend_View_Helper_Abstract;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
class CacheStamp extends Zend_View_Helper_Abstract

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
     * Inject the last modified time of file.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
     * This avoid browser cache and force reloading when the file changed.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
     * @param string $fileName

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
     * @return string

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                             13                         
                
                
                
    public function cacheStamp($fileName)

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Coding Style
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                        

                                        
Please use __construct() instead of a PHP4-style constructor that is named after the class.
                                            

                    
                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        // In developent, use non minified version

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                             13                         
                
                
                
        if (APPLICATION_ENV == 'development') {

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
            $fileName = str_replace('/js/min/', '/js/', $fileName);

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                             13                         
                
                
                
        $fullPath = APPLICATION_PATH . '/../public/' . $fileName;

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                             13                         
                
                
                
        if (is_file($fullPath)) {

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                             13                         
                
                
                
            $fileName = $this->view->serverUrl() . $this->view->baseUrl($fileName) . '?' . filemtime($fullPath);

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                                                                        
                        

                            
                            
2 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface Zend_View_Interface as the method serverUrl() does only exist in the following implementations of said interface: Zend_View.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


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

                    


    




                                                                                            




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface Zend_View_Interface as the method baseUrl() does only exist in the following implementations of said interface: Zend_View.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


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

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                             13                         
                
                
                
        return $fileName;

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    30