TaskPlanner - Code Metrics - chrismichaels84/mistletoe - Measure and Improve Code Quality continuously with Scrutinizer

TaskPlanner C
last analyzed 2016-06-22 22:36 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	603
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

78.53%

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
wmc	66
c	2
b	1
f	0
lcom	1
cbo	3
dl	0
loc	603
ccs	139
cts	177
cp	0.7853
rs	5.7283

59 Methods

Rating	Name	Size	Complexity
A	add()	11	3
A	schedule()	5	1
A	always()	4	1
A	yearly()	5	1
A	annually()	4	1
A	monthly()	5	1
A	weekly()	5	1
A	daily()	5	1
A	hourly()	5	1
A	everyXHours()	5	1
A	everyXMinutes()	5	1
B	__call()	29	4
A	at()	5	1
A	atMidnight()	4	1
A	atNoon()	4	1
A	atMinute()	5	1
A	andAtMinute()	4	1
A	atHour()	5	1
A	andAtHour()	4	1
A	on()	5	1
A	andOn()	4	1
A	onDay()	5	1
A	andOnDay()	4	1
A	onMonth()	5	1
A	andOnMonth()	4	1
A	onWeekday()	5	1
A	andOnWeekday()	4	1
A	onSunday()	4	1
A	onMonday()	4	1
A	onTuesday()	4	1
A	onWednesday()	4	1
A	onFriday()	4	1
A	onSaturday()	4	1
A	onEnvironment()	5	1
A	setEnvironments()	9	1
A	onProductionOnly()	4	1
A	onDevelopmentOnly()	4	1
A	followedBy()	5	1
A	runDueTasks()	4	1
A	runAllTasks()	4	1
A	runTask()	4	1
A	runTasks()	4	1
A	setTaskRunner()	5	1
A	getTaskRunner()	11	2
A	getTasks()	4	1
A	getTask()	4	1
A	getDueTasks()	4	1
A	getNsPrefix()	4	1
A	setNsPrefix()	5	1
A	getCurrentEnvironment()	4	1
A	setCurrentEnvironment()	5	1
A	createNewTask()	9	2
A	setCurrentTask()	4	1
A	getCurrentTask()	4	1
A	getNextClosureIncrement()	5	1
A	getCurrentTime()	4	1
A	setCurrentTime()	5	1
A	flagForTesting()	4	1
A	onThursday()	4	1

How to fix Complexity

<?php
namespace Mistletoe;
use Mistletoe\Contracts\TaskRunnerInterface;
use Mistletoe\Runners\GenericTaskRunner;

/**
 * Class TaskPlanner
 * @package FBS\Planner
 */
class TaskPlanner
{
    /** @var array Tasks currently scheduled */
    protected $tasks = [];

    /** @var  TaskBag */
    protected $currentTask;

    /** @var  string Namespace prefix */
    protected $nsPrefix = '';

    protected $currentEnvironment = self::PRODUCTION_ENVIRONMENT;

    /* Environment Constants */
    const PRODUCTION_ENVIRONMENT = 'PRODUCTION';
    const DEVELOPMENT_ENVIRONMENT = 'DEVELOPMENT';

    /**
     * @var \Mistletoe\Contracts\TaskRunnerInterface
     */
    protected $taskRunner;

    /**
     * @var integer
     */
    protected $closureIncrement = 0;

    /**
     * @var string
     */
    protected $currentTime;

    /**
     * @var bool
     */
    protected $testing = false;

    /**
     * Begin a new Task Chain
     * @param string|\Closure $task
     * @return $this
     */
    public function add($task)
    {
        $body = null;
        if ($task instanceof \Closure || $task instanceof Command) {
            $body = $task;
            $task = $this->getNextClosureIncrement();
        }

        $this->createNewTask($task, $body);
        return $this;
    }

    /* Schedule a full expression */
    /**
     * Add a full expression
     * @param string $expression
     * @return $this
     */
    public function schedule($expression)
    {
        $this->getCurrentTask()->setCronExpression($expression);
        return $this;
    }

    public function always()
    {
        return $this->schedule('* * * * *');
    }

