SocketHandler::keepAlive() - Code Metrics - belgattitude/soluble-japha - Measure and Improve Code Quality continuously with Scrutinizer

SocketHandler::keepAlive() A
last analyzed 2023-04-06 10:15 UTC

↳ Parent: SocketHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * soluble-japha / PHPJavaBridge driver client.
 *
 * Refactored version of phpjababridge's Java.inc file compatible
 * with php java bridge 6.2
 *
 *
 * @credits   http://php-java-bridge.sourceforge.net/pjb/
 *
 * @see      http://github.com/belgattitude/soluble-japha
 *
 * @author Jost Boekemeier
 * @author Vanvelthem Sébastien (refactoring and fixes from original implementation)
 * @license   MIT
 *
 * The MIT License (MIT)
 * Copyright (c) 2014-2017 Jost Boekemeier
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Soluble\Japha\Bridge\Driver\Pjb62;

use Soluble\Japha\Bridge\Exception\AuthenticationException;
use Soluble\Japha\Bridge\Exception\BrokenConnectionException;

class SocketHandler
{
    /**
     * @var Protocol
     */
    public $protocol;

    /**
     * @var EmptyChannel|SocketChannel
     */
    public $channel;

    public function __construct(Protocol $protocol, EmptyChannel $channel)
    {
        $this->protocol = $protocol;
        $this->channel = $channel;
    }

    public function write(string $data): ?int
    {
        return $this->channel->fwrite($data);
    }

    public function fwrite(string $data): ?int
    {
        return $this->write($data);
    }

    /**
     * @throws BrokenConnectionException
     */
    public function read(int $size): string
    {
        $str = $this->channel->fread($size);
        if ($str === null) {
            $this->shutdownBrokenConnection('Cannot read from socket');
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
        } else {
            return $str;
        }
    }

    public function fread(int $size): ?string
    {
        return $this->read($size);
    }

    public function redirect(): void
    {
    }

    public function getKeepAlive(): string
    {
        return $this->channel->getKeepAlive();
    }

    public function keepAlive(): void
    {
        $this->channel->keepAlive();
    }

    /**
     * @throws BrokenConnectionException|AuthenticationException
     *
     * @return never
     */
    public function shutdownBrokenConnection(string $msg = '', int $code = null): void
    {
        $msg = $msg ?? 'Broken connection: Unkown error, please see back end log for detail';

        // Log error
        $client = $this->protocol->getClient();
        $client->getLogger()->critical("[soluble-japha] $msg\"  (".__METHOD__.')');

        $this->channel->shutdownBrokenConnection();
        PjbProxyClient::unregisterAndThrowBrokenConnectionException($msg, $code);
    }
}


1		<?php
2		/**
3		* soluble-japha / PHPJavaBridge driver client.
4		*
5		* Refactored version of phpjababridge's Java.inc file compatible
6		* with php java bridge 6.2
7		*
8		*
9		* @credits http://php-java-bridge.sourceforge.net/pjb/
10		*
11		* @see http://github.com/belgattitude/soluble-japha
12		*
13		* @author Jost Boekemeier
14		* @author Vanvelthem Sébastien (refactoring and fixes from original implementation)
15		* @license MIT
16		*
17		* The MIT License (MIT)
18		* Copyright (c) 2014-2017 Jost Boekemeier
19		* Permission is hereby granted, free of charge, to any person obtaining a copy
20		* of this software and associated documentation files (the "Software"), to deal
21		* in the Software without restriction, including without limitation the rights
22		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
23		* copies of the Software, and to permit persons to whom the Software is
24		* furnished to do so, subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in
27		* all copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
35		* THE SOFTWARE.
36		*/
37
38		namespace Soluble\Japha\Bridge\Driver\Pjb62;
39
40		use Soluble\Japha\Bridge\Exception\AuthenticationException;
41		use Soluble\Japha\Bridge\Exception\BrokenConnectionException;
42
43		class SocketHandler
44		{
45		/**
46		* @var Protocol
47		*/
48		public $protocol;
49
50		/**
51		* @var EmptyChannel\|SocketChannel
52		*/
53		public $channel;
54
55	9	public function __construct(Protocol $protocol, EmptyChannel $channel)
56		{
57	9	$this->protocol = $protocol;
58	9	$this->channel = $channel;
59	9	}
60
61	117	public function write(string $data): ?int
62		{
63	117	return $this->channel->fwrite($data);
64		}
65
66		public function fwrite(string $data): ?int
67		{
68		return $this->write($data);
69		}
70
71		/**
72		* @throws BrokenConnectionException
73		*/
74	113	public function read(int $size): string
75		{
76	113	$str = $this->channel->fread($size);
77	113	if ($str === null) {
78		$this->shutdownBrokenConnection('Cannot read from socket');
		0 ignored issues – show Bug Best Practice introduced 2018-01-18 10:52 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
79		} else {
80	113	return $str;
81		}
82		}
83
84		public function fread(int $size): ?string
85		{
86		return $this->read($size);
87		}
88
89	112	public function redirect(): void
90		{
91	112	}
92
93	23	public function getKeepAlive(): string
94		{
95	23	return $this->channel->getKeepAlive();
96		}
97
98	23	public function keepAlive(): void
99		{
100	23	$this->channel->keepAlive();
101	8	}
102
103		/**
104		* @throws BrokenConnectionException\|AuthenticationException
105		*
106		* @return never
107		*/
108		public function shutdownBrokenConnection(string $msg = '', int $code = null): void
109		{
110		$msg = $msg ?? 'Broken connection: Unkown error, please see back end log for detail';
111
112		// Log error
113		$client = $this->protocol->getClient();
114		$client->getLogger()->critical("[soluble-japha] $msg\" (".__METHOD__.')');
115
116		$this->channel->shutdownBrokenConnection();
117		PjbProxyClient::unregisterAndThrowBrokenConnectionException($msg, $code);
118		}
119		}
120

belgattitude / soluble-japha

SocketHandler::keepAlive() A last analyzed 2023-04-06 10:15 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SocketHandler::keepAlive() A
last analyzed 2023-04-06 10:15 UTC