View GitHub Repository hipanel-core

Schedule Inspection
Subscribe
Completed
Push — master ( 8b5039...b64488 )
by Andrii
11:08
created

HookTrait::registerJsHook()   A

↳ Parent: HookTrait

Complexity

Conditions 1
Paths 1

Size

Total Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 15
rs 9.7666
c 0
b 0
f 0
cc 1
nc 1
nop 1
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace hipanel\widgets;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use hipanel\actions\Action;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
use yii\web\View;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
trait HookTrait

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    public function registerJsHook(string $reqHeaderParamName): void

            


            
                                                        
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        $id = $this->getId();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like getId() must be provided by classes using this trait. How about adding it as abstract method to this trait?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for methods that are used by a trait but not required by it.


To illustrate, let’s look at the following code example


trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}





The trait Idable provides a method equalsId that in turn relies on the
method getId(). If this method does not exist on a class mixing in this
trait, the method will fail.


Adding the getId() as an abstract method to the trait will make sure it
is available.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        $headerName = Action::EXPECTED_AJAX_RESPONSE_HEADER_NAME;

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
        $this->view->registerJs("$.ajax({

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The property view does not exist. Did you maybe forget to declare it?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
In PHP it is possible to write to properties without declaring them. For example,
the following is perfectly valid PHP code:


class MyClass { }

$x = new MyClass();
$x->foo = true;





Generally, it is a good practice to explictly declare properties to avoid
accidental typos and provide IDE auto-completion:


class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;





                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
           type: 'GET',

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
           url: document.URL,

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
           beforeSend: xhr => {

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
             xhr.setRequestHeader('{$headerName}', '{$reqHeaderParamName}');

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
           },

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
           success: html => {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
             $('#{$id}').html(html);

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
           }

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
        });", View::POS_LOAD);

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    26