Receiver::mainRoutes() - Code Metrics - Inspection of "1- change validation to laravel validation" - mshamaseen/laravel-ratchet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6ac744...48d05f )

by Mohammad

created 2019-03-26 13:32 UTC

Receiver::mainRoutes() A

↳ Parent: Receiver

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/** @noinspection PhpUndefinedFieldInspection */

/**
 * Created by PhpStorm.
 * User: shanmaseen
 * Date: 23/03/19
 * Time: 07:40 م
 */

namespace Shamaseen\Laravel\Ratchet;

use Illuminate\Validation\ValidationException;
use Shamaseen\Laravel\Ratchet\Exceptions\WebSocketException;
use Shamaseen\Laravel\Ratchet\Facades\WsRoute;
use Shamaseen\Laravel\Ratchet\Objects\Clients\Client;
use Ratchet\ConnectionInterface;
use Ratchet\MessageComponentInterface;
use Shamaseen\Laravel\Ratchet\Traits\WebSocketMessagesManager;

/**
 * Class WebSocket
 * @package App\WebSockets
 */
class Receiver implements MessageComponentInterface
{
    use WebSocketMessagesManager;

    /**
     * @var Client[]
     */
    public $clients;
    private $routes;
    public $userAuthSocketMapper;
    public $rooms = [];

    /**
     * WebSocket constructor.
     */
    public function __construct()
    {
        $this->clients = [];
        /**
         * The key will be auth id, the value will be resourceId
         */
        $this->userAuthSocketMapper = [];

        $this->mainRoutes();
        include base_path().'/routes/websocket.php';
        $this->routes = WsRoute::getRoutes();
    }

