RedisRoom::add() - Code Metrics - Inspection of "Update RedisRoom.php" - swooletw/laravel-swoole - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#378)

by Bill

created 2020-02-14 15:59 UTC

RedisRoom::add() A

↳ Parent: RedisRoom

Complexity

Conditions	3
Paths	4

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	3
eloc	4
c	2
b	0
f	1
nc	4
nop	2
dl	0
loc	8
rs	10

<?php

namespace SwooleTW\Http\Websocket\Rooms;

use Illuminate\Support\Arr;
use Illuminate\Contracts\Redis\Factory as RedisFactory;

/**
 * Class RedisRoom
 */
class RedisRoom implements RoomContract
{
	/**
     * The Redis factory implementation.
     *
     * @var \Illuminate\Contracts\Redis\Factory
     */
    public $redis;

	/**
	 * @var array
	 */
	protected $config;

	/**
	 * RedisRoom constructor.
	 *
	 * @param array $config
	 */
	public function __construct(array $config, RedisFactory $redis)
	{
		$this->config = $config;
		$this->redis = $redis;
	}

	/**
	 * @param \Illuminate\Contracts\Redis\Factory|null $redis
	 *
	 * @return \Ofcold\HttpSwoole\Websocket\Rooms\RoomContract
filter:
    dependency_paths: ["lib/*"]
	 */
	public function prepare(RedisFactory $redis = null): RoomContract
	{
		$this->cleanRooms();

		return $this;

	}

	/**
	 * Get redis client.
	 */
	public function getRedis()
	{
		return $this->connection();
	}

	/**
	 * Add multiple socket fds to a room.
	 *
	 * @param int fd
filter:
    dependency_paths: ["lib/*"]
	 * @param array|string rooms
filter:
    dependency_paths: ["lib/*"]
	 */
	public function add(int $fd, $rooms)
	{
		$rooms = is_array($rooms) ? $rooms : [$rooms];

		$this->addValue($fd, $rooms, RoomContract::DESCRIPTORS_KEY);

		foreach ($rooms as $room) {
			$this->addValue($room, [$fd], RoomContract::ROOMS_KEY);
		}
	}

	/**
	 * Delete multiple socket fds from a room.
	 *
	 * @param int fd
	 * @param array|string rooms
	 */
	public function delete(int $fd, $rooms)
	{
		$rooms = is_array($rooms) ? $rooms : [$rooms];
		$rooms = count($rooms) ? $rooms : $this->getRooms($fd);

		$this->removeValue($fd, $rooms, RoomContract::DESCRIPTORS_KEY);

		foreach ($rooms as $room) {
			$this->removeValue($room, [$fd], RoomContract::ROOMS_KEY);
		}
	}

	/**
	 * Add value to redis.
	 *
	 * @param $key
	 * @param array $values
	 * @param string $table
	 *
	 * @return $this
	 */
	public function addValue($key, array $values, string $table)
	{
		$this->checkTable($table);
		$redisKey = $this->getKey($key, $table);

		$this->connection()->pipeline(function ($pipe) use ($redisKey, $values) {
			foreach ($values as $value) {
				$pipe->sadd($redisKey, $value);
			}
		});

		return $this;
	}

	/**
	 * Remove value from reddis.
	 *
	 * @param $key
	 * @param array $values
	 * @param string $table
	 *
	 * @return $this
	 */
	public function removeValue($key, array $values, string $table)
	{
		$this->checkTable($table);
		$redisKey = $this->getKey($key, $table);

		$this->connection()->pipeline(function ($pipe) use ($redisKey, $values) {
			foreach ($values as $value) {
				$pipe->srem($redisKey, $value);
			}
		});

		return $this;
	}

	/**
	 * Get all sockets by a room key.
	 *
	 * @param string room
	 *
	 * @return array
	 */
	public function getClients(string $room)
	{
		return $this->getValue($room, RoomContract::ROOMS_KEY) ?? [];
	}

	/**
	 * Get all rooms by a fd.
	 *
	 * @param int fd
	 *
	 * @return array
	 */
	public function getRooms(int $fd)
	{
		return $this->getValue($fd, RoomContract::DESCRIPTORS_KEY) ?? [];
	}

