Channel::getName() - Code Metrics - Inspection of "Added getName() to channels" - beyondcode/laravel-websockets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8a3e89...c85ec3 )

by Alexandru

created 2020-09-19 08:50 UTC

Channel::getName() A

↳ Parent: Channel

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace BeyondCode\LaravelWebSockets\WebSockets\Channels;

use BeyondCode\LaravelWebSockets\Dashboard\DashboardLogger;
use BeyondCode\LaravelWebSockets\WebSockets\Exceptions\InvalidSignature;
use Illuminate\Support\Str;
use Ratchet\ConnectionInterface;
use stdClass;

class Channel
{
    /** @var string */
    protected $channelName;

    /** @var \Ratchet\ConnectionInterface[] */
    protected $subscribedConnections = [];

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

    public function getName(): string
    {
        return $this->channelName;
    }

    public function hasConnections(): bool
    {
        return count($this->subscribedConnections) > 0;
    }

    public function getSubscribedConnections(): array
    {
        return $this->subscribedConnections;
    }

    protected function verifySignature(ConnectionInterface $connection, stdClass $payload)
    {
        $signature = "{$connection->socketId}:{$this->channelName}";
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        if (isset($payload->channel_data)) {
            $signature .= ":{$payload->channel_data}";
        }

        if (Str::after($payload->auth, ':') !== hash_hmac('sha256', $signature, $connection->app->secret)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw new InvalidSignature();
        }
    }

    /*
     * @link https://pusher.com/docs/pusher_protocol#presence-channel-events
     */
    public function subscribe(ConnectionInterface $connection, stdClass $payload)
    {
        $this->saveConnection($connection);

        $connection->send(json_encode([
            'event' => 'pusher_internal:subscription_succeeded',
            'channel' => $this->channelName,
        ]));
    }

    public function unsubscribe(ConnectionInterface $connection)
    {
        unset($this->subscribedConnections[$connection->socketId]);

        if (! $this->hasConnections()) {
            DashboardLogger::vacated($connection, $this->channelName);
        }
    }

    protected function saveConnection(ConnectionInterface $connection)
    {
        $hadConnectionsPreviously = $this->hasConnections();

        $this->subscribedConnections[$connection->socketId] = $connection;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        if (! $hadConnectionsPreviously) {
            DashboardLogger::occupied($connection, $this->channelName);
        }

        DashboardLogger::subscribed($connection, $this->channelName);
    }

    public function broadcast($payload)
    {
        foreach ($this->subscribedConnections as $connection) {
            $connection->send(json_encode($payload));
        }
    }

    public function broadcastToOthers(ConnectionInterface $connection, $payload)
    {
        $this->broadcastToEveryoneExcept($payload, $connection->socketId);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    public function broadcastToEveryoneExcept($payload, ?string $socketId = null)
    {
        if (is_null($socketId)) {
            return $this->broadcast($payload);
        }

        foreach ($this->subscribedConnections as $connection) {
            if ($connection->socketId !== $socketId) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                $connection->send(json_encode($payload));
            }
        }
    }

    public function toArray(): array
    {
        return [
            'occupied' => count($this->subscribedConnections) > 0,
            'subscription_count' => count($this->subscribedConnections),
        ];
    }
}


1			<?php
2
3			namespace BeyondCode\LaravelWebSockets\WebSockets\Channels;
4
5			use BeyondCode\LaravelWebSockets\Dashboard\DashboardLogger;
6			use BeyondCode\LaravelWebSockets\WebSockets\Exceptions\InvalidSignature;
7			use Illuminate\Support\Str;
8			use Ratchet\ConnectionInterface;
9			use stdClass;
10
11			class Channel
12			{
13			/** @var string */
14			protected $channelName;
15
16			/** @var \Ratchet\ConnectionInterface[] */
17			protected $subscribedConnections = [];
18
19			public function __construct(string $channelName)
20			{
21			$this->channelName = $channelName;
22			}
23
24			public function getName(): string
25			{
26			return $this->channelName;
27			}
28
29			public function hasConnections(): bool
30			{
31			return count($this->subscribedConnections) > 0;
32			}
33
34			public function getSubscribedConnections(): array
35			{
36			return $this->subscribedConnections;
37			}
38
39			protected function verifySignature(ConnectionInterface $connection, stdClass $payload)
40			{
41			$signature = "{$connection->socketId}:{$this->channelName}";
			0 ignored issues – show Bug introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report Accessing `socketId` on the interface `Ratchet\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
42
43			if (isset($payload->channel_data)) {
44			$signature .= ":{$payload->channel_data}";
45			}
46
47			if (Str::after($payload->auth, ':') !== hash_hmac('sha256', $signature, $connection->app->secret)) {
			0 ignored issues – show Bug introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report Accessing `app` on the interface `Ratchet\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
48			throw new InvalidSignature();
49			}
50			}
51
52			/*
53			* @link https://pusher.com/docs/pusher_protocol#presence-channel-events
54			*/
55			public function subscribe(ConnectionInterface $connection, stdClass $payload)
56			{
57			$this->saveConnection($connection);
58
59			$connection->send(json_encode([
60			'event' => 'pusher_internal:subscription_succeeded',
61			'channel' => $this->channelName,
62			]));
63			}
64
65			public function unsubscribe(ConnectionInterface $connection)
66			{
67			unset($this->subscribedConnections[$connection->socketId]);
68
69			if (! $this->hasConnections()) {
70			DashboardLogger::vacated($connection, $this->channelName);
71			}
72			}
73
74			protected function saveConnection(ConnectionInterface $connection)
75			{
76			$hadConnectionsPreviously = $this->hasConnections();
77
78			$this->subscribedConnections[$connection->socketId] = $connection;
			0 ignored issues – show Bug introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report Accessing `socketId` on the interface `Ratchet\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
79
80			if (! $hadConnectionsPreviously) {
81			DashboardLogger::occupied($connection, $this->channelName);
82			}
83
84			DashboardLogger::subscribed($connection, $this->channelName);
85			}
86
87			public function broadcast($payload)
88			{
89			foreach ($this->subscribedConnections as $connection) {
90			$connection->send(json_encode($payload));
91			}
92			}
93
94			public function broadcastToOthers(ConnectionInterface $connection, $payload)
95			{
96			$this->broadcastToEveryoneExcept($payload, $connection->socketId);
			0 ignored issues – show Bug introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report Accessing `socketId` on the interface `Ratchet\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
97			}
98
99			public function broadcastToEveryoneExcept($payload, ?string $socketId = null)
100			{
101			if (is_null($socketId)) {
102			return $this->broadcast($payload);
103			}
104
105			foreach ($this->subscribedConnections as $connection) {
106			if ($connection->socketId !== $socketId) {
			0 ignored issues – show Bug introduced 2018-12-04 21:28 UTC by Report Bug Copy Issue Report Accessing `socketId` on the interface `Ratchet\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
107			$connection->send(json_encode($payload));
108			}
109			}
110			}
111
112			public function toArray(): array
113			{
114			return [
115			'occupied' => count($this->subscribedConnections) > 0,
116			'subscription_count' => count($this->subscribedConnections),
117			];
118			}
119			}
120

beyondcode / laravel-websockets

Push — master ( 8a3e89...c85ec3 )

Channel::getName() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like