TryCatchTask - Code Metrics - netresearch/kite - Measure and Improve Code Quality continuously with Scrutinizer

TryCatchTask A
last analyzed 2017-12-07 07:58 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	103
Duplicated Lines	13.59 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	14
loc	103
rs	10
c	0
b	0
f	0
wmc	11
lcom	1
cbo	4

5 Methods

Rating	Name	Duplication	Size	Complexity
A	configureVariables()	14	14	1
A	offsetSet()	0	8	2
A	addTask()	0	9	2
A	onCatch()	0	8	2
A	run()	0	15	4

How to fix Duplicated Code

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Task
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */

namespace Netresearch\Kite\Task;
use Netresearch\Kite\Exception;
use Netresearch\Kite\Task;


/**
 * Catch exceptions while executing tasks
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Task
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */
class TryCatchTask extends SubTask
{
    /**
     * @var \Netresearch\Kite\Task
     */
    protected $catchTask;

    /**
     * @var bool If the next fetched task should be the catch task
     */
    protected $catch = false;

    /**
     * Configure the options
     *
     * @return array
     */
    protected function configureVariables()

    {
        return array(
            'onCatch' => array(
                'type' => 'array',
                'label' => 'Task to execute when an exception was catched'
            ),
            'errorMessage' => array(
                'type' => 'string',
                'label' => 'Message to display on error'
            ),
            '--'
        ) + parent::configureVariables();
    }

    /**
     * Set a variable or it's value
     *
     * @param string $name  The name
     * @param mixed  $value The value
     *
     * @return void
     */
    public function offsetSet($name, $value)
    {
        if ($name === 'onCatch') {
            $this->catchTask = $this->factory->createTask($value, $this);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return;
        }
        parent::offsetSet($name, $value);
    }


    /**
     * Set task as catchTask if $this->catch
     *
     * @param \Netresearch\Kite\Task $task The task
     *
     * @return $this|mixed $this or the task return value when this is running
     */
    public function addTask(Task $task)
    {
        if ($this->catch) {
            $this->catchTask = $task;
            $this->catch = false;
            return $task;
        }
        return parent::addTask($task);
    }

    /**
     * Fetch the next task as that task to execute when an exception occured while
     * executing the other tasks
     *
     * @return $this
     */
    public function onCatch()
    {
        if ($this->catchTask) {
            throw new Exception('Only one task may be executed on catch');
        }
        $this->catch = true;
        return $this;
    }

    /**
     * Run an array of tasks
     *
     * @return mixed The ran tasks return value
     */
    public function run()
    {
        try {
            return parent::run();
        } catch (\Exception $e) {
            $message = $this->get('errorMessage');
            if ($message) {
                $this->console->output($message);
            }
            if ($this->catchTask) {
                return $this->addTask($this->catchTask);
            }
            return null;
        }
    }
}
?>


1		<?php
2		/**
3		* See class comment
4		*
5		* PHP Version 5
6		*
7		* @category Netresearch
8		* @package Netresearch\Kite
9		* @subpackage Task
10		* @author Christian Opitz <[email protected]>
11		* @license http://www.netresearch.de Netresearch Copyright
12		* @link http://www.netresearch.de
13		*/
14
15		namespace Netresearch\Kite\Task;
16		use Netresearch\Kite\Exception;
17		use Netresearch\Kite\Task;
18
19
20		/**
21		* Catch exceptions while executing tasks
22		*
23		* @category Netresearch
24		* @package Netresearch\Kite
25		* @subpackage Task
26		* @author Christian Opitz <[email protected]>
27		* @license http://www.netresearch.de Netresearch Copyright
28		* @link http://www.netresearch.de
29		*/
30		class TryCatchTask extends SubTask
31		{
32		/**
33		* @var \Netresearch\Kite\Task
34		*/
35		protected $catchTask;
36
37		/**
38		* @var bool If the next fetched task should be the catch task
39		*/
40		protected $catch = false;
41
42		/**
43		* Configure the options
44		*
45		* @return array
46		*/
47	View Code Duplication	protected function configureVariables()
		0 ignored issues – show Duplication introduced 2017-11-14 14:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
48		{
49		return array(
50		'onCatch' => array(
51		'type' => 'array',
52		'label' => 'Task to execute when an exception was catched'
53		),
54		'errorMessage' => array(
55		'type' => 'string',
56		'label' => 'Message to display on error'
57		),
58		'--'
59		) + parent::configureVariables();
60		}
61
62		/**
63		* Set a variable or it's value
64		*
65		* @param string $name The name
66		* @param mixed $value The value
67		*
68		* @return void
69		*/
70		public function offsetSet($name, $value)
71		{
72		if ($name === 'onCatch') {
73		$this->catchTask = $this->factory->createTask($value, $this);
		0 ignored issues – show Documentation introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report `$value` is of type `*`, but the function expects a `callable`. 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...
74		return;
75		}
76		parent::offsetSet($name, $value);
77		}
78
79
80		/**
81		* Set task as catchTask if $this->catch
82		*
83		* @param \Netresearch\Kite\Task $task The task
84		*
85		* @return $this\|mixed $this or the task return value when this is running
86		*/
87		public function addTask(Task $task)
88		{
89		if ($this->catch) {
90		$this->catchTask = $task;
91		$this->catch = false;
92		return $task;
93		}
94		return parent::addTask($task);
95		}
96
97		/**
98		* Fetch the next task as that task to execute when an exception occured while
99		* executing the other tasks
100		*
101		* @return $this
102		*/
103		public function onCatch()
104		{
105		if ($this->catchTask) {
106		throw new Exception('Only one task may be executed on catch');
107		}
108		$this->catch = true;
109		return $this;
110		}
111
112		/**
113		* Run an array of tasks
114		*
115		* @return mixed The ran tasks return value
116		*/
117		public function run()
118		{
119		try {
120		return parent::run();
121		} catch (\Exception $e) {
122		$message = $this->get('errorMessage');
123		if ($message) {
124		$this->console->output($message);
125		}
126		if ($this->catchTask) {
127		return $this->addTask($this->catchTask);
128		}
129		return null;
130		}
131		}
132		}
133		?>
134

netresearch / kite

GitHub Access Token became invalid

TryCatchTask A last analyzed 2017-12-07 07:58 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

TryCatchTask A
last analyzed 2017-12-07 07:58 UTC