QueuePoolCommand::setOutputHandler() - Code Metrics - wanghanlin/laravel-queue-pool - Measure and Improve Code Quality continuously with Scrutinizer

QueuePoolCommand::setOutputHandler() A
last analyzed 2018-02-13 13:00 UTC

↳ Parent: QueuePoolCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Wanghanlin\QueuePool;

use Illuminate\Console\Command;

class QueuePoolCommand extends Command
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $signature = 'queue:pool
                            {connection? : The name of the queue connection to work}
                            {--workers= : The amount of the workers to start}
                            {--queue= : The names of the queues to work}
                            {--delay=0 : The number of seconds to delay failed jobs}
                            {--force : Force the worker to run even in maintenance mode}
                            {--memory=128 : The memory limit in megabytes}
                            {--sleep=3 : Number of seconds to sleep when no job is available}
                            {--timeout=60 : The number of seconds a child process can run}
                            {--tries=0 : Number of times to attempt a job before logging it failed}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Start a pool of workers to process the queue';

    /**
     * The queue pool instance.
     *
     * @var QueuePool
     */
    protected $pool;

    /**
     * Create a new queue work command.
     *
     * @param  QueuePool  $pool
     * @return void

     */
    public function __construct(QueuePool $pool)
    {
        parent::__construct();
        $this->setOutputHandler($this->pool = $pool);
    }

    /**
     * Execute the console command.
     *
     * @return void
     */
    public function handle()
    {
        // We need to get the right queue for the connection which is set in the queue
        // configuration file for the application. We will pull it based on the set
        // connection being run for the queue operation currently being executed.
        $queue = $this->getQueue(
            $connection = $this->input->getArgument('connection')
        );
        $this->pool->start(
            $connection, $queue, $this->gatherOptions()
        );
    }

    /**
     * Get the name of the queue connection to listen on.
     *
     * @param  string  $connection
     * @return string
     */
    protected function getQueue($connection)
    {
        $connection = $connection ?: $this->laravel['config']['queue.default'];

        return $this->input->getOption('queue') ?: $this->laravel['config']->get(
            "queue.connections.{$connection}.queue", 'default'
        );
    }

    /**
     * Get the listener options for the command.
     *
     * @return QueuePoolOption
     */
    protected function gatherOptions()
    {
        return new QueuePoolOption(
            $this->option('workers'), $this->option('env'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->option('delay'), $this->option('memory'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->option('timeout'), $this->option('sleep'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->option('tries'), $this->option('force')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Set the options on the queue listener.
     *
     * @param  QueuePool  $pool
     * @return void
     */
    protected function setOutputHandler(QueuePool $pool)
    {
        $pool->setOutputHandler(function ($type, $line) {
            $this->output->write($line);
        });
    }
}


1			<?php
2
3			namespace Wanghanlin\QueuePool;
4
5			use Illuminate\Console\Command;
6
7			class QueuePoolCommand extends Command
8			{
9			/**
10			* The console command name.
11			*
12			* @var string
13			*/
14			protected $signature = 'queue:pool
15			{connection? : The name of the queue connection to work}
16			{--workers= : The amount of the workers to start}
17			{--queue= : The names of the queues to work}
18			{--delay=0 : The number of seconds to delay failed jobs}
19			{--force : Force the worker to run even in maintenance mode}
20			{--memory=128 : The memory limit in megabytes}
21			{--sleep=3 : Number of seconds to sleep when no job is available}
22			{--timeout=60 : The number of seconds a child process can run}
23			{--tries=0 : Number of times to attempt a job before logging it failed}';
24
25			/**
26			* The console command description.
27			*
28			* @var string
29			*/
30			protected $description = 'Start a pool of workers to process the queue';
31
32			/**
33			* The queue pool instance.
34			*
35			* @var QueuePool
36			*/
37			protected $pool;
38
39			/**
40			* Create a new queue work command.
41			*
42			* @param QueuePool $pool
43			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
44			*/
45			public function __construct(QueuePool $pool)
46			{
47			parent::__construct();
48			$this->setOutputHandler($this->pool = $pool);
49			}
50
51			/**
52			* Execute the console command.
53			*
54			* @return void
55			*/
56			public function handle()
57			{
58			// We need to get the right queue for the connection which is set in the queue
59			// configuration file for the application. We will pull it based on the set
60			// connection being run for the queue operation currently being executed.
61			$queue = $this->getQueue(
62			$connection = $this->input->getArgument('connection')
63			);
64			$this->pool->start(
65			$connection, $queue, $this->gatherOptions()
66			);
67			}
68
69			/**
70			* Get the name of the queue connection to listen on.
71			*
72			* @param string $connection
73			* @return string
74			*/
75			protected function getQueue($connection)
76			{
77			$connection = $connection ?: $this->laravel['config']['queue.default'];
78
79			return $this->input->getOption('queue') ?: $this->laravel['config']->get(
80			"queue.connections.{$connection}.queue", 'default'
81			);
82			}
83
84			/**
85			* Get the listener options for the command.
86			*
87			* @return QueuePoolOption
88			*/
89			protected function gatherOptions()
90			{
91			return new QueuePoolOption(
92			$this->option('workers'), $this->option('env'),
			0 ignored issues – show Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('workers')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report It seems like `$this->option('env')` targeting `Illuminate\Console\Command::option()` can also be of type `array`; however, `Wanghanlin\QueuePool\Que...olOption::__construct()` does only seem to accept `string\|null`, maybe add an additional type check? This check looks at variables that 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...
93			$this->option('delay'), $this->option('memory'),
			0 ignored issues – show Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('delay')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('memory')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
94			$this->option('timeout'), $this->option('sleep'),
			0 ignored issues – show Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('timeout')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('sleep')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95			$this->option('tries'), $this->option('force')
			0 ignored issues – show Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('tries')` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2018-02-13 11:57 UTC by Report Bug Copy Issue Report `$this->option('force')` is of type `string\|array`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
96			);
97			}
98
99			/**
100			* Set the options on the queue listener.
101			*
102			* @param QueuePool $pool
103			* @return void
104			*/
105			protected function setOutputHandler(QueuePool $pool)
106			{
107			$pool->setOutputHandler(function ($type, $line) {
108			$this->output->write($line);
109			});
110			}
111			}
112

wanghanlin / laravel-queue-pool

QueuePoolCommand::setOutputHandler() A last analyzed 2018-02-13 13:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

QueuePoolCommand::setOutputHandler() A
last analyzed 2018-02-13 13:00 UTC