    /* Intervals */
    /**
     * @return $this
     */
    public function yearly()
    {
        $this->getCurrentTask()->setInterval('@yearly');
        return $this;
    }

    /**
     * @return TaskPlanner
     */
    public function annually()
    {
        return $this->yearly();
    }

    /**
     * @return $this
     */
    public function monthly()
    {
        $this->getCurrentTask()->setInterval('@monthly');
        return $this;
    }

    /**
     * @return $this
     */
    public function weekly()
    {
        $this->getCurrentTask()->setInterval('@weekly');
        return $this;
    }

    /**
     * @return $this
     */
    public function daily()
    {
        $this->getCurrentTask()->setInterval('@daily');
        return $this;
    }

    /**
     * @return $this
     */
    public function hourly()
    {
        $this->getCurrentTask()->setInterval('@hourly');
        return $this;
    }

    /* Time intervals */

    public function everyXHours($hrs)
    {
        $this->getCurrentTask()->setHour("*/{$hrs}");
        return $this;
    }

    public function everyXMinutes($mins)
    {
        $this->getCurrentTask()->setMinute("*/{$mins}");
        return $this;
    }

    /* @todo: this could be cleaned up and expanded for minutes, hours, days, and weeks
     * @param $name
     * @param $arguments
     * @return
     */
    public function __call($name, $arguments)

    {
        if (strpos($name, 'every') === false) {
            throw new \BadMethodCallException("{$name} is not a valid method. Did you mean everyXHours? or everyXMinutes()?");
        }

        // Get Increment
        $increment = $name;
        $increment = str_replace('every', '', $increment);
        $increment = str_replace('Minutes', '', $increment);
        $increment = str_replace('Hours', '', $increment);
        $increment = (int) $increment;

        // Get Hours or Minutes
        $method = $name;
        if (strpos($method, 'Minutes')){
            $method = 'Minutes';
        }

        if (strpos($method, 'Hours')) {
            $method = 'Hours';
        }

        // Build Method
        $method = "everyX{$method}";

        // Execute
        return $this->$method($increment);
    }

    /* Times */
    /**
     * @param string $time
     * @return $this
     */
    public function at($time)
    {
        $this->getCurrentTask()->addTime($time);
        return $this;
    }

    /**
     * @return TaskPlanner
     */
    public function atMidnight()
    {
        return $this->at('24:00');
    }

    /**
     * @return TaskPlanner
     */
    public function atNoon()
    {
        return $this->at('12:00');
    }

    /**
     * @param string|array|integer $minute
     * @return $this
     */
    public function atMinute($minute)
    {
        $this->getCurrentTask()->addMinute($minute);
        return $this;
    }

    /**
     * @param string|array|integer $minute
     * @return TaskPlanner
     */
    public function andAtMinute($minute)
    {
        return $this->atMinute($minute);
    }

    /**
     * @param string|array|integer $hour
     * @return $this
     */
    public function atHour($hour)
    {
        $this->getCurrentTask()->addHour($hour);
        return $this;
    }

    /**
     * @param string|array|integer $hour
     * @return TaskPlanner
     */
    public function andAtHour($hour)
    {
        return $this->atHour($hour);
    }

    /**
     * @param string|array|integer $date
     * @return $this
     */
    public function on($date)
    {
        $this->getCurrentTask()->addDate($date);
        return $this;
    }

    /**
     * @param string|array|integer $date
     * @return TaskPlanner
     */
    public function andOn($date)
    {
        return $this->on($date);
    }

    /**
     * @param string|array|integer $day
     * @return $this
     */
    public function onDay($day)
    {
        $this->getCurrentTask()->addDay($day);
        return $this;
    }

    /**
     * @param string|array|integer $day
     * @return TaskPlanner
     */
    public function andOnDay($day)
    {
        return $this->onDay($day);
    }

    /**
     * @param string|array|integer $month
     * @return $this
     */
    public function onMonth($month)
    {
        $this->getCurrentTask()->addMonth($month);
        return $this;
    }

    /**
     * @param string|array|integer $month
     * @return TaskPlanner
     */
    public function andOnMonth($month)
    {
        return $this->onMonth($month);
    }

