CTCPAction - Code Metrics - Buttress/IRC - Measure and Improve Code Quality continuously with Scrutinizer

CTCPAction A
last analyzed 2017-02-27 18:54 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	0
loc	59
rs	10
c	0
b	0
f	0
wmc	9
lcom	1
cbo	5

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	handleMessage()	15	3
B	handleCTCP()	20	5

<?php
/**
 * Created by PhpStorm.
 * User: korvin
 * Date: 11/12/14
 * Time: 6:17 PM
 */

namespace Buttress\IRC\Action;

use Buttress\IRC\Connection\ConnectionInterface;
use Buttress\IRC\Message\GenericMessage;
use Buttress\IRC\Message\MessageInterface;
use Buttress\IRC\Message\PrivmsgMessage;

class CTCPAction extends AbstractAction
{

    protected $version;

    function __construct($version = 'buttress/irc v1.0.0')

    {
        $this->version = $version;
    }

    /**
     * Handle messages
     *
     * @param MessageInterface $message
     * @return void
     */
    public function handleMessage(MessageInterface $message)
    {
        if ($message instanceof PrivmsgMessage) {
            $string = $message->getMessage();
            if (substr($string, 0, 1) === "\001") {
                $string = trim($string, " \001\n\t");

                list($type,) = array_pad(explode(' ', $string, 2), 2, '');
                list($nick, $user, $host) = $message->getUser();

                $message->getConnection()->log("CTCP \"{$type}\" from {$nick}!{$user}@{$host}", array($message));
                $this->handleCTCP($message, $type, $nick);
            }
        }
    }

    /**
     * @param MessageInterface $message
     * @param string           $type
     * @param string           $nick
     */
    protected function handleCTCP($message, $type, $nick)
    {
        $params = array($nick);
        switch ($type) {
            case 'VERSION':
                $params[] = "\001VERSION {$this->version}\001";
                break;
            case 'PING':
                $params[] = $message->getMessage();
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.
    }
}
                break;
            case 'TIME':
                $time = date(DATE_RFC1123);
                $params[] = "\001TIME {$time}\001";
                break;
        }
        if (count($params) > 1) {
            $response = new GenericMessage('notice', '', $params);
            $message->getConnection()->sendMessage($response);
        }
    }

}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: korvin
5			* Date: 11/12/14
6			* Time: 6:17 PM
7			*/
8
9			namespace Buttress\IRC\Action;
10
11			use Buttress\IRC\Connection\ConnectionInterface;
12			use Buttress\IRC\Message\GenericMessage;
13			use Buttress\IRC\Message\MessageInterface;
14			use Buttress\IRC\Message\PrivmsgMessage;
15
16			class CTCPAction extends AbstractAction
17			{
18
19			protected $version;
20
21			function __construct($version = 'buttress/irc v1.0.0')
			0 ignored issues – show Best Practice introduced 2017-02-22 21:07 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
22			{
23			$this->version = $version;
24			}
25
26			/**
27			* Handle messages
28			*
29			* @param MessageInterface $message
30			* @return void
31			*/
32			public function handleMessage(MessageInterface $message)
33			{
34			if ($message instanceof PrivmsgMessage) {
35			$string = $message->getMessage();
36			if (substr($string, 0, 1) === "\001") {
37			$string = trim($string, " \001\n\t");
38
39			list($type,) = array_pad(explode(' ', $string, 2), 2, '');
40			list($nick, $user, $host) = $message->getUser();
41
42			$message->getConnection()->log("CTCP \"{$type}\" from {$nick}!{$user}@{$host}", array($message));
43			$this->handleCTCP($message, $type, $nick);
44			}
45			}
46			}
47
48			/**
49			* @param MessageInterface $message
50			* @param string $type
51			* @param string $nick
52			*/
53			protected function handleCTCP($message, $type, $nick)
54			{
55			$params = array($nick);
56			switch ($type) {
57			case 'VERSION':
58			$params[] = "\001VERSION {$this->version}\001";
59			break;
60			case 'PING':
61			$params[] = $message->getMessage();
			0 ignored issues – show Bug introduced 2017-02-22 21:07 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Buttress\IRC\Message\MessageInterface` as the method `getMessage()` does only exist in the following implementations of said interface: `Buttress\IRC\Message\PrivmsgMessage`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
62			break;
63			case 'TIME':
64			$time = date(DATE_RFC1123);
65			$params[] = "\001TIME {$time}\001";
66			break;
67			}
68			if (count($params) > 1) {
69			$response = new GenericMessage('notice', '', $params);
70			$message->getConnection()->sendMessage($response);
71			}
72			}
73
74			}
75

Buttress / IRC

CTCPAction A last analyzed 2017-02-27 18:54 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

CTCPAction A
last analyzed 2017-02-27 18:54 UTC