Connection::onReady() - Code Metrics - Inspection of "GearmanClient -> Gearman" - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — http-client-refactoring ( e04523 )

by Vasily

created 2016-05-16 21:28 UTC

Connection::onReady() A

↳ Parent: Connection

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	3
eloc	6
nc	4
nop	0
dl	0
loc	10
rs	9.4285

<?php
namespace PHPDaemon\Clients\Gearman;

use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Utils\Crypt;


/**
 * Class Connection
 * @protocol http://gearman.org/protocol/
 */
class  Connection extends ClientConnection {


    /**
     * Magic code for request
     */
    const MAGIC_REQUEST         = "\0REQ";

    /**
     * Magic code for response
     */
    const MAGIC_RESPONSE        = "\0RES";

    /*
     * Byte length of header
     */
    const HEADER_LENGTH         = 12;

    /**
     * Header binary format
     */
    const HEADER_WRITE_FORMAT   = "a4NN";

    /**
     * Header read format
     */
    const HEADER_READ_FORMAT    = "a4magic/Ntype/Nsize";

    /**
     * Delimeter for function arguments
     */
    const ARGS_DELIMITER        = "\0";



    /**
     * Request codes
     *
     * @var array
     */
    protected static $requestCommandList = [
        'CAN_DO' => 1,
        'CANT_DO' => 2,
        'RESET_ABILITIES' => 3,
        'PRE_SLEEP' => 4,
        'SUBMIT_JOB' => 7,
        'GRAB_JOB' => 9,
        'WORK_STATUS' => 12,
        'WORK_COMPLETE' => 13,
        'WORK_FAIL' => 14,
        'GET_STATUS' => 15,
        'ECHO_REQ' => 16,
        'SUBMIT_JOB_BG' => 18,
        'SUBMIT_JOB_HIGH' => 21,
        'SET_CLIENT_ID' => 22,
        'CAN_DO_TIMEOUT' => 23,
        'ALL_YOURS' => 24,
        'WORK_EXCEPTION' => 25,
        'OPTION_REQ' => 26,
        'OPTION_RES' => 27,
        'WORK_DATA' => 28,
        'WORK_WARNING' => 29,
        'GRAB_JOB_UNIQ' => 30,
        'SUBMIT_JOB_HIGH_BG' => 32,
        'SUBMIT_JOB_LOW' => 33,
        'SUBMIT_JOB_LOW_BG' => 34,
        'SUBMIT_JOB_SCHED' => 35,
        'SUBMIT_JOB_EPOCH' => 36,
    ];
    protected static $requestCommandListFlipped;

    /**
     * Response codes
     *
     * @var array
     */
    protected static $responseCommandList = [
        'NOOP' => 6,
        'JOB_CREATED' => 8,
        'NO_JOB' => 10,
        'JOB_ASSIGN' => 11,
        'WORK_STATUS' => 12,
        'WORK_COMPLETE' => 13,
        'WORK_FAIL' => 14,
        'ECHO_RES' => 17,
        'ERROR' => 19,
        'STATUS_RES' => 20,
        'WORK_EXCEPTION' => 25,
        'OPTION_RES' => 27,
        'WORK_WARNING' => 29,
        'JOB_ASSIGN_UNIQ' => 31,
    ];

    protected static $responseCommandListFlipped;

    /**
     * @var mixed
     */
    public $response;

    /**
     * @var string
     */
    public $responseType;

    /**
     * @var string
     */
    public $responseCommand;

    /**
     * Called when new data received
     *
     * @return void
     */
    public function onRead()
    {
        if (($head = $this->lookExact(static::HEADER_LENGTH)) === false) {
            return;
        }

        list($magic, $typeInt, $size) = unpack(static::HEADER_READ_FORMAT, $head);

        if ($this->getInputLength() < static::HEADER_LENGTH + $size) {
            return;
        }

        $this->drain(static::HEADER_LENGTH);
        $pct = $this->read($size);

        if ($magic === static::MAGIC_RESPONSE) {
            $this->responseType = static::responseCommandListFlipped[$typeInt];
            $this->response = explode(static::ARGS_DELIMITER, $pct);
            $this->onResponse->executeOne($this);
            $this->responseType = null;
            $this->responseCommand = null;
            $this->responseType = null;
            $this->checkFree();
            return;
        } else {
            $type = static::$requestCommandListFlipped[$typeInt];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            // @TODO

        }
    }
    
