APIConnector::close() - 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-07-01 19:37 UTC

APIConnector::close() A

↳ Parent: APIConnector

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace RouterOS;

use RouterOS\Interfaces\StreamInterface;

/**
 * Class APIConnector
 *
 * Implement middle level dialog with router by masking word dialog implementation to client class
 *
 * @package RouterOS
 * @since   0.9
 */
class APIConnector
{
    /**
     * @var StreamInterface $stream The stream used to communicate with the router
     */
    protected $stream;

    /**
     * APIConnector constructor.
     *
     * @param \RouterOS\Interfaces\StreamInterface $stream
     */
    public function __construct(StreamInterface $stream)
    {
        $this->stream = $stream;
    }

    /**
     * Close stream connection
     *
     * @return void
     */
    public function close(): void
    {
        $this->stream->close();
    }

    /**
     * Reads a WORD from the stream
     *
     * WORDs are part of SENTENCE. Each WORD has to be encoded in certain way - length of the WORD followed by WORD content.
     * Length of the WORD should be given as count of bytes that are going to be sent
     *
     * @return string The word content, en empty string for end of SENTENCE
     */
    public function readWord(): string
    {
        // Get length of next word
        $length = APILengthCoDec::decodeLength($this->stream);
        return ($length > 0) ? $this->stream->read($length) : '';
    }

    /**
     * Write word to stream
     *
     * @param string $word
     *
     * @return int return number of written bytes
     */
    public function writeWord(string $word): int
    {
        $encodedLength = APILengthCoDec::encodeLength(strlen($word));
        return $this->stream->write($encodedLength . $word);
    }
}


1		<?php
2
3		namespace RouterOS;
4
5		use RouterOS\Interfaces\StreamInterface;
6
7		/**
8		* Class APIConnector
9		*
10		* Implement middle level dialog with router by masking word dialog implementation to client class
11		*
12		* @package RouterOS
13		* @since 0.9
14		*/
15		class APIConnector
16		{
17		/**
18		* @var StreamInterface $stream The stream used to communicate with the router
19		*/
20		protected $stream;
21
22		/**
23		* APIConnector constructor.
24		*
25		* @param \RouterOS\Interfaces\StreamInterface $stream
26		*/
27	24	public function __construct(StreamInterface $stream)
28		{
29	24	$this->stream = $stream;
30	24	}
31
32		/**
33		* Close stream connection
34		*
35		* @return void
36		*/
37		public function close(): void
38		{
39		$this->stream->close();
40		}
41
42		/**
43		* Reads a WORD from the stream
44		*
45		* WORDs are part of SENTENCE. Each WORD has to be encoded in certain way - length of the WORD followed by WORD content.
46		* Length of the WORD should be given as count of bytes that are going to be sent
47		*
48		* @return string The word content, en empty string for end of SENTENCE
49		*/
50	23	public function readWord(): string
51		{
52		// Get length of next word
53	23	$length = APILengthCoDec::decodeLength($this->stream);
54	23	return ($length > 0) ? $this->stream->read($length) : '';
55		}
56
57		/**
58		* Write word to stream
59		*
60		* @param string $word
61		*
62		* @return int return number of written bytes
63		*/
64	25	public function writeWord(string $word): int
65		{
66	25	$encodedLength = APILengthCoDec::encodeLength(strlen($word));
67	25	return $this->stream->write($encodedLength . $word);
68		}
69		}
70

EvilFreelancer / routeros-api-php

Pull Request — master (#40)

APIConnector::close() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like