View GitHub Repository NotificationBundle

Schedule Inspection
Subscribe
Completed
Push — master ( cd8958...94944b )
by dan
02:07
created

DatabaseDataFormatter::format()   B

↳ Parent: DatabaseDataFormatter

Complexity

Conditions 1
Paths 1

Size

Total Lines 24
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 24
rs 8.9713
c 0
b 0
f 0
cc 1
eloc 9
nc 1
nop 1
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace IrishDan\NotificationBundle\Formatter;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use IrishDan\NotificationBundle\Notification\NotificationInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
class DatabaseDataFormatter extends BaseFormatter implements MessageFormatterInterface

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
    const CHANNEL = 'database';

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    public function format(NotificationInterface $notification)

            


            
                                                        
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        $notification->setChannel(self::CHANNEL);

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
        parent::format($notification);

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        // /** @var Emailable $notifiable */

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        $notifiable = $notification->getNotifiable();

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        // @TODO:

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
        // if (!$notifiable instanceof Emailable) {

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
            Comprehensibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
54% of this comment could be valid code. Did you maybe forget this after debugging?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have
checked you do not need it.


The code might also have been commented out for debugging purposes. In this case it is vital that
someone uncomments it again or your project may behave in very unexpected ways in production.


This check looks for comments that seem to be mostly valid code and reports them.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        //     throw new MessageFormatException(

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
            Comprehensibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
43% of this comment could be valid code. Did you maybe forget this after debugging?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have
checked you do not need it.


The code might also have been commented out for debugging purposes. In this case it is vital that
someone uncomments it again or your project may behave in very unexpected ways in production.


This check looks for comments that seem to be mostly valid code and reports them.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
        //         'Notifiable must implement Emailable interface in order to format email message'

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
        //     );

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
        // }

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        // Build the dispatch data array.

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        $dispatchData = [

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
            'id' => $notifiable->getId(),

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        ];

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        $messageData = self::createMessagaData($notification->getDataArray());

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
        $message     = self::createMessage($dispatchData, $messageData, self::CHANNEL);

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
        return $message;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The return type of return $message; (IrishDan\NotificationBundle\Message\Message) is incompatible with the return type declared by the interface IrishDan\NotificationBun...matterInterface::format of type Nexmo\Message\MessageInterface.
                                                                                                                                                                                                                                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
If you return a value from a function or method, it should be a sub-type of the
type that is given by the parent type f.e. an interface, or abstract method.
This is more formally defined by the
Lizkov substitution principle,
and guarantees that classes that depend on the parent type can use any instance
of a child type interchangably. This principle also belongs to the
SOLID principles
for object oriented design.


Let’s take a look at an example:


class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}





Our function my_function expects a Post object, and outputs the author
of the post. The base class Post returns a simple string and outputting a
simple string will work just fine. However, the child class BlogPost which
is a sub-type of Post instead decided to return an object, and is
therefore violating the SOLID principles. If a BlogPost were passed to
my_function, PHP would not complain, but ultimately fail when executing the
strtoupper call in its body.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
}