	/**
	 * Check table for rooms and descriptors.
	 *
	 * @param string $table
	 */
	protected function checkTable(string $table)
	{
		if (! in_array($table, [RoomContract::ROOMS_KEY, RoomContract::DESCRIPTORS_KEY])) {
			throw new \InvalidArgumentException("Invalid table name: `{$table}`.");
		}
	}

	/**
	 * Get value.
	 *
	 * @param string $key
	 * @param string $table
	 *
	 * @return array
	 */
	public function getValue(string $key, string $table)
	{
		$this->checkTable($table);

		$result = $this->connection()->smembers($this->getKey($key, $table));

		// Try to fix occasional non-array returned result
		return is_array($result) ? $result : [];
	}

	/**
	 * Get key.
	 *
	 * @param string $key
	 * @param string $table
	 *
	 * @return string
	 */
	public function getKey(string $key, string $table)
	{
		return "{$table}:{$key}";
	}

	/**
	 * Clean all rooms.
	 */
	protected function cleanRooms(): void
	{
		if (count($keys = $this->connection()->keys("*"))) {
			$this->connection()->del($keys);
		}
	}

	/**
	 * Get the Redis connection instance.
	 *
	 * @return \Illuminate\Redis\Connections\Connection
filter:
    dependency_paths: ["lib/*"]
	 */
	public function connection()
	{
		return $this->redis->connection('swoole');
	}
}