    /**
     * Called when the connection is handshaked (at low-level), and peer is ready to recv. data
     * @return void
     */
    public function onReady()
    {
        if (static::$requestCommandListFlipped === null) {
            static::$requestCommandListFlipped = array_flip(static::$requestCommandList);
        }
        if (static::$responseCommandListFlipped === null) {
            static::$responseCommandListFlipped = array_flip(static::$responseCommandList);
        }
        parent::onReady();
    }


    /**
     * Function send ECHO
     *
     * @param $payload
     * @param callable|null $cb
     */
    public function sendEcho ($payload, $cb = null)
    {
        $this->sendCommand('ECHO_REQ', $payload, $cb);
    }

    /**
     * Function run task and wait result in callback
     *
     * @param $params
     * @param callable $cb = null

     * @param boolean $unique
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function submitJob($params, $cb = null)
    {
        $closure = function () use (&$params, $cb)
        {
            $this->sendCommand('SUBMIT_JOB'
                . (isset($params['pri']) ? '_ ' . strtoupper($params['pri']) : '')
                . (isset($params['bg']) && $params['bg'] ? '_BG' : ''),
                [$params['function'], $params['unique'], $params['payload']],
                $cb
            );
        };
        if (isset($params['unique'])) {
            $closure();
        } else {
            Crypt::randomString(10, '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', function($random) use ($closure) {

                $params['unique'] = $random;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                $closure();
            });
        }
    }

    /**
     * Get job status
     * 
     * @param mixed $jobHandle Job handle that was given in JOB_CREATED packet.
     * @param callable $cb = null

     *
     */
    public function getStatus($jobHandle, $cb = null) {
        $this->sendCommand('GET_STATUS', [$jobHandle], $cb);
    }

    /**
     * Function set settings for current connection
     * Available settings
     * 'exceptions' - Forward WORK_EXCEPTION packets to the client.
     *
     * @url http://gearman.org/protocol/
     *
     *
     * @param int $optionName
     * @param callable $cb = null

     */
    public function setConnectionOption($optionName, $cb = null) {
        $this->sendCommand('OPTION_RES', [$optionName], $cb);
    }

    /**
     * Send a command
     *
     * @param $commandName
     * @param $payload
     * @param callable $cb = null

     */
    public function sendCommand($commandName, $payload, $cb = null) {

        $pct = implode(
            static::ARGS_DELIMITER,
            array_map(function($item){ return !is_scalar($item) ? serialize($item) : $item; }, (array) $payload)
        );
        $this->onResponse->push($cb);

        $this->write(pack(
            static::HEADER_WRITE_FORMAT,
            static::MAGIC_REQUEST, $this->requestCommandList[$commandName], mb_orig_strlen($pct)));
        $this->write($pct);
    }
}

