RoomUtility::sendToRoom() - 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

RoomUtility::sendToRoom() A

↳ Parent: RoomUtility

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	3
nc	4
nop	2

<?php
/**
 * Created by PhpStorm.
 * User: shanmaseen
 * Date: 26/03/19
 * Time: 12:09 م
 */

namespace Shamaseen\Laravel\Ratchet\Traits;
use Shamaseen\Laravel\Ratchet\Objects\Rooms\Room;


trait RoomUtility
{
    function addMember($room_id)

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $room->addMember($client);
    }

    /**
     * This function will automatically remove the room if no member still on it.
     * @param $room_id
     */
    function removeMember($room_id)

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
        $client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
        $room->removeMember($client);

        if(count($room->members) == 0)
        {
            unset($this->receiver->rooms[$room_id]);
        }

    }

    /**
     * @param $room_id
     * @return bool
     */
    function hasMember($room_id)

    {
        /** @var Room $room */
        $room = $this->receiver->rooms[$room_id];
        $client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
        return $room->hasMember($client);
    }

    /**
     * @param $room_id
     * @param bool $createIfNotExist
     * @return Room
     */
    function validateRoom($room_id,$createIfNotExist = false)

    {
        if(!array_key_exists($room_id,$this->receiver->rooms))
        {
            if($createIfNotExist)
            {
                $room = $this->receiver->rooms[$room_id] = new Room($room_id);
                return $room;
            }
            $this->error($this->request,$this->conn,'Room is not exist');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
    }

    /**
     * @param $room_id
     * @param $message
     */
    function sendToRoom($room_id, $message)

    {
        $this->validateRoom($room_id);
        /** @var Room $room */
        $room = $this->rooms[$room_id];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
        if(!$this->hasMember($client))
            $this->error($this->request,$this->conn,'You can\'t send a message to room which you are not in !');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($room->members as $member)
        {
            $this->sendToUser($member->id,$message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }
}

1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: shanmaseen
5			* Date: 26/03/19
6			* Time: 12:09 م
7			*/
8
9			namespace Shamaseen\Laravel\Ratchet\Traits;
10			use Shamaseen\Laravel\Ratchet\Objects\Rooms\Room;
11
12
13			trait RoomUtility
14			{
15			function addMember($room_id)
			0 ignored issues – show Best Practice introduced 2019-03-26 13:40 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... Coding Style Naming introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The variable $room_id is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
16			{
17			/** @var Room $room */
18			$room = $this->receiver->rooms[$room_id];
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `receiver` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
19			$client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `clients` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `userAuthSocketMapper` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
20			$room->addMember($client);
21			}
22
23			/**
24			* This function will automatically remove the room if no member still on it.
25			* @param $room_id
26			*/
27			function removeMember($room_id)
			0 ignored issues – show Best Practice introduced 2019-03-26 13:40 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... Coding Style Naming introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The variable $room_id is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
28			{
29			/** @var Room $room */
30			$room = $this->receiver->rooms[$room_id];
31			$client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
32			$room->removeMember($client);
33
34			if(count($room->members) == 0)
35			{
36			unset($this->receiver->rooms[$room_id]);
37			}
38
39			}
40
41			/**
42			* @param $room_id
43			* @return bool
44			*/
45			function hasMember($room_id)
			0 ignored issues – show Best Practice introduced 2019-03-26 13:40 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... Coding Style Naming introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The variable $room_id is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
46			{
47			/** @var Room $room */
48			$room = $this->receiver->rooms[$room_id];
49			$client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
50			return $room->hasMember($client);
51			}
52
53			/**
54			* @param $room_id
55			* @param bool $createIfNotExist
56			* @return Room
57			*/
58			function validateRoom($room_id,$createIfNotExist = false)
			0 ignored issues – show Best Practice introduced 2019-03-26 13:40 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... Coding Style Naming introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The variable $room_id is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
59			{
60			if(!array_key_exists($room_id,$this->receiver->rooms))
61			{
62			if($createIfNotExist)
63			{
64			$room = $this->receiver->rooms[$room_id] = new Room($room_id);
65			return $room;
66			}
67			$this->error($this->request,$this->conn,'Room is not exist');
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `conn` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report It seems like `error()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
68			}
69			}
70
71			/**
72			* @param $room_id
73			* @param $message
74			*/
75			function sendToRoom($room_id, $message)
			0 ignored issues – show Best Practice introduced 2019-03-26 13:40 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... Coding Style Naming introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The variable $room_id is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
76			{
77			$this->validateRoom($room_id);
78			/** @var Room $room */
79			$room = $this->rooms[$room_id];
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report The property `rooms` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
80			$client = $this->clients[$this->userAuthSocketMapper[\Auth::id()]];
81			if(!$this->hasMember($client))
82			$this->error($this->request,$this->conn,'You can\'t send a message to room which you are not in !');
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report It seems like `error()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
83
84			foreach ($room->members as $member)
85			{
86			$this->sendToUser($member->id,$message);
			0 ignored issues – show Bug introduced 2019-03-26 13:40 UTC by Report Bug Copy Issue Report It seems like `sendToUser()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
87			}
88			}
89			}

mshamaseen / laravel-ratchet

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

RoomUtility::sendToRoom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like