    /**
     * @param string|array|integer $weekday
     * @return $this
     */
    public function onWeekday($weekday)
    {
        $this->getCurrentTask()->addWeekday($weekday);
        return $this;
    }

    /**
     * @param string|array|integer $weekday
     * @return TaskPlanner
     */
    public function andOnWeekday($weekday)
    {
        return $this->onWeekday($weekday);
    }

    /**
     * @return $this
     */
    public function onSunday()
    {
        return $this->onWeekday(0);
    }

    /**
     * @return TaskPlanner
     */
    public function onMonday()
    {
        return $this->onWeekday(1);
    }

    /**
     * @return TaskPlanner
     */
    public function onTuesday()
    {
        return $this->onWeekday(2);
    }

    /**
     * @return TaskPlanner
     */
    public function onWednesday()
    {
        return $this->onWeekday(3);
    }

    /**
     * @return TaskPlanner
     */
    public function onThursday()
    {
        return $this->onWeekday(4);
    }

    /**
     * @return TaskPlanner
     */
    public function onFriday()
    {
        return $this->onWeekday(5);
    }

    /**
     * @return TaskPlanner
     */
    public function onSaturday()
    {
        return $this->onWeekday(6);
    }

    /* Environments */
    /**
     * Restrict task to a specific environment
     * @param string $environment
     * @return $this
     */
    public function onEnvironment($environment)
    {
        $this->getCurrentTask()->addEnvironment(strtoupper($environment));
        return $this;
    }

    public function setEnvironments(array $environment)
    {
        array_map(function($value) {
            return strtoupper($value);
        }, $environment);

        $this->getCurrentTask()->setEnvironments($environment);
        return $this;
    }

    /* Alias for onEnvironment() */

    /**
     * @return TaskPlanner
     */
    public function onProductionOnly()
    {
        return $this->setEnvironments([static::PRODUCTION_ENVIRONMENT]);
    }

    /* Alias for onEnvironment() */

    /**
     * @return TaskPlanner
     */
    public function onDevelopmentOnly()
    {
        return $this->setEnvironments([static::DEVELOPMENT_ENVIRONMENT]);
    }

    /**
     * @param string $task
     * @return $this
     */
    public function followedBy($task)
    {
        $this->getCurrentTask()->addFollowedBy($task);
        return $this;
    }

    /* Running Tasks */
    /**
     * @return bool
     */
    public function runDueTasks()
    {
        return $this->getTaskRunner()->runDueTasks();
    }

    /**
     * @return bool
     */
    public function runAllTasks()
    {
        return $this->getTaskRunner()->runAllTasks();
    }

    /**
     * @param $task
     * @return bool
     */
    public function runTask($task)
    {
        return $this->getTaskRunner()->runTask($task);
    }

    /**
     * @param array $tasks
     * @return bool
     */
    public function runTasks(array $tasks)
    {
        return $this->getTaskRunner()->runTasks($tasks);
    }

    /* Getters and Setters */
    /**
     * @param \Mistletoe\Contracts\TaskRunnerInterface $runner
     * @return $this
     */
    public function setTaskRunner(TaskRunnerInterface $runner)
    {
        $this->taskRunner = $runner;
        return $this;
    }

    /**
     * @return TaskRunnerInterface
     */
    public function getTaskRunner()
    {
        $runner = $this->taskRunner ?: (new GenericTaskRunner($this->tasks));
        $runner
            ->setTaskBags($this->tasks)
            ->setCurrentEnvironment(strtoupper($this->currentEnvironment))
            ->setCurrentTime($this->currentTime)
            ->flagForTesting($this->testing);

        return $runner;
    }

    /**
     * @return array
     */
    public function getTasks()
    {
        return $this->tasks;
    }

    /**
     * @param string $name
     * @return TaskBag
     */
    public function getTask($name)
    {
        return $this->tasks[$name];
    }

    public function getDueTasks()
    {
        return $this->getTaskRunner()->getDueTasks();
    }

    /**
     * @return string
     */
    public function getNsPrefix()
    {
        return $this->nsPrefix;
    }