1			<?php
2
3			namespace SwooleTW\Http\Websocket\Rooms;
4
5			use Illuminate\Support\Arr;
6			use Illuminate\Contracts\Redis\Factory as RedisFactory;
7
8			/**
9			* Class RedisRoom
10			*/
11			class RedisRoom implements RoomContract
12			{
13			/**
14			* The Redis factory implementation.
15			*
16			* @var \Illuminate\Contracts\Redis\Factory
17			*/
18			public $redis;
19
20			/**
21			* @var array
22			*/
23			protected $config;
24
25			/**
26			* RedisRoom constructor.
27			*
28			* @param array $config
29			*/
30			public function __construct(array $config, RedisFactory $redis)
31			{
32			$this->config = $config;
33			$this->redis = $redis;
34			}
35
36			/**
37			* @param \Illuminate\Contracts\Redis\Factory\|null $redis
38			*
39			* @return \Ofcold\HttpSwoole\Websocket\Rooms\RoomContract
			0 ignored issues – show Bug introduced 2020-02-14 16:07 UTC by Report Bug Copy Issue Report The type `Ofcold\HttpSwoole\Websocket\Rooms\RoomContract` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
40			*/
41			public function prepare(RedisFactory $redis = null): RoomContract
42			{
43			$this->cleanRooms();
44
45			return $this;
			0 ignored issues – show Bug Best Practice introduced 2020-02-14 16:07 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `SwooleTW\Http\Websocket\Rooms\RedisRoom` which is incompatible with the documented return type `Ofcold\HttpSwoole\Websocket\Rooms\RoomContract`. Loading history...
46			}
47
48			/**
49			* Get redis client.
50			*/
51			public function getRedis()
52			{
53			return $this->connection();
54			}
55
56			/**
57			* Add multiple socket fds to a room.
58			*
59			* @param int fd
			0 ignored issues – show Bug introduced 2020-02-14 16:07 UTC by Report Bug Copy Issue Report The type `SwooleTW\Http\Websocket\Rooms\fd` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
60			* @param array\|string rooms
			0 ignored issues – show Bug introduced 2020-02-14 16:07 UTC by Report Bug Copy Issue Report The type `SwooleTW\Http\Websocket\Rooms\rooms` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
61			*/
62			public function add(int $fd, $rooms)
63			{
64			$rooms = is_array($rooms) ? $rooms : [$rooms];
65
66			$this->addValue($fd, $rooms, RoomContract::DESCRIPTORS_KEY);
67
68			foreach ($rooms as $room) {
69			$this->addValue($room, [$fd], RoomContract::ROOMS_KEY);
70			}
71			}
72
73			/**
74			* Delete multiple socket fds from a room.
75			*
76			* @param int fd
77			* @param array\|string rooms
78			*/
79			public function delete(int $fd, $rooms)
80			{
81			$rooms = is_array($rooms) ? $rooms : [$rooms];
82			$rooms = count($rooms) ? $rooms : $this->getRooms($fd);
83
84			$this->removeValue($fd, $rooms, RoomContract::DESCRIPTORS_KEY);
85
86			foreach ($rooms as $room) {
87			$this->removeValue($room, [$fd], RoomContract::ROOMS_KEY);
88			}
89			}
90
91			/**
92			* Add value to redis.
93			*
94			* @param $key
95			* @param array $values
96			* @param string $table
97			*
98			* @return $this
99			*/
100			public function addValue($key, array $values, string $table)
101			{
102			$this->checkTable($table);
103			$redisKey = $this->getKey($key, $table);
104
105			$this->connection()->pipeline(function ($pipe) use ($redisKey, $values) {
106			foreach ($values as $value) {
107			$pipe->sadd($redisKey, $value);
108			}
109			});
110
111			return $this;
112			}
113
114			/**
115			* Remove value from reddis.
116			*
117			* @param $key
118			* @param array $values
119			* @param string $table
120			*
121			* @return $this
122			*/
123			public function removeValue($key, array $values, string $table)
124			{
125			$this->checkTable($table);
126			$redisKey = $this->getKey($key, $table);
127
128			$this->connection()->pipeline(function ($pipe) use ($redisKey, $values) {
129			foreach ($values as $value) {
130			$pipe->srem($redisKey, $value);
131			}
132			});
133
134			return $this;
135			}
136
137			/**
138			* Get all sockets by a room key.
139			*
140			* @param string room
141			*
142			* @return array
143			*/
144			public function getClients(string $room)
145			{
146			return $this->getValue($room, RoomContract::ROOMS_KEY) ?? [];
147			}
148
149			/**
150			* Get all rooms by a fd.
151			*
152			* @param int fd
153			*
154			* @return array
155			*/
156			public function getRooms(int $fd)
157			{
158			return $this->getValue($fd, RoomContract::DESCRIPTORS_KEY) ?? [];
159			}
160
161			/**
162			* Check table for rooms and descriptors.
163			*
164			* @param string $table
165			*/
166			protected function checkTable(string $table)
167			{
168			if (! in_array($table, [RoomContract::ROOMS_KEY, RoomContract::DESCRIPTORS_KEY])) {
169			throw new \InvalidArgumentException("Invalid table name: `{$table}`.");
170			}
171			}
172
173			/**
174			* Get value.
175			*
176			* @param string $key
177			* @param string $table
178			*
179			* @return array
180			*/
181			public function getValue(string $key, string $table)
182			{
183			$this->checkTable($table);
184
185			$result = $this->connection()->smembers($this->getKey($key, $table));
186
187			// Try to fix occasional non-array returned result
188			return is_array($result) ? $result : [];
189			}
190
191			/**
192			* Get key.
193			*
194			* @param string $key
195			* @param string $table
196			*
197			* @return string
198			*/
199			public function getKey(string $key, string $table)
200			{
201			return "{$table}:{$key}";
202			}
203
204			/**
205			* Clean all rooms.
206			*/
207			protected function cleanRooms(): void
208			{
209			if (count($keys = $this->connection()->keys("*"))) {
210			$this->connection()->del($keys);
211			}
212			}
213
214			/**
215			* Get the Redis connection instance.
216			*
217			* @return \Illuminate\Redis\Connections\Connection
			0 ignored issues – show Bug introduced 2020-02-14 16:07 UTC by Report Bug Copy Issue Report The type `Illuminate\Redis\Connections\Connection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
218			*/
219			public function connection()
220			{
221			return $this->redis->connection('swoole');
222			}
223			}
224

swooletw / laravel-swoole

Pull Request — master (#378)

RedisRoom::add() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like