    /**
     * @param ConnectionInterface $conn
     */
    public function onOpen(ConnectionInterface $conn) {

        $this->clients[$conn->resourceId] = new Client();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $this->clients[$conn->resourceId]->conn = $conn;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
//        $this->clients[$conn->resourceId]->resourceId = $conn->resourceId;

        echo "New connection! ({$conn->resourceId})\n";
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

    /**
     * @param ConnectionInterface $from
     * @param string $msg
     * @throws \Exception
     */
    public function onMessage(ConnectionInterface $from, $msg) {
        try

        {
            $msg = json_decode($msg);

            $this->checkForRequiredInMessage($msg,$from);

            \Session::setId($msg->session);

            \Session::start();

            $route = $this->routes[$msg->route];
            if($route->auth && !\Auth::check())

                $this->error($msg,$from,'Unauthenticated.');
            else

                $this->userAuthSocketMapper[\Auth::id()] = $from->resourceId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

            $class = $route->controller;
            $method = $route->method;
            $controller = new $class;

            $this->cloneProperties($this,$controller);

            $controller->conn = $from;
            $controller->receiver = $this;
            $controller->request = $msg;
            $controller->route = $route;

            if(!method_exists($controller,$method))

            {
                $this->error($msg,$from,'Method doesnt\'t exist !');
            }

            $controller->$method();
        }
        catch (WebSocketException $exception)

        {


        }
        catch(ValidationException $exception)

        {
            $this->sendToWebSocketUser($from,[
                'message'=>$exception->getMessage(),
                'errors'=> $exception->errors()
            ]);
        }
    }

    /**
     * @param ConnectionInterface $conn
     */
    public function onClose(ConnectionInterface $conn) {
        // The connection is closed, remove it, as we can no longer send it messages
        unset($this->clients[$conn->resourceId]);

        echo "Connection {$conn->resourceId} has disconnected\n";
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

    /**
     * @param ConnectionInterface $conn
     * @param \Exception $e
     */
    public function onError(ConnectionInterface $conn, \Exception $e) {

        echo "An error has occurred: {$e->getMessage()}\n";
        echo "In {$e->getFile()} line {$e->getLine()}\n";

        $conn->close();
        echo 'end';
        die;

    }

    /**
     * @param $msg
     * @param $from
     * @throws WebSocketException
     */
    function checkForRequiredInMessage($msg,$from)

    {
        if(!isset($msg->route) || !isset($msg->session))

        {
            $this->error($msg,$from,'You can\'t send a request without the route and the session id !');
        }

        if(!isset($this->routes[$msg->route]))

            $this->error($msg,$from,'No such route !');
    }

    /**
     * @param $clonedObject
     * @param $clone
     */
    function cloneProperties($clonedObject, $clone)

    {
        foreach (get_object_vars($clonedObject) as $key => $value) {
            $clone->$key = $value;
        }
    }

    function mainRoutes()

    {
        WsRoute::make('initializeWebsocket','Shamaseen\Laravel\Ratchet\Controllers\InitializeController','index');
        WsRoute::make('room-enter','Shamaseen\Laravel\Ratchet\Controllers\RoomController','enterRoom');
        WsRoute::make('room-exit','Shamaseen\Laravel\Ratchet\Controllers\RoomController','exitRoom');
        WsRoute::make('send-to-user','Shamaseen\Laravel\Ratchet\Controllers\ChatController','sendMessageToUser');
        WsRoute::make('send-to-room','Shamaseen\Laravel\Ratchet\Controllers\ChatController','sendMessageToRoom');
    }
}

1			<?php
2			/** @noinspection PhpUndefinedFieldInspection */
3
4			/**
5			* Created by PhpStorm.
6			* User: shanmaseen
7			* Date: 23/03/19
8			* Time: 07:40 م
9			*/
10
11			namespace Shamaseen\Laravel\Ratchet;
12
13			use Illuminate\Validation\ValidationException;
14			use Shamaseen\Laravel\Ratchet\Exceptions\WebSocketException;
15			use Shamaseen\Laravel\Ratchet\Facades\WsRoute;
16			use Shamaseen\Laravel\Ratchet\Objects\Clients\Client;
17			use Ratchet\ConnectionInterface;
18			use Ratchet\MessageComponentInterface;
19			use Shamaseen\Laravel\Ratchet\Traits\WebSocketMessagesManager;
20
21			/**
22			* Class WebSocket
23			* @package App\WebSockets
24			*/
25			class Receiver implements MessageComponentInterface
26			{
27			use WebSocketMessagesManager;
28
29			/**
30			* @var Client[]
31			*/
32			public $clients;
33			private $routes;
34			public $userAuthSocketMapper;
35			public $rooms = [];
36
37			/**
38			* WebSocket constructor.
39			*/
40			public function __construct()
41			{
42			$this->clients = [];
43			/**
44			* The key will be auth id, the value will be resourceId
45			*/
46			$this->userAuthSocketMapper = [];
47
48			$this->mainRoutes();
49			include base_path().'/routes/websocket.php';
50			$this->routes = WsRoute::getRoutes();
51			}
52
53			/**
54			* @param ConnectionInterface $conn
55			*/
56			public function onOpen(ConnectionInterface $conn) {
57
58			$this->clients[$conn->resourceId] = new Client();
			0 ignored issues – show Bug introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Accessing `resourceId` 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...
59			$this->clients[$conn->resourceId]->conn = $conn;
			0 ignored issues – show Bug introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Accessing `resourceId` 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...
60			// $this->clients[$conn->resourceId]->resourceId = $conn->resourceId;
61
62			echo "New connection! ({$conn->resourceId})\n";
			0 ignored issues – show Bug introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Accessing `resourceId` 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...
63			}
64
65			/**
66			* @param ConnectionInterface $from
67			* @param string $msg
68			* @throws \Exception
69			*/
70			public function onMessage(ConnectionInterface $from, $msg) {
71			try
			0 ignored issues – show Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space(s) after TRY keyword; newline found Loading history...
72			{
73			$msg = json_decode($msg);
74
75			$this->checkForRequiredInMessage($msg,$from);
76
77			\Session::setId($msg->session);
78
79			\Session::start();
80
81			$route = $this->routes[$msg->route];
82			if($route->auth && !\Auth::check())
			0 ignored issues – show Coding Style introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report Expected 1 space(s) after IF keyword; 0 found Loading history...
83			$this->error($msg,$from,'Unauthenticated.');
84			else
			0 ignored issues – show Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space(s) after ELSE keyword; newline found Loading history...
85			$this->userAuthSocketMapper[\Auth::id()] = $from->resourceId;
			0 ignored issues – show Bug introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Accessing `resourceId` 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...
86
87			$class = $route->controller;
88			$method = $route->method;
89			$controller = new $class;
90
91			$this->cloneProperties($this,$controller);
92
93			$controller->conn = $from;
94			$controller->receiver = $this;
95			$controller->request = $msg;
96			$controller->route = $route;
97
98			if(!method_exists($controller,$method))
			0 ignored issues – show Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space(s) after IF keyword; 0 found Loading history...
99			{
100			$this->error($msg,$from,'Method doesnt\'t exist !');
101			}
102
103			$controller->$method();
104			}
105			catch (WebSocketException $exception)
			0 ignored issues – show Coding Style Comprehensibility introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
106			{
			0 ignored issues – show Coding Style introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
107
108			}
109			catch(ValidationException $exception)
			0 ignored issues – show Coding Style introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report Expected 1 space(s) after CATCH keyword; 0 found Loading history... Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The class `Illuminate\Validation\ValidationException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
110			{
111			$this->sendToWebSocketUser($from,[
112			'message'=>$exception->getMessage(),
113			'errors'=> $exception->errors()
114			]);
115			}
116			}
117
118			/**
119			* @param ConnectionInterface $conn
120			*/
121			public function onClose(ConnectionInterface $conn) {
122			// The connection is closed, remove it, as we can no longer send it messages
123			unset($this->clients[$conn->resourceId]);
124
125			echo "Connection {$conn->resourceId} has disconnected\n";
			0 ignored issues – show Bug introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Accessing `resourceId` 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...
126			}
127
128			/**
129			* @param ConnectionInterface $conn
130			* @param \Exception $e
131			*/
132			public function onError(ConnectionInterface $conn, \Exception $e) {
			0 ignored issues – show Comprehensibility introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report Avoid variables with short names like $e. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
133			echo "An error has occurred: {$e->getMessage()}\n";
134			echo "In {$e->getFile()} line {$e->getLine()}\n";
135
136			$conn->close();
137			echo 'end';
138			die;
			0 ignored issues – show Coding Style Compatibility introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The method `onError()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
139			}
140
141			/**
142			* @param $msg
143			* @param $from
144			* @throws WebSocketException
145			*/
146			function checkForRequiredInMessage($msg,$from)
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `checkForRequiredInMessage`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history... Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space between comma and argument "$from"; 0 found Loading history... Best Practice introduced 2019-03-26 08:17 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...
147			{
148			if(!isset($msg->route) \|\| !isset($msg->session))
			0 ignored issues – show Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space(s) after IF keyword; 0 found Loading history...
149			{
150			$this->error($msg,$from,'You can\'t send a request without the route and the session id !');
151			}
152
153			if(!isset($this->routes[$msg->route]))
			0 ignored issues – show Coding Style introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report Expected 1 space(s) after IF keyword; 0 found Loading history...
154			$this->error($msg,$from,'No such route !');
155			}
156
157			/**
158			* @param $clonedObject
159			* @param $clone
160			*/
161			function cloneProperties($clonedObject, $clone)
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-03-26 08:17 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `cloneProperties`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history... Best Practice introduced 2019-03-26 08:17 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...
162			{
163			foreach (get_object_vars($clonedObject) as $key => $value) {
164			$clone->$key = $value;
165			}
166			}
167
168			function mainRoutes()
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `mainRoutes`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history... Best Practice introduced 2019-03-26 08:17 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...
169			{
170			WsRoute::make('initializeWebsocket','Shamaseen\Laravel\Ratchet\Controllers\InitializeController','index');
171			WsRoute::make('room-enter','Shamaseen\Laravel\Ratchet\Controllers\RoomController','enterRoom');
172			WsRoute::make('room-exit','Shamaseen\Laravel\Ratchet\Controllers\RoomController','exitRoom');
173			WsRoute::make('send-to-user','Shamaseen\Laravel\Ratchet\Controllers\ChatController','sendMessageToUser');
174			WsRoute::make('send-to-room','Shamaseen\Laravel\Ratchet\Controllers\ChatController','sendMessageToRoom');
175			}
176			}

mshamaseen / laravel-ratchet

Push — master ( 6ac744...48d05f )

Receiver::mainRoutes() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like