Scheduler::executeTask() - Code Metrics - CuyZ/NotiZ - Measure and Improve Code Quality continuously with Scrutinizer

Scheduler::executeTask() A
last analyzed 2024-02-23 10:19 UTC

↳ Parent: Scheduler

Complexity

Conditions	2
Paths	3

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	14
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	22
rs	9.7998

<?php
declare(strict_types=1);

/*
 * Copyright (C)
 * Nathan Boiron <[email protected]>
 * Romain Canon <[email protected]>
 *
 * This file is part of the TYPO3 NotiZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace CuyZ\Notiz\Service\Scheduler;

use CuyZ\Notiz\Service\Container;
use Throwable;
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
filter:
    dependency_paths: ["lib/*"]
use TYPO3\CMS\Scheduler\Task\AbstractTask;
filter:
    dependency_paths: ["lib/*"]

/**
 * Overrides the TYPO3 core class in order to send signals on which NotiZ can
 * bind events.
 *
 * Two signals are sent:
 *
 * Signal: task was executed
 * -------------------------
 *
 * @see \CuyZ\Notiz\Service\Scheduler\Scheduler::SIGNAL_TASK_EXECUTED
 *
 * When a task was successfully executed.
 *
 * Two arguments are given to the slot:
 *
 * - `$task` - @see \TYPO3\CMS\Scheduler\Task\AbstractTask
 *   The executed task instance containing useful information.
 *
 * - `$result` - bool
 *   Result returned by the task execution process.
 *
 * Signal: task execution failed
 * -----------------------------
 *
 * @see \CuyZ\Notiz\Service\Scheduler\Scheduler::SIGNAL_TASK_FAILED
 *
 * When something has gone wrong during the execution of the task (an exception
 * has been thrown).
 *
 * Two arguments are given to the slot:
 *
 * - `$task` - @see \TYPO3\CMS\Scheduler\Task\AbstractTask
 *   The executed task instance containing useful information.
 *
 * - `$exception` - @see \Throwable
 *   The exception that was thrown during the execution.
 */
class Scheduler extends \TYPO3\CMS\Scheduler\Scheduler
filter:
    dependency_paths: ["lib/*"]
{
    const SIGNAL_TASK_EXECUTED = 'taskWasExecuted';

    const SIGNAL_TASK_FAILED = 'taskExecutionFailed';

    /**
     * @var Dispatcher
     */
    protected $dispatcher;

    public function __construct()
    {
        parent::__construct();

        $this->dispatcher = Container::get(Dispatcher::class);
    }

    /**
     * See class description for more information.
     *
     * @param AbstractTask $task
     * @return bool
     *
     * @throws Throwable
     */
    public function executeTask(AbstractTask $task): bool
    {
        $exception = null;


        try {
            $result = parent::executeTask($task);

            $this->dispatcher->dispatch(
                __CLASS__,
                self::SIGNAL_TASK_EXECUTED,
                [$task, $result]
            );

            return $result;
        } catch (Throwable $exception) {
            $this->dispatcher->dispatch(
                __CLASS__,
                self::SIGNAL_TASK_FAILED,
                [$task, $exception]
            );

            throw $exception;
        }
    }
}


1			<?php
2			declare(strict_types=1);
3
4			/*
5			* Copyright (C)
6			* Nathan Boiron <[email protected]>
7			* Romain Canon <[email protected]>
8			*
9			* This file is part of the TYPO3 NotiZ project.
10			* It is free software; you can redistribute it and/or modify it
11			* under the terms of the GNU General Public License, either
12			* version 3 of the License, or any later version.
13			*
14			* For the full copyright and license information, see:
15			* http://www.gnu.org/licenses/gpl-3.0.html
16			*/
17
18			namespace CuyZ\Notiz\Service\Scheduler;
19
20			use CuyZ\Notiz\Service\Container;
21			use Throwable;
22			use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
			0 ignored issues – show Bug introduced 2019-01-29 14:26 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Extbase\SignalSlot\Dispatcher` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			use TYPO3\CMS\Scheduler\Task\AbstractTask;
			0 ignored issues – show Bug introduced 2019-01-29 14:26 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Scheduler\Task\AbstractTask` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
24
25			/**
26			* Overrides the TYPO3 core class in order to send signals on which NotiZ can
27			* bind events.
28			*
29			* Two signals are sent:
30			*
31			* Signal: task was executed
32			* -------------------------
33			*
34			* @see \CuyZ\Notiz\Service\Scheduler\Scheduler::SIGNAL_TASK_EXECUTED
35			*
36			* When a task was successfully executed.
37			*
38			* Two arguments are given to the slot:
39			*
40			* - `$task` - @see \TYPO3\CMS\Scheduler\Task\AbstractTask
41			* The executed task instance containing useful information.
42			*
43			* - `$result` - bool
44			* Result returned by the task execution process.
45			*
46			* Signal: task execution failed
47			* -----------------------------
48			*
49			* @see \CuyZ\Notiz\Service\Scheduler\Scheduler::SIGNAL_TASK_FAILED
50			*
51			* When something has gone wrong during the execution of the task (an exception
52			* has been thrown).
53			*
54			* Two arguments are given to the slot:
55			*
56			* - `$task` - @see \TYPO3\CMS\Scheduler\Task\AbstractTask
57			* The executed task instance containing useful information.
58			*
59			* - `$exception` - @see \Throwable
60			* The exception that was thrown during the execution.
61			*/
62			class Scheduler extends \TYPO3\CMS\Scheduler\Scheduler
			0 ignored issues – show Bug introduced 2019-01-29 14:26 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Scheduler\Scheduler` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
63			{
64			const SIGNAL_TASK_EXECUTED = 'taskWasExecuted';
65
66			const SIGNAL_TASK_FAILED = 'taskExecutionFailed';
67
68			/**
69			* @var Dispatcher
70			*/
71			protected $dispatcher;
72
73			public function __construct()
74			{
75			parent::__construct();
76
77			$this->dispatcher = Container::get(Dispatcher::class);
78			}
79
80			/**
81			* See class description for more information.
82			*
83			* @param AbstractTask $task
84			* @return bool
85			*
86			* @throws Throwable
87			*/
88			public function executeTask(AbstractTask $task): bool
89			{
90			$exception = null;
			0 ignored issues – show Unused Code introduced 2019-01-23 10:20 UTC by Report Bug Copy Issue Report The assignment to `$exception` is dead and can be removed. Loading history...
91
92			try {
93			$result = parent::executeTask($task);
94
95			$this->dispatcher->dispatch(
96			__CLASS__,
97			self::SIGNAL_TASK_EXECUTED,
98			[$task, $result]
99			);
100
101			return $result;
102			} catch (Throwable $exception) {
103			$this->dispatcher->dispatch(
104			__CLASS__,
105			self::SIGNAL_TASK_FAILED,
106			[$task, $exception]
107			);
108
109			throw $exception;
110			}
111			}
112			}
113

CuyZ / NotiZ

Scheduler::executeTask() A last analyzed 2024-02-23 10:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Scheduler::executeTask() A
last analyzed 2024-02-23 10:19 UTC