1			<?php
2			namespace PHPDaemon\Clients\Gearman;
3
4			use PHPDaemon\Network\ClientConnection;
5			use PHPDaemon\Utils\Crypt;
6
7
8			/**
9			* Class Connection
10			* @protocol http://gearman.org/protocol/
11			*/
12			class Connection extends ClientConnection {
			0 ignored issues – show Coding Style introduced 2016-03-16 19:58 UTC by Report Bug Copy Issue Report Expected 1 space between class keyword and class name; 2 found Loading history...
13
14			/**
15			* Magic code for request
16			*/
17			const MAGIC_REQUEST = "\0REQ";
18
19			/**
20			* Magic code for response
21			*/
22			const MAGIC_RESPONSE = "\0RES";
23
24			/*
25			* Byte length of header
26			*/
27			const HEADER_LENGTH = 12;
28
29			/**
30			* Header binary format
31			*/
32			const HEADER_WRITE_FORMAT = "a4NN";
33
34			/**
35			* Header read format
36			*/
37			const HEADER_READ_FORMAT = "a4magic/Ntype/Nsize";
38
39			/**
40			* Delimeter for function arguments
41			*/
42			const ARGS_DELIMITER = "\0";
43
44
45
46			/**
47			* Request codes
48			*
49			* @var array
50			*/
51			protected static $requestCommandList = [
52			'CAN_DO' => 1,
53			'CANT_DO' => 2,
54			'RESET_ABILITIES' => 3,
55			'PRE_SLEEP' => 4,
56			'SUBMIT_JOB' => 7,
57			'GRAB_JOB' => 9,
58			'WORK_STATUS' => 12,
59			'WORK_COMPLETE' => 13,
60			'WORK_FAIL' => 14,
61			'GET_STATUS' => 15,
62			'ECHO_REQ' => 16,
63			'SUBMIT_JOB_BG' => 18,
64			'SUBMIT_JOB_HIGH' => 21,
65			'SET_CLIENT_ID' => 22,
66			'CAN_DO_TIMEOUT' => 23,
67			'ALL_YOURS' => 24,
68			'WORK_EXCEPTION' => 25,
69			'OPTION_REQ' => 26,
70			'OPTION_RES' => 27,
71			'WORK_DATA' => 28,
72			'WORK_WARNING' => 29,
73			'GRAB_JOB_UNIQ' => 30,
74			'SUBMIT_JOB_HIGH_BG' => 32,
75			'SUBMIT_JOB_LOW' => 33,
76			'SUBMIT_JOB_LOW_BG' => 34,
77			'SUBMIT_JOB_SCHED' => 35,
78			'SUBMIT_JOB_EPOCH' => 36,
79			];
80			protected static $requestCommandListFlipped;
81
82			/**
83			* Response codes
84			*
85			* @var array
86			*/
87			protected static $responseCommandList = [
88			'NOOP' => 6,
89			'JOB_CREATED' => 8,
90			'NO_JOB' => 10,
91			'JOB_ASSIGN' => 11,
92			'WORK_STATUS' => 12,
93			'WORK_COMPLETE' => 13,
94			'WORK_FAIL' => 14,
95			'ECHO_RES' => 17,
96			'ERROR' => 19,
97			'STATUS_RES' => 20,
98			'WORK_EXCEPTION' => 25,
99			'OPTION_RES' => 27,
100			'WORK_WARNING' => 29,
101			'JOB_ASSIGN_UNIQ' => 31,
102			];
103
104			protected static $responseCommandListFlipped;
105
106			/**
107			* @var mixed
108			*/
109			public $response;
110
111			/**
112			* @var string
113			*/
114			public $responseType;
115
116			/**
117			* @var string
118			*/
119			public $responseCommand;
120
121			/**
122			* Called when new data received
123			*
124			* @return void
125			*/
126			public function onRead()
127			{
128			if (($head = $this->lookExact(static::HEADER_LENGTH)) === false) {
129			return;
130			}
131
132			list($magic, $typeInt, $size) = unpack(static::HEADER_READ_FORMAT, $head);
133
134			if ($this->getInputLength() < static::HEADER_LENGTH + $size) {
135			return;
136			}
137
138			$this->drain(static::HEADER_LENGTH);
139			$pct = $this->read($size);
140
141			if ($magic === static::MAGIC_RESPONSE) {
142			$this->responseType = static::responseCommandListFlipped[$typeInt];
143			$this->response = explode(static::ARGS_DELIMITER, $pct);
144			$this->onResponse->executeOne($this);
145			$this->responseType = null;
146			$this->responseCommand = null;
147			$this->responseType = null;
148			$this->checkFree();
149			return;
150			} else {
151			$type = static::$requestCommandListFlipped[$typeInt];
			0 ignored issues – show Unused Code introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report `$type` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
152			// @TODO
			0 ignored issues – show Coding Style introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
153			}
154			}
155
156			/**
157			* Called when the connection is handshaked (at low-level), and peer is ready to recv. data
158			* @return void
159			*/
160			public function onReady()
161			{
162			if (static::$requestCommandListFlipped === null) {
163			static::$requestCommandListFlipped = array_flip(static::$requestCommandList);
164			}
165			if (static::$responseCommandListFlipped === null) {
166			static::$responseCommandListFlipped = array_flip(static::$responseCommandList);
167			}
168			parent::onReady();
169			}
170
171
172			/**
173			* Function send ECHO
174			*
175			* @param $payload
176			* @param callable\|null $cb
177			*/
178			public function sendEcho ($payload, $cb = null)
179			{
180			$this->sendCommand('ECHO_REQ', $payload, $cb);
181			}
182
183			/**
184			* Function run task and wait result in callback
185			*
186			* @param $params
187			* @param callable $cb = null
			0 ignored issues – show Documentation introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report Should the type for parameter `$cb` not be `callable\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
188			* @param boolean $unique
			0 ignored issues – show Bug introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report There is no parameter named `$unique`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
189			*/
190			public function submitJob($params, $cb = null)
191			{
192			$closure = function () use (&$params, $cb)
193			{
194			$this->sendCommand('SUBMIT_JOB'
195			. (isset($params['pri']) ? '_ ' . strtoupper($params['pri']) : '')
196			. (isset($params['bg']) && $params['bg'] ? '_BG' : ''),
197			[$params['function'], $params['unique'], $params['payload']],
198			$cb
199			);
200			};
201			if (isset($params['unique'])) {
202			$closure();
203			} else {
204			Crypt::randomString(10, '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', function($random) use ($closure) {
			0 ignored issues – show Coding Style introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 136 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
205			$params['unique'] = $random;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report `$params` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$params = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
206			$closure();
207			});
208			}
209			}
210
211			/**
212			* Get job status
213			*
214			* @param mixed $jobHandle Job handle that was given in JOB_CREATED packet.
215			* @param callable $cb = null
			0 ignored issues – show Documentation introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report Should the type for parameter `$cb` not be `callable\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
216			*
217			*/
218			public function getStatus($jobHandle, $cb = null) {
219			$this->sendCommand('GET_STATUS', [$jobHandle], $cb);
220			}
221
222			/**
223			* Function set settings for current connection
224			* Available settings
225			* 'exceptions' - Forward WORK_EXCEPTION packets to the client.
226			*
227			* @url http://gearman.org/protocol/
228			*
229			*
230			* @param int $optionName
231			* @param callable $cb = null
			0 ignored issues – show Documentation introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report Should the type for parameter `$cb` not be `callable\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
232			*/
233			public function setConnectionOption($optionName, $cb = null) {
234			$this->sendCommand('OPTION_RES', [$optionName], $cb);
235			}
236
237			/**
238			* Send a command
239			*
240			* @param $commandName
241			* @param $payload
242			* @param callable $cb = null
			0 ignored issues – show Documentation introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report Should the type for parameter `$cb` not be `callable\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
243			*/
244			public function sendCommand($commandName, $payload, $cb = null) {
245
246			$pct = implode(
247			static::ARGS_DELIMITER,
248			array_map(function($item){ return !is_scalar($item) ? serialize($item) : $item; }, (array) $payload)
249			);
250			$this->onResponse->push($cb);
			0 ignored issues – show Bug introduced 2016-05-14 21:21 UTC by Report Bug Copy Issue Report It seems like `$cb` defined by parameter `$cb` on line 244 can also be of type `null`; however, `PHPDaemon\Structures\StackCallbacks::push()` does only seem to accept `callable`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
251			$this->write(pack(
252			static::HEADER_WRITE_FORMAT,
253			static::MAGIC_REQUEST, $this->requestCommandList[$commandName], mb_orig_strlen($pct)));
254			$this->write($pct);
255			}
256			}

kakserpom / phpdaemon

Push — http-client-refactoring ( e04523 )

Connection::onReady() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like