SocketTrait::openSocket() - Code Metrics - Inspection of "Update to version 1.3" - EvilFreelancer/routeros-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#40)

by Mr

created 2020-06-28 18:01 UTC

SocketTrait::openSocket() A

↳ Parent: SocketTrait

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	35
ccs	15
cts	15
cp	1
rs	9.36
c	0
b	0
f	0
cc	3
nc	4
nop	0
crap	3

<?php

namespace RouterOS;

use RouterOS\Exceptions\ClientException;

trait SocketTrait
{
    /**
     * Socket resource
     *
     * @var resource|null
     */
    private $socket;

    /**
     * Code of error
     *
     * @var int
     */
    private $socket_err_num;

    /**
     * Description of socket error
     *
     * @var string
     */
    private $socket_err_str;

    /**
     * Initiate socket session
     *
     * @return void
     * @throws \RouterOS\Exceptions\ClientException
     * @throws \RouterOS\Exceptions\ConfigException
     */
    private function openSocket(): void
    {
        // Default: Context for ssl
        $context = stream_context_create([
            'ssl' => [
                'ciphers'          => 'ADH:ALL',
                'verify_peer'      => false,
                'verify_peer_name' => false
            ]
        ]);

        // Default: Proto tcp:// but for ssl we need ssl://
        $proto = $this->config('ssl') ? 'ssl://' : '';
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Initiate socket client
        $socket = @stream_socket_client(
            $proto . $this->config('host') . ':' . $this->config('port'),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->socket_err_num,
            $this->socket_err_str,
            $this->config('timeout'),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            STREAM_CLIENT_CONNECT,
            $context
        );

        // Throw error is socket is not initiated
        if (false === $socket) {
            throw new ClientException('Unable to establish socket session, ' . $this->socket_err_str);
        }

        //Timeout read
        stream_set_timeout($socket, $this->config('timeout'));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Save socket to static variable
        $this->setSocket($socket);
    }

    /**
     * Close socket session
     *
     * @return bool
     */
    private function closeSocket(): bool
    {
        return fclose($this->socket);
    }

    /**
     * Save socket resource to static variable
     *
     * @param resource $socket
     *
     * @return  void
     */
    private function setSocket($socket): void
    {
        $this->socket = $socket;
    }

    /**
     * Return socket resource if is exist
     *
     * @return resource
     */
    public function getSocket()
    {
        return $this->socket;
    }
}


1		<?php
2
3		namespace RouterOS;
4
5		use RouterOS\Exceptions\ClientException;
6
7		trait SocketTrait
8		{
9		/**
10		* Socket resource
11		*
12		* @var resource\|null
13		*/
14		private $socket;
15
16		/**
17		* Code of error
18		*
19		* @var int
20		*/
21		private $socket_err_num;
22
23		/**
24		* Description of socket error
25		*
26		* @var string
27		*/
28		private $socket_err_str;
29
30		/**
31		* Initiate socket session
32		*
33		* @return void
34		* @throws \RouterOS\Exceptions\ClientException
35		* @throws \RouterOS\Exceptions\ConfigException
36		*/
37	8	private function openSocket(): void
38		{
39		// Default: Context for ssl
40	8	$context = stream_context_create([
41		'ssl' => [
42	8	'ciphers' => 'ADH:ALL',
43		'verify_peer' => false,
44		'verify_peer_name' => false
45		]
46		]);
47
48		// Default: Proto tcp:// but for ssl we need ssl://
49	8	$proto = $this->config('ssl') ? 'ssl://' : '';
		0 ignored issues – show Bug introduced 2019-02-17 11:07 UTC by Report Bug Copy Issue Report It seems like `config()` 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...
50
51		// Initiate socket client
52	8	$socket = @stream_socket_client(
53	8	$proto . $this->config('host') . ':' . $this->config('port'),
		0 ignored issues – show Bug introduced 2019-02-17 11:07 UTC by Report Bug Copy Issue Report It seems like `config()` 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...
54	8	$this->socket_err_num,
55	8	$this->socket_err_str,
56	8	$this->config('timeout'),
		0 ignored issues – show Bug introduced 2019-02-17 11:07 UTC by Report Bug Copy Issue Report It seems like `config()` 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...
57	8	STREAM_CLIENT_CONNECT,
58		$context
59		);
60
61		// Throw error is socket is not initiated
62	8	if (false === $socket) {
63	1	throw new ClientException('Unable to establish socket session, ' . $this->socket_err_str);
64		}
65
66		//Timeout read
67	7	stream_set_timeout($socket, $this->config('timeout'));
		0 ignored issues – show Bug introduced 2019-10-01 15:48 UTC by Report Bug Copy Issue Report It seems like `config()` 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		// Save socket to static variable
70	7	$this->setSocket($socket);
71	7	}
72
73		/**
74		* Close socket session
75		*
76		* @return bool
77		*/
78		private function closeSocket(): bool
79		{
80		return fclose($this->socket);
81		}
82
83		/**
84		* Save socket resource to static variable
85		*
86		* @param resource $socket
87		*
88		* @return void
89		*/
90	7	private function setSocket($socket): void
91		{
92	7	$this->socket = $socket;
93	7	}
94
95		/**
96		* Return socket resource if is exist
97		*
98		* @return resource
99		*/
100	7	public function getSocket()
101		{
102	7	return $this->socket;
103		}
104		}
105

EvilFreelancer / routeros-api-php

Pull Request — master (#40)

SocketTrait::openSocket() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like