    /**
     * @param string $nsPrefix
     * @return $this
     */
    public function setNsPrefix($nsPrefix)
    {
        $this->nsPrefix = $nsPrefix;
        return $this;
    }

    /**
     * @return string
     */
    public function getCurrentEnvironment()
    {
        return $this->currentEnvironment;
    }

    /**
     * @param string $currentEnvironment
     * @return $this
     */
    public function setCurrentEnvironment($currentEnvironment)
    {
        $this->currentEnvironment = strtoupper($currentEnvironment);
        return $this;
    }

    /* Internal Methods */
    /**
     * @param string $task
     * @param \Closure|null $body
     */
    protected function createNewTask($task, $body = null)
    {
        $this->tasks[$task] = new TaskBag($task);
        $this->setCurrentTask($task);

        $this->getCurrentTask()->setTask(
            ($body) ? $body : $task
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        );
            }

    /**
     * @param string $task
     */
    protected function setCurrentTask($task)
    {
        $this->currentTask = $this->tasks[$task];
    }

    /**
     * @return TaskBag
     */
    protected function getCurrentTask()
    {
        return $this->currentTask;
    }

    /**
     * @return null|string
     */
    private function getNextClosureIncrement()
    {
        $this->closureIncrement++;
        return "_task{$this->closureIncrement}";
    }

    /**
     * @return string
     */
    public function getCurrentTime()
    {
        return $this->currentTime;
    }

    /**
     * @param mixed $currentTime
     * @return $this
     */
    public function setCurrentTime($currentTime)
    {
        $this->currentTime = $currentTime;
        return $this;
    }

    public function flagForTesting()
    {
        $this->testing = true;
    }
}


1		<?php
2		namespace Mistletoe;
3		use Mistletoe\Contracts\TaskRunnerInterface;
4		use Mistletoe\Runners\GenericTaskRunner;
5
6		/**
7		* Class TaskPlanner
8		* @package FBS\Planner
9		*/
10		class TaskPlanner
11		{
12		/** @var array Tasks currently scheduled */
13		protected $tasks = [];
14
15		/** @var TaskBag */
16		protected $currentTask;
17
18		/** @var string Namespace prefix */
19		protected $nsPrefix = '';
20
21		protected $currentEnvironment = self::PRODUCTION_ENVIRONMENT;
22
23		/* Environment Constants */
24		const PRODUCTION_ENVIRONMENT = 'PRODUCTION';
25		const DEVELOPMENT_ENVIRONMENT = 'DEVELOPMENT';
26
27		/**
28		* @var \Mistletoe\Contracts\TaskRunnerInterface
29		*/
30		protected $taskRunner;
31
32		/**
33		* @var integer
34		*/
35		protected $closureIncrement = 0;
36
37		/**
38		* @var string
39		*/
40		protected $currentTime;
41
42		/**
43		* @var bool
44		*/
45		protected $testing = false;
46
47		/**
48		* Begin a new Task Chain
49		* @param string\|\Closure $task
50		* @return $this
51		*/
52	26	public function add($task)
53		{
54	26	$body = null;
55	26	if ($task instanceof \Closure \|\| $task instanceof Command) {
56	1	$body = $task;
57	1	$task = $this->getNextClosureIncrement();
58	1	}
59
60	26	$this->createNewTask($task, $body);
61	26	return $this;
62		}
63
64		/* Schedule a full expression */
65		/**
66		* Add a full expression
67		* @param string $expression
68		* @return $this
69		*/
70	8	public function schedule($expression)
71		{
72	8	$this->getCurrentTask()->setCronExpression($expression);
73	8	return $this;
74		}
75
76	5	public function always()
77		{
78	5	return $this->schedule('* * * * *');
79		}
80
81		/* Intervals */
82		/**
83		* @return $this
84		*/
85	3	public function yearly()
86		{
87	3	$this->getCurrentTask()->setInterval('@yearly');
88	3	return $this;
89		}
90
91		/**
92		* @return TaskPlanner
93		*/
94	2	public function annually()
95		{
96	2	return $this->yearly();
97		}
98
99		/**
100		* @return $this
101		*/
102	5	public function monthly()
103		{
104	5	$this->getCurrentTask()->setInterval('@monthly');
105	5	return $this;
106		}
107
108		/**
109		* @return $this
110		*/
111	2	public function weekly()
112		{
113	2	$this->getCurrentTask()->setInterval('@weekly');
114	2	return $this;
115		}
116
117		/**
118		* @return $this
119		*/
120	10	public function daily()
121		{
122	10	$this->getCurrentTask()->setInterval('@daily');
123	10	return $this;
124		}
125
126		/**
127		* @return $this
128		*/
129	3	public function hourly()
130		{
131	3	$this->getCurrentTask()->setInterval('@hourly');
132	3	return $this;
133		}
134
135		/* Time intervals */
136
137	1	public function everyXHours($hrs)
138		{
139	1	$this->getCurrentTask()->setHour("*/{$hrs}");
140	1	return $this;
141		}
142
143	1	public function everyXMinutes($mins)
144		{
145	1	$this->getCurrentTask()->setMinute("*/{$mins}");
146	1	return $this;
147		}
148
149		/* @todo: this could be cleaned up and expanded for minutes, hours, days, and weeks
150		* @param $name
151		* @param $arguments
152		* @return
153		*/
154	1	public function __call($name, $arguments)
		0 ignored issues – show Documentation introduced 2016-06-22 18:31 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
155		{
156	1	if (strpos($name, 'every') === false) {
157		throw new \BadMethodCallException("{$name} is not a valid method. Did you mean everyXHours? or everyXMinutes()?");
158		}
159
160		// Get Increment
161	1	$increment = $name;
162	1	$increment = str_replace('every', '', $increment);
163	1	$increment = str_replace('Minutes', '', $increment);
164	1	$increment = str_replace('Hours', '', $increment);
165	1	$increment = (int) $increment;
166
167		// Get Hours or Minutes
168	1	$method = $name;
169	1	if (strpos($method, 'Minutes')){
170	1	$method = 'Minutes';
171	1	}
172
173	1	if (strpos($method, 'Hours')) {
174	1	$method = 'Hours';
175	1	}
176
177		// Build Method
178	1	$method = "everyX{$method}";
179
180		// Execute
181	1	return $this->$method($increment);
182		}
183
184		/* Times */
185		/**
186		* @param string $time
187		* @return $this
188		*/
189	12	public function at($time)
190		{
191	12	$this->getCurrentTask()->addTime($time);
192	12	return $this;
193		}
194
195		/**
196		* @return TaskPlanner
197		*/
198	3	public function atMidnight()
199		{
200	3	return $this->at('24:00');
201		}
202
203		/**
204		* @return TaskPlanner
205		*/
206	1	public function atNoon()
207		{
208	1	return $this->at('12:00');
209		}
210
211		/**
212		* @param string\|array\|integer $minute
213		* @return $this
214		*/
215	2	public function atMinute($minute)
216		{
217	2	$this->getCurrentTask()->addMinute($minute);
218	2	return $this;
219		}
220
221		/**
222		* @param string\|array\|integer $minute
223		* @return TaskPlanner
224		*/
225	2	public function andAtMinute($minute)
226		{
227	2	return $this->atMinute($minute);
228		}
229
230		/**
231		* @param string\|array\|integer $hour
232		* @return $this
233		*/
234	2	public function atHour($hour)
235		{
236	2	$this->getCurrentTask()->addHour($hour);
237	2	return $this;
238		}
239
240		/**
241		* @param string\|array\|integer $hour
242		* @return TaskPlanner
243		*/
244	1	public function andAtHour($hour)
245		{
246	1	return $this->atHour($hour);
247		}
248
249		/**
250		* @param string\|array\|integer $date
251		* @return $this
252		*/
253	4	public function on($date)
254		{
255	4	$this->getCurrentTask()->addDate($date);
256	4	return $this;
257		}
258
259		/**
260		* @param string\|array\|integer $date
261		* @return TaskPlanner
262		*/
263	2	public function andOn($date)
264		{
265	2	return $this->on($date);
266		}
267
268		/**
269		* @param string\|array\|integer $day
270		* @return $this
271		*/
272	5	public function onDay($day)
273		{
274	5	$this->getCurrentTask()->addDay($day);
275	5	return $this;
276		}
277
278		/**
279		* @param string\|array\|integer $day
280		* @return TaskPlanner
281		*/
282	4	public function andOnDay($day)
283		{
284	4	return $this->onDay($day);
285		}
286
287		/**
288		* @param string\|array\|integer $month
289		* @return $this
290		*/
291	4	public function onMonth($month)
292		{
293	4	$this->getCurrentTask()->addMonth($month);
294	4	return $this;
295		}
296
297		/**
298		* @param string\|array\|integer $month
299		* @return TaskPlanner
300		*/
301	1	public function andOnMonth($month)
302		{
303	1	return $this->onMonth($month);
304		}
305
306		/**
307		* @param string\|array\|integer $weekday
308		* @return $this
309		*/
310	3	public function onWeekday($weekday)
311		{
312	3	$this->getCurrentTask()->addWeekday($weekday);
313	3	return $this;
314		}
315
316		/**
317		* @param string\|array\|integer $weekday
318		* @return TaskPlanner
319		*/
320		public function andOnWeekday($weekday)
321		{
322		return $this->onWeekday($weekday);
323		}
324
325		/**
326		* @return $this
327		*/
328	2	public function onSunday()
329		{
330	2	return $this->onWeekday(0);
331		}
332
333		/**
334		* @return TaskPlanner
335		*/
336		public function onMonday()
337		{
338		return $this->onWeekday(1);
339		}
340
341		/**
342		* @return TaskPlanner
343		*/
344		public function onTuesday()
345		{
346		return $this->onWeekday(2);
347		}
348
349		/**
350		* @return TaskPlanner
351		*/
352		public function onWednesday()
353		{
354		return $this->onWeekday(3);
355		}
356
357		/**
358		* @return TaskPlanner
359		*/
360	1	public function onThursday()
361		{
362		return $this->onWeekday(4);
363	1	}
364
365		/**
366		* @return TaskPlanner
367		*/
368		public function onFriday()
369		{
370		return $this->onWeekday(5);
371		}
372
373		/**
374		* @return TaskPlanner
375		*/
376	3	public function onSaturday()
377		{
378	3	return $this->onWeekday(6);
379		}
380
381		/* Environments */
382		/**
383		* Restrict task to a specific environment
384		* @param string $environment
385		* @return $this
386		*/
387	2	public function onEnvironment($environment)
388		{
389	2	$this->getCurrentTask()->addEnvironment(strtoupper($environment));
390	2	return $this;
391		}
392
393		public function setEnvironments(array $environment)
394		{
395	3	array_map(function($value) {
396	3	return strtoupper($value);
397	3	}, $environment);
398
399	3	$this->getCurrentTask()->setEnvironments($environment);
400	3	return $this;
401		}
402
403		/* Alias for onEnvironment() */
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-22 18:31 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
404		/**
405		* @return TaskPlanner
406		*/
407	2	public function onProductionOnly()
408		{
409	2	return $this->setEnvironments([static::PRODUCTION_ENVIRONMENT]);
410		}
411
412		/* Alias for onEnvironment() */
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-22 18:31 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
413		/**
414		* @return TaskPlanner
415		*/
416	2	public function onDevelopmentOnly()
417		{
418	2	return $this->setEnvironments([static::DEVELOPMENT_ENVIRONMENT]);
419		}
420
421		/**
422		* @param string $task
423		* @return $this
424		*/
425	7	public function followedBy($task)
426		{
427	7	$this->getCurrentTask()->addFollowedBy($task);
428	7	return $this;
429		}
430
431		/* Running Tasks */
432		/**
433		* @return bool
434		*/
435	1	public function runDueTasks()
436		{
437	1	return $this->getTaskRunner()->runDueTasks();
438		}
439
440		/**
441		* @return bool
442		*/
443		public function runAllTasks()
444		{
445		return $this->getTaskRunner()->runAllTasks();
446		}
447
448		/**
449		* @param $task
450		* @return bool
451		*/
452		public function runTask($task)
453		{
454		return $this->getTaskRunner()->runTask($task);
455		}
456
457		/**
458		* @param array $tasks
459		* @return bool
460		*/
461		public function runTasks(array $tasks)
462		{
463		return $this->getTaskRunner()->runTasks($tasks);
464		}
465
466		/* Getters and Setters */
467		/**
468		* @param \Mistletoe\Contracts\TaskRunnerInterface $runner
469		* @return $this
470		*/
471		public function setTaskRunner(TaskRunnerInterface $runner)
472		{
473		$this->taskRunner = $runner;
474		return $this;
475		}
476
477		/**
478		* @return TaskRunnerInterface
479		*/
480	1	public function getTaskRunner()
481		{
482	1	$runner = $this->taskRunner ?: (new GenericTaskRunner($this->tasks));
483		$runner
484	1	->setTaskBags($this->tasks)
485	1	->setCurrentEnvironment(strtoupper($this->currentEnvironment))
486	1	->setCurrentTime($this->currentTime)
487	1	->flagForTesting($this->testing);
488
489	1	return $runner;
490		}
491
492		/**
493		* @return array
494		*/
495	7	public function getTasks()
496		{
497	7	return $this->tasks;
498		}
499
500		/**
501		* @param string $name
502		* @return TaskBag
503		*/
504	15	public function getTask($name)
505		{
506	15	return $this->tasks[$name];
507		}
508
509		public function getDueTasks()
510		{
511		return $this->getTaskRunner()->getDueTasks();
512		}
513
514		/**
515		* @return string
516		*/
517		public function getNsPrefix()
518		{
519		return $this->nsPrefix;
520		}
521
522		/**
523		* @param string $nsPrefix
524		* @return $this
525		*/
526		public function setNsPrefix($nsPrefix)
527		{
528		$this->nsPrefix = $nsPrefix;
529		return $this;
530		}
531
532		/**
533		* @return string
534		*/
535		public function getCurrentEnvironment()
536		{
537		return $this->currentEnvironment;
538		}
539
540		/**
541		* @param string $currentEnvironment
542		* @return $this
543		*/
544		public function setCurrentEnvironment($currentEnvironment)
545		{
546		$this->currentEnvironment = strtoupper($currentEnvironment);
547		return $this;
548		}
549
550		/* Internal Methods */
551		/**
552		* @param string $task
553		* @param \Closure\|null $body
554		*/
555	26	protected function createNewTask($task, $body = null)
556		{
557	26	$this->tasks[$task] = new TaskBag($task);
558	26	$this->setCurrentTask($task);
559
560	26	$this->getCurrentTask()->setTask(
561	26	($body) ? $body : $task
		0 ignored issues – show Bug introduced 2016-06-22 18:58 UTC by Report Bug Copy Issue Report It seems like `$body ? $body : $task` can also be of type `object<Closure>`; however, `Mistletoe\TaskBag::setTask()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
562	26	);
563	26	}
564
565		/**
566		* @param string $task
567		*/
568	26	protected function setCurrentTask($task)
569		{
570	26	$this->currentTask = $this->tasks[$task];
571	26	}
572
573		/**
574		* @return TaskBag
575		*/
576	26	protected function getCurrentTask()
577		{
578	26	return $this->currentTask;
579		}
580
581		/**
582		* @return null\|string
583		*/
584	1	private function getNextClosureIncrement()
585		{
586	1	$this->closureIncrement++;
587	1	return "_task{$this->closureIncrement}";
588		}
589
590		/**
591		* @return string
592		*/
593		public function getCurrentTime()
594		{
595		return $this->currentTime;
596		}
597
598		/**
599		* @param mixed $currentTime
600		* @return $this
601		*/
602	1	public function setCurrentTime($currentTime)
603		{
604	1	$this->currentTime = $currentTime;
605	1	return $this;
606		}
607
608		public function flagForTesting()
609		{
610		$this->testing = true;
611		}
612		}
613

chrismichaels84 / mistletoe

TaskPlanner C last analyzed 2016-06-22 22:36 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

59 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

TaskPlanner C
last analyzed 2016-06-22 22:36 UTC