CerbereConsoleListener   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 69
Duplicated Lines 11.59 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
dl 8
loc 69
rs 10
c 0
b 0
f 0
wmc 6
lcom 1
cbo 2

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 8 8 2
A getOutput() 0 4 1
A setOutput() 0 4 1
A getSubscribedEvents() 0 6 1
A onCerbereFileDiscovered() 0 4 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
/**
4
 * Drush Cerbere command line tools.
5
 * Copyright (C) 2015 - Sebastien Malot <[email protected]>
6
 *
7
 * This program is free software; you can redistribute it and/or modify
8
 * it under the terms of the GNU General Public License as published by
9
 * the Free Software Foundation; either version 2 of the License, or
10
 * (at your option) any later version.
11
 *
12
 * This program is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 * GNU General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU General Public License along
18
 * with this program; if not, write to the Free Software Foundation, Inc.,
19
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
 */
21
22
namespace Cerbere\Event;
23
24
use Symfony\Component\Console\Output\ConsoleOutput;
25
use Symfony\Component\Console\Output\OutputInterface;
26
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
27
28
/**
29
 * Class CerbereConsoleListener
30
 * @package Cerbere\Event
31
 */
32
class CerbereConsoleListener implements EventSubscriberInterface
33
{
34
    /**
35
     * @var OutputInterface
36
     */
37
    protected $output;
38
39
    /**
40
     * CerbereConsoleListener constructor.
41
     * @param OutputInterface|null $output
42
     */
43 View Code Duplication
    public function __construct(OutputInterface $output = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
44
    {
45
        if (null === $output) {
46
            $output = new ConsoleOutput();
47
        }
48
49
        $this->output = $output;
50
    }
51
52
    /**
53
     * @return OutputInterface
54
     */
55
    public function getOutput()
56
    {
57
        return $this->output;
58
    }
59
60
    /**
61
     * @param OutputInterface $output
62
     */
63
    public function setOutput($output)
64
    {
65
        $this->output = $output;
66
    }
67
68
    /**
69
     * Returns an array of event names this subscriber wants to listen to.
70
     *
71
     * The array keys are event names and the value can be:
72
     *
73
     *  * The method name to call (priority defaults to 0)
74
     *  * An array composed of the method name to call and the priority
75
     *  * An array of arrays composed of the method names to call and respective
76
     *    priorities, or 0 if unset
77
     *
78
     * For instance:
79
     *
80
     *  * array('eventName' => 'methodName')
81
     *  * array('eventName' => array('methodName', $priority))
82
     *  * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
83
     *
84
     * @return array The event names to listen to
85
     */
86
    public static function getSubscribedEvents()
87
    {
88
        return array(
89
          CerbereEvents::CERBERE_FILE_DISCOVERED => array('onCerbereFileDiscovered', 0),
90
        );
91
    }
92
93
    /**
94
     * @param CerbereFileDiscoverEvent $event
95
     */
96
    public function onCerbereFileDiscovered(CerbereFileDiscoverEvent $event)
97
    {
98
        $this->output->getErrorOutput()->writeln($event->getFilename());
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Symfony\Component\Console\Output\OutputInterface as the method getErrorOutput() does only exist in the following implementations of said interface: Psy\Output\ShellOutput, Symfony\Component\Console\Output\ConsoleOutput.

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. 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.'
                );
            }
    
        }
    }
    
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();
    }
    
Loading history...
99
    }
100
}
101