jon48 / webtrees-lib

app/Module/Certificates/Elements/SourceCertificate.php

Indentation +52 added lines, -52 removed lines

@@ -28,61 +28,61 @@
  */
 class SourceCertificate extends AbstractElement
 {
-    protected CertificatesModule $module;
-    protected CertificateFilesystemService $certif_filesystem;
-    protected UrlObfuscatorService $url_obfuscator_service;
+	protected CertificatesModule $module;
+	protected CertificateFilesystemService $certif_filesystem;
+	protected UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for SourceCertificate element
-     *
-     * @param string $label
-     * @param CertificatesModule $module
-     * @param CertificateFilesystemService $certif_filesystem
-     * @param UrlObfuscatorService $url_obfuscator_service
-     */
-    public function __construct(
-        string $label,
-        CertificatesModule $module,
-        CertificateFilesystemService $certif_filesystem = null,
-        UrlObfuscatorService $url_obfuscator_service = null
-    ) {
-        parent::__construct($label, null);
-        $this->module = $module;
-        $this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
-        $this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
-    }
+	/**
+	 * Constructor for SourceCertificate element
+	 *
+	 * @param string $label
+	 * @param CertificatesModule $module
+	 * @param CertificateFilesystemService $certif_filesystem
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 */
+	public function __construct(
+		string $label,
+		CertificatesModule $module,
+		CertificateFilesystemService $certif_filesystem = null,
+		UrlObfuscatorService $url_obfuscator_service = null
+	) {
+		parent::__construct($label, null);
+		$this->module = $module;
+		$this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
+		$this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
-     */
-    public function canonical($value): string
-    {
-        return strtr($value, '\\', '/');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
+	 */
+	public function canonical($value): string
+	{
+		return strtr($value, '\\', '/');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
-     */
-    public function edit(string $id, string $name, string $value, Tree $tree): string
-    {
-        list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
+	 */
+	public function edit(string $id, string $name, string $value, Tree $tree): string
+	{
+		list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
 
-        $cities = array_map(function (string $item): array {
-            return [$this->url_obfuscator_service->obfuscate($item), $item];
-        }, $this->certif_filesystem->cities($tree));
+		$cities = array_map(function (string $item): array {
+			return [$this->url_obfuscator_service->obfuscate($item), $item];
+		}, $this->certif_filesystem->cities($tree));
 
-        return view($this->module->name() . '::components/edit-certificate', [
-            'module_name'   =>  $this->module->name(),
-            'tree'          =>  $tree,
-            'id'            =>  $id,
-            'name'          =>  $name,
-            'cities'        =>  $cities,
-            'value'         =>  $this->canonical($value),
-            'value_city'    =>  $city,
-            'value_file'    =>  $file,
-            'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
-        ]);
-    }
+		return view($this->module->name() . '::components/edit-certificate', [
+			'module_name'   =>  $this->module->name(),
+			'tree'          =>  $tree,
+			'id'            =>  $id,
+			'name'          =>  $name,
+			'cities'        =>  $cities,
+			'value'         =>  $this->canonical($value),
+			'value_city'    =>  $city,
+			'value_file'    =>  $file,
+			'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
+		]);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -69,11 +69,11 @@
     {
         list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
 
-        $cities = array_map(function (string $item): array {
+        $cities = array_map(function(string $item): array {
             return [$this->url_obfuscator_service->obfuscate($item), $item];
         }, $this->certif_filesystem->cities($tree));
 
-        return view($this->module->name() . '::components/edit-certificate', [
+        return view($this->module->name().'::components/edit-certificate', [
             'module_name'   =>  $this->module->name(),
             'tree'          =>  $tree,
             'id'            =>  $id,

app/Module/AdminTasks/Http/RequestHandlers/TasksList.php

Indentation +82 added lines, -82 removed lines

@@ -31,90 +31,90 @@
  */
 class TasksList implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TasksList Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        TaskScheduleService $taskschedules_service
-    ) {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TasksList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		TaskScheduleService $taskschedules_service
+	) {
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $module = $this->module;
-        $module_name = $this->module->name();
-        return response(['data' => $this->taskschedules_service->all(true, true)
-            ->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
-                $task = $this->taskschedules_service->findTask($schedule->taskId());
-                $task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
+		$module = $this->module;
+		$module_name = $this->module->name();
+		return response(['data' => $this->taskschedules_service->all(true, true)
+			->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
+				$task = $this->taskschedules_service->findTask($schedule->taskId());
+				$task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
 
-                return [
-                    'edit' =>   view($module_name . '::admin/tasks-table-options', [
-                        'task_sched_id' => $schedule->id(),
-                        'task_sched_enabled' => $schedule->isEnabled(),
-                        'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
-                        'task_status_route' => route(TaskStatusAction::class, [
-                            'task' => $schedule->id(),
-                            'enable' => $schedule->isEnabled() ? 0 : 1
-                        ])
-                    ]),
-                    'status'    =>  [
-                        'display'   =>  view($module_name . '::components/yes-no-icons', [
-                            'yes' => $schedule->isEnabled()
-                        ]),
-                        'raw'       =>  $schedule->isEnabled() ? 1 : 0
-                    ],
-                    'task_name' =>  [
-                        'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
-                        'raw'       =>  $task_name
-                    ],
-                    'last_run'  =>  [
-                        'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
-                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
-                            view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
-                        'raw'       =>  $schedule->lastRunTime()->unix()
-                    ],
-                    'last_result'   =>  [
-                        'display'   => view($module_name . '::components/yes-no-icons', [
-                            'yes' => $schedule->wasLastRunSuccess()
-                        ]),
-                        'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
-                    ],
-                    'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
-                    'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
-                        I18N::number($schedule->remainingOccurences()) :
-                        I18N::translate('Unlimited'),
-                    'running'   =>  view($module_name . '::components/yes-no-icons', [
-                        'yes' => $schedule->isRunning(),
-                        'text_yes' => I18N::translate('Running'),
-                        'text_no' => I18N::translate('Not running')
-                    ]),
-                    'run'       =>  view($module_name . '::admin/tasks-table-run', [
-                        'task_sched_id' => $schedule->id(),
-                        'run_route' => route(TaskTrigger::class, [
-                            'task'  =>  $schedule->taskId(),
-                            'force' =>  $module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
-                        ])
-                    ])
-                ];
-            })
-        ]);
-    }
+				return [
+					'edit' =>   view($module_name . '::admin/tasks-table-options', [
+						'task_sched_id' => $schedule->id(),
+						'task_sched_enabled' => $schedule->isEnabled(),
+						'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
+						'task_status_route' => route(TaskStatusAction::class, [
+							'task' => $schedule->id(),
+							'enable' => $schedule->isEnabled() ? 0 : 1
+						])
+					]),
+					'status'    =>  [
+						'display'   =>  view($module_name . '::components/yes-no-icons', [
+							'yes' => $schedule->isEnabled()
+						]),
+						'raw'       =>  $schedule->isEnabled() ? 1 : 0
+					],
+					'task_name' =>  [
+						'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
+						'raw'       =>  $task_name
+					],
+					'last_run'  =>  [
+						'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
+							view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
+							view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
+						'raw'       =>  $schedule->lastRunTime()->unix()
+					],
+					'last_result'   =>  [
+						'display'   => view($module_name . '::components/yes-no-icons', [
+							'yes' => $schedule->wasLastRunSuccess()
+						]),
+						'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
+					],
+					'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
+					'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
+						I18N::number($schedule->remainingOccurences()) :
+						I18N::translate('Unlimited'),
+					'running'   =>  view($module_name . '::components/yes-no-icons', [
+						'yes' => $schedule->isRunning(),
+						'text_yes' => I18N::translate('Running'),
+						'text_no' => I18N::translate('Not running')
+					]),
+					'run'       =>  view($module_name . '::admin/tasks-table-run', [
+						'task_sched_id' => $schedule->id(),
+						'run_route' => route(TaskTrigger::class, [
+							'task'  =>  $schedule->taskId(),
+							'force' =>  $module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
+						])
+					])
+				];
+			})
+		]);
+	}
 }

Spacing +10 added lines, -12 removed lines

@@ -61,12 +61,12 @@ 
         $module = $this->module;
         $module_name = $this->module->name();
         return response(['data' => $this->taskschedules_service->all(true, true)
-            ->map(function (TaskSchedule $schedule) use ($module, $module_name): array {
+            ->map(function(TaskSchedule $schedule) use ($module, $module_name): array {
                 $task = $this->taskschedules_service->findTask($schedule->taskId());
                 $task_name = $task !== null ? $task->name() : I18N::translate('Task not found');
 
                 return [
-                    'edit' =>   view($module_name . '::admin/tasks-table-options', [
+                    'edit' =>   view($module_name.'::admin/tasks-table-options', [
                         'task_sched_id' => $schedule->id(),
                         'task_sched_enabled' => $schedule->isEnabled(),
                         'task_edit_route' => route(TaskEditPage::class, ['task' => $schedule->id()]),
@@ -76,37 +76,35 @@ 
                         ])
                     ]),
                     'status'    =>  [
-                        'display'   =>  view($module_name . '::components/yes-no-icons', [
+                        'display'   =>  view($module_name.'::components/yes-no-icons', [
                             'yes' => $schedule->isEnabled()
                         ]),
                         'raw'       =>  $schedule->isEnabled() ? 1 : 0
                     ],
                     'task_name' =>  [
-                        'display'   =>  '<span dir="auto">' . e($task_name) . '</span>',
+                        'display'   =>  '<span dir="auto">'.e($task_name).'</span>',
                         'raw'       =>  $task_name
                     ],
                     'last_run'  =>  [
                         'display'   =>  $schedule->lastRunTime()->unix() === 0 ?
-                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) :
-                            view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
+                            view('components/datetime', ['timestamp' => $schedule->lastRunTime()]) : view('components/datetime-diff', ['timestamp' => $schedule->lastRunTime()]),
                         'raw'       =>  $schedule->lastRunTime()->unix()
                     ],
                     'last_result'   =>  [
-                        'display'   => view($module_name . '::components/yes-no-icons', [
+                        'display'   => view($module_name.'::components/yes-no-icons', [
                             'yes' => $schedule->wasLastRunSuccess()
                         ]),
                         'raw'       =>  $schedule->wasLastRunSuccess() ? 1 : 0
                     ],
-                    'frequency' =>  '<span dir="auto">' . e($schedule->frequency()->cascade()->forHumans()) . '</span>',
+                    'frequency' =>  '<span dir="auto">'.e($schedule->frequency()->cascade()->forHumans()).'</span>',
                     'nb_occurrences'    =>  $schedule->remainingOccurences() > 0 ?
-                        I18N::number($schedule->remainingOccurences()) :
-                        I18N::translate('Unlimited'),
-                    'running'   =>  view($module_name . '::components/yes-no-icons', [
+                        I18N::number($schedule->remainingOccurences()) : I18N::translate('Unlimited'),
+                    'running'   =>  view($module_name.'::components/yes-no-icons', [
                         'yes' => $schedule->isRunning(),
                         'text_yes' => I18N::translate('Running'),
                         'text_no' => I18N::translate('Not running')
                     ]),
-                    'run'       =>  view($module_name . '::admin/tasks-table-run', [
+                    'run'       =>  view($module_name.'::admin/tasks-table-run', [
                         'task_sched_id' => $schedule->id(),
                         'run_route' => route(TaskTrigger::class, [
                             'task'  =>  $schedule->taskId(),

app/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php

Indentation +147 added lines, -147 removed lines

@@ -33,151 +33,151 @@
  */
 class TaskEditAction implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
-
-    /**
-     * Constructor for TaskEditAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $admin_config_route = route(AdminConfigPage::class);
-
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
-
-        if ($task_schedule === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
-
-        $success = $this->updateGeneralSettings($task_schedule, $request);
-        $success = $success && $this->updateSpecificSettings($task_schedule, $request);
-
-        if ($success) {
-            FlashMessages::addMessage(
-                I18N::translate('The scheduled task has been successfully updated.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
-        }
-
-        return redirect($admin_config_route);
-    }
-
-    /**
-     * Update general settings for the task, based on the request parameters
-     *
-     * @param TaskSchedule $task_schedule
-     * @param ServerRequestInterface $request
-     * @return bool
-     */
-    private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
-    {
-        if ($this->module === null) {
-            return false;
-        }
-
-        $params = (array) $request->getParsedBody();
-
-        $frequency = (int) $params['frequency'];
-        if ($frequency > 0) {
-            $task_schedule->setFrequency(CarbonInterval::minutes($frequency));
-        } else {
-            FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
-        }
-
-        $is_limited = (bool) $params['is_limited'];
-        $nb_occur = (int) $params['nb_occur'];
-
-        if ($is_limited) {
-            if ($nb_occur > 0) {
-                $task_schedule->setRemainingOccurences($nb_occur);
-            } else {
-                FlashMessages::addMessage(
-                    I18N::translate('The number of remaining occurences is not in a valid format.'),
-                    'danger'
-                );
-            }
-        } else {
-            $task_schedule->setRemainingOccurences(0);
-        }
-
-        try {
-            $this->taskschedules_service->update($task_schedule);
-            return true;
-        } catch (Throwable $ex) {
-            Log::addErrorLog(
-                sprintf(
-                    'Error while updating the Task Schedule "%s". Exception: %s',
-                    $task_schedule->id(),
-                    $ex->getMessage()
-                )
-            );
-        }
-
-        FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
-        //@phpcs:ignore Generic.Files.LineLength.TooLong
-        Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
-        return false;
-    }
-
-    /**
-     * Update general settings for the task, based on the request parameters
-     *
-     * @param TaskSchedule $task_schedule
-     * @param ServerRequestInterface $request
-     * @return bool
-     */
-    private function updateSpecificSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
-    {
-        if ($this->module === null) {
-            return false;
-        }
-
-        $task = $this->taskschedules_service->findTask($task_schedule->taskId());
-        if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
-            return true;
-        }
-
-        /** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
-        if (!$task->updateConfig($request, $task_schedule)) {
-            FlashMessages::addMessage(
-                I18N::translate(
-                    'An error occured while updating the specific settings of administrative task “%s”.',
-                    $task->name()
-                ),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
-        }
-
-        return true;
-    }
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
+
+	/**
+	 * Constructor for TaskEditAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$admin_config_route = route(AdminConfigPage::class);
+
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
+
+		if ($task_schedule === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
+
+		$success = $this->updateGeneralSettings($task_schedule, $request);
+		$success = $success && $this->updateSpecificSettings($task_schedule, $request);
+
+		if ($success) {
+			FlashMessages::addMessage(
+				I18N::translate('The scheduled task has been successfully updated.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+		}
+
+		return redirect($admin_config_route);
+	}
+
+	/**
+	 * Update general settings for the task, based on the request parameters
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param ServerRequestInterface $request
+	 * @return bool
+	 */
+	private function updateGeneralSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
+	{
+		if ($this->module === null) {
+			return false;
+		}
+
+		$params = (array) $request->getParsedBody();
+
+		$frequency = (int) $params['frequency'];
+		if ($frequency > 0) {
+			$task_schedule->setFrequency(CarbonInterval::minutes($frequency));
+		} else {
+			FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
+		}
+
+		$is_limited = (bool) $params['is_limited'];
+		$nb_occur = (int) $params['nb_occur'];
+
+		if ($is_limited) {
+			if ($nb_occur > 0) {
+				$task_schedule->setRemainingOccurences($nb_occur);
+			} else {
+				FlashMessages::addMessage(
+					I18N::translate('The number of remaining occurences is not in a valid format.'),
+					'danger'
+				);
+			}
+		} else {
+			$task_schedule->setRemainingOccurences(0);
+		}
+
+		try {
+			$this->taskschedules_service->update($task_schedule);
+			return true;
+		} catch (Throwable $ex) {
+			Log::addErrorLog(
+				sprintf(
+					'Error while updating the Task Schedule "%s". Exception: %s',
+					$task_schedule->id(),
+					$ex->getMessage()
+				)
+			);
+		}
+
+		FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
+		//@phpcs:ignore Generic.Files.LineLength.TooLong
+		Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+		return false;
+	}
+
+	/**
+	 * Update general settings for the task, based on the request parameters
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param ServerRequestInterface $request
+	 * @return bool
+	 */
+	private function updateSpecificSettings(TaskSchedule $task_schedule, ServerRequestInterface $request): bool
+	{
+		if ($this->module === null) {
+			return false;
+		}
+
+		$task = $this->taskschedules_service->findTask($task_schedule->taskId());
+		if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
+			return true;
+		}
+
+		/** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
+		if (!$task->updateConfig($request, $task_schedule)) {
+			FlashMessages::addMessage(
+				I18N::translate(
+					'An error occured while updating the specific settings of administrative task “%s”.',
+					$task->name()
+				),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
+		}
+
+		return true;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -64,7 +64,7 @@ 
             return redirect($admin_config_route);
         }
 
-        $task_sched_id = (int) $request->getAttribute('task');
+        $task_sched_id = (int)$request->getAttribute('task');
         $task_schedule = $this->taskschedules_service->find($task_sched_id);
 
         if ($task_schedule === null) {
@@ -84,7 +84,7 @@ 
                 'success'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” has been updated.');
         }
 
         return redirect($admin_config_route);
@@ -103,17 +103,17 @@ 
             return false;
         }
 
-        $params = (array) $request->getParsedBody();
+        $params = (array)$request->getParsedBody();
 
-        $frequency = (int) $params['frequency'];
+        $frequency = (int)$params['frequency'];
         if ($frequency > 0) {
             $task_schedule->setFrequency(CarbonInterval::minutes($frequency));
         } else {
             FlashMessages::addMessage(I18N::translate('The frequency is not in a valid format.'), 'danger');
         }
 
-        $is_limited = (bool) $params['is_limited'];
-        $nb_occur = (int) $params['nb_occur'];
+        $is_limited = (bool)$params['is_limited'];
+        $nb_occur = (int)$params['nb_occur'];
 
         if ($is_limited) {
             if ($nb_occur > 0) {
@@ -143,7 +143,7 @@ 
 
         FlashMessages::addMessage(I18N::translate('An error occured while updating the scheduled task.'), 'danger');
         //@phpcs:ignore Generic.Files.LineLength.TooLong
-        Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+        Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” could not be updated. See error log.');
         return false;
     }
 
@@ -175,7 +175,7 @@ 
                 'danger'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : AdminTask “' . $task->name() . '” specific settings could not be updated. See error log.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : AdminTask “'.$task->name().'” specific settings could not be updated. See error log.');
         }
 
         return true;

app/Module/AdminTasks/Http/RequestHandlers/TaskStatusAction.php

Indentation +55 added lines, -55 removed lines

@@ -29,68 +29,68 @@
  */
 class TaskStatusAction implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TaskStatusAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TaskStatusAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $admin_config_route = route(AdminConfigPage::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$admin_config_route = route(AdminConfigPage::class);
 
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
 
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
 
-        $admin_config_route = route(AdminConfigPage::class);
+		$admin_config_route = route(AdminConfigPage::class);
 
-        if ($task_schedule === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
-                'danger'
-            );
-            return redirect($admin_config_route);
-        }
+		if ($task_schedule === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The task shedule with ID “%s” does not exist.', I18N::number($task_sched_id)),
+				'danger'
+			);
+			return redirect($admin_config_route);
+		}
 
-        ((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
+		((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
 
-        if ($this->taskschedules_service->update($task_schedule) > 0) {
-            FlashMessages::addMessage(
-                I18N::translate('The scheduled task has been successfully updated.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
-        } else {
-            FlashMessages::addMessage(
-                I18N::translate('An error occured while updating the scheduled task.'),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
-        }
+		if ($this->taskschedules_service->update($task_schedule) > 0) {
+			FlashMessages::addMessage(
+				I18N::translate('The scheduled task has been successfully updated.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+		} else {
+			FlashMessages::addMessage(
+				I18N::translate('An error occured while updating the scheduled task.'),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+		}
 
-        return redirect($admin_config_route);
-    }
+		return redirect($admin_config_route);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -60,7 +60,7 @@ 
             return redirect($admin_config_route);
         }
 
-        $task_sched_id = (int) $request->getAttribute('task');
+        $task_sched_id = (int)$request->getAttribute('task');
         $task_schedule = $this->taskschedules_service->find($task_sched_id);
 
         $admin_config_route = route(AdminConfigPage::class);
@@ -73,7 +73,7 @@ 
             return redirect($admin_config_route);
         }
 
-        ((bool) $request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
+        ((bool)$request->getAttribute('enable', false)) ? $task_schedule->enable() : $task_schedule->disable();
 
         if ($this->taskschedules_service->update($task_schedule) > 0) {
             FlashMessages::addMessage(
@@ -81,14 +81,14 @@ 
                 'success'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” has been updated.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” has been updated.');
         } else {
             FlashMessages::addMessage(
                 I18N::translate('An error occured while updating the scheduled task.'),
                 'danger'
             );
             //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : Task Schedule “' . $task_schedule->id() . '” could not be updated. See error log.');
+            Log::addConfigurationLog('Module '.$this->module->title().' : Task Schedule “'.$task_schedule->id().'” could not be updated. See error log.');
         }
 
         return redirect($admin_config_route);

app/Module/AdminTasks/Http/RequestHandlers/AdminConfigPage.php

Indentation +37 added lines, -37 removed lines

@@ -29,47 +29,47 @@
  */
 class AdminConfigPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?AdminTasksModule $module;
-    private TokenService $token_service;
+	private ?AdminTasksModule $module;
+	private TokenService $token_service;
 
-    /**
-     * Constructor for Admin Config request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TokenService $token_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->token_service = $token_service;
-    }
+	/**
+	 * Constructor for Admin Config request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TokenService $token_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->token_service = $token_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
-        if ($token === '') {
-            $token = $this->token_service->generateRandomToken();
-            $this->module->setPreference('PAT_FORCE_EXEC_TOKEN', $token);
-        }
+		$token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
+		if ($token === '') {
+			$token = $this->token_service->generateRandomToken();
+			$this->module->setPreference('PAT_FORCE_EXEC_TOKEN', $token);
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/config', [
-            'title'             =>  $this->module->title(),
-            'trigger_token'     =>  $token,
-            'trigger_route'     =>  route(TaskTrigger::class, ['task' => '__TASKNAME__', 'force' => '__TOKEN__']),
-            'new_token_route'   =>  route(TokenGenerate::class),
-            'tasks_data_route'  =>  route(TasksList::class),
-            'js_script_url'     =>  $this->module->assetUrl('js/admintasks.min.js')
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/config', [
+			'title'             =>  $this->module->title(),
+			'trigger_token'     =>  $token,
+			'trigger_route'     =>  route(TaskTrigger::class, ['task' => '__TASKNAME__', 'force' => '__TOKEN__']),
+			'new_token_route'   =>  route(TokenGenerate::class),
+			'tasks_data_route'  =>  route(TasksList::class),
+			'js_script_url'     =>  $this->module->assetUrl('js/admintasks.min.js')
+		]);
+	}
 }

app/Module/AdminTasks/Http/RequestHandlers/TaskTrigger.php

Indentation +31 added lines, -31 removed lines

@@ -28,41 +28,41 @@
  */
 class TaskTrigger implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TaskTrigger request handler
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TaskTrigger request handler
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $task_id = $request->getAttribute('task');
-        $token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
-        $force_token = $request->getQueryParams()['force'] ?? '';
-        $force = $token == $force_token;
+		$task_id = $request->getAttribute('task');
+		$token = $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN');
+		$force_token = $request->getQueryParams()['force'] ?? '';
+		$force = $token == $force_token;
 
-        $task_schedules = $this->taskschedules_service->findTasksToRun($force, $task_id);
+		$task_schedules = $this->taskschedules_service->findTasksToRun($force, $task_id);
 
-        foreach ($task_schedules as $task_schedule) {
-            $this->taskschedules_service->run($task_schedule, $force);
-        }
+		foreach ($task_schedules as $task_schedule) {
+			$this->taskschedules_service->run($task_schedule, $force);
+		}
 
-        return response();
-    }
+		return response();
+	}
 }

app/Module/AdminTasks/Http/RequestHandlers/TaskEditPage.php

Indentation +44 added lines, -44 removed lines

@@ -30,58 +30,58 @@
  */
 class TaskEditPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?AdminTasksModule $module;
-    private TaskScheduleService $taskschedules_service;
+	private ?AdminTasksModule $module;
+	private TaskScheduleService $taskschedules_service;
 
-    /**
-     * Constructor for TaskEditPage Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     */
-    public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-    }
+	/**
+	 * Constructor for TaskEditPage Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 */
+	public function __construct(ModuleService $module_service, TaskScheduleService $taskschedules_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
 
-        if ($task_schedule === null) {
-            throw new HttpNotFoundException(I18N::translate('The Task schedule could not be found.'));
-        }
+		if ($task_schedule === null) {
+			throw new HttpNotFoundException(I18N::translate('The Task schedule could not be found.'));
+		}
 
-        $task = $this->taskschedules_service->findTask($task_schedule->taskId());
+		$task = $this->taskschedules_service->findTask($task_schedule->taskId());
 
-        if ($task === null) {
-            throw new HttpNotFoundException(I18N::translate('The Task schedule could not be found.'));
-        }
+		if ($task === null) {
+			throw new HttpNotFoundException(I18N::translate('The Task schedule could not be found.'));
+		}
 
-        $has_task_config = $task instanceof ConfigurableTaskInterface;
-        /** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
+		$has_task_config = $task instanceof ConfigurableTaskInterface;
+		/** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
 
-        return $this->viewResponse($this->module->name() . '::admin/tasks-edit', [
-            'module'            =>  $this->module,
-            'title'             =>  I18N::translate('Edit the administrative task') . ' - ' . $task->name(),
-            'task_schedule'     =>  $task_schedule,
-            'task'              =>  $task,
-            'has_task_config'   =>  $has_task_config,
-            'task_config_view'  =>  $has_task_config ? $task->configView($request) : ''
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/tasks-edit', [
+			'module'            =>  $this->module,
+			'title'             =>  I18N::translate('Edit the administrative task') . ' - ' . $task->name(),
+			'task_schedule'     =>  $task_schedule,
+			'task'              =>  $task,
+			'has_task_config'   =>  $has_task_config,
+			'task_config_view'  =>  $has_task_config ? $task->configView($request) : ''
+		]);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -59,7 +59,7 @@ 
             throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
         }
 
-        $task_sched_id = (int) $request->getAttribute('task');
+        $task_sched_id = (int)$request->getAttribute('task');
         $task_schedule = $this->taskschedules_service->find($task_sched_id);
 
         if ($task_schedule === null) {
@@ -75,9 +75,9 @@ 
         $has_task_config = $task instanceof ConfigurableTaskInterface;
         /** @var \MyArtJaub\Webtrees\Contracts\Tasks\TaskInterface&\MyArtJaub\Webtrees\Contracts\Tasks\ConfigurableTaskInterface $task */
 
-        return $this->viewResponse($this->module->name() . '::admin/tasks-edit', [
+        return $this->viewResponse($this->module->name().'::admin/tasks-edit', [
             'module'            =>  $this->module,
-            'title'             =>  I18N::translate('Edit the administrative task') . ' - ' . $task->name(),
+            'title'             =>  I18N::translate('Edit the administrative task').' - '.$task->name(),
             'task_schedule'     =>  $task_schedule,
             'task'              =>  $task,
             'has_task_config'   =>  $has_task_config,

app/Module/AdminTasks/Http/RequestHandlers/TokenGenerate.php

Indentation +30 added lines, -30 removed lines

@@ -30,34 +30,34 @@
  */
 class TokenGenerate implements RequestHandlerInterface
 {
-    private ?AdminTasksModule $module;
-    private TokenService $token_service;
-
-    /**
-     * Constructor for TokenGenerate request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, TokenService $token_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->token_service = $token_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-
-        $token = $this->token_service->generateRandomToken();
-        $this->module->setPreference('MAJ_AT_FORCE_EXEC_TOKEN', $token);
-        Log::addConfigurationLog($this->module->title() . ' : New token generated.');
-
-        return response(['token' => $token]);
-    }
+	private ?AdminTasksModule $module;
+	private TokenService $token_service;
+
+	/**
+	 * Constructor for TokenGenerate request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, TokenService $token_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->token_service = $token_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+
+		$token = $this->token_service->generateRandomToken();
+		$this->module->setPreference('MAJ_AT_FORCE_EXEC_TOKEN', $token);
+		Log::addConfigurationLog($this->module->title() . ' : New token generated.');
+
+		return response(['token' => $token]);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 
         $token = $this->token_service->generateRandomToken();
         $this->module->setPreference('MAJ_AT_FORCE_EXEC_TOKEN', $token);
-        Log::addConfigurationLog($this->module->title() . ' : New token generated.');
+        Log::addConfigurationLog($this->module->title().' : New token generated.');
 
         return response(['token' => $token]);
     }

app/Module/AdminTasks/Services/TaskScheduleService.php

Indentation +257 added lines, -257 removed lines

@@ -36,261 +36,261 @@
  */
 class TaskScheduleService
 {
-    /**
-     * Time-out after which the task will be considered not running any more.
-     * In seconds, default 5 mins.
-     * @var integer
-     */
-    public const TASK_TIME_OUT = 600;
-
-    private ModuleService $module_service;
-
-    /**
-     * Constructor for TaskScheduleService
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module_service = $module_service;
-    }
-
-    /**
-     * Returns all Tasks schedules in database.
-     * Stored records can be synchronised with the tasks actually available to the system.
-     *
-     * @param bool $sync_available Should tasks synchronised with available ones
-     * @param bool $include_disabled Should disabled tasks be returned
-     * @return Collection<TaskSchedule> Collection of TaskSchedule
-     */
-    public function all(bool $sync_available = false, bool $include_disabled = true): Collection
-    {
-        $tasks_schedules = DB::table('maj_admintasks')
-        ->select()
-        ->get()
-        ->map(self::rowMapper());
-
-        if ($sync_available) {
-            $available_tasks = clone $this->available();
-            foreach ($tasks_schedules as $task_schedule) {
-                /** @var TaskSchedule $task_schedule */
-                if ($available_tasks->has($task_schedule->taskId())) {
-                    $available_tasks->forget($task_schedule->taskId());
-                } else {
-                    $this->delete($task_schedule);
-                }
-            }
-
-            foreach ($available_tasks as $task_name => $task) {
-                /** @var TaskInterface $task */
-                $this->insertTask($task_name, $task->defaultFrequency());
-            }
-
-            return $this->all(false, $include_disabled);
-        }
-
-        return $tasks_schedules;
-    }
-
-    /**
-     * Returns tasks exposed through modules implementing ModuleTasksProviderInterface.
-     *
-     * @return Collection<array<string, string>>
-     */
-    public function available(): Collection
-    {
-        return Registry::cache()->array()->remember('maj-available-admintasks', function () {
-            return $this->module_service
-                ->findByInterface(ModuleTasksProviderInterface::class)
-                ->flatMap(fn(ModuleTasksProviderInterface $module) => $module->listTasks());
-        });
-    }
-
-    /**
-     * Find a task schedule by its ID.
-     *
-     * @param int $task_schedule_id
-     * @return TaskSchedule|NULL
-     */
-    public function find(int $task_schedule_id): ?TaskSchedule
-    {
-        return DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_id', '=', $task_schedule_id)
-            ->get()
-            ->map(self::rowMapper())
-            ->first();
-    }
-
-    /**
-     * Add a new task schedule with the specified task ID, and frequency if defined.
-     * Uses default for other settings.
-     *
-     * @param string $task_id
-     * @param int $frequency
-     * @return bool
-     */
-    public function insertTask(string $task_id, int $frequency = 0): bool
-    {
-        $values = ['majat_task_id' => $task_id];
-        if ($frequency > 0) {
-            $values['majat_frequency'] = $frequency;
-        }
-
-        return DB::table('maj_admintasks')
-            ->insert($values);
-    }
-
-    /**
-     * Update a task schedule.
-     * Returns the number of tasks schedules updated.
-     *
-     * @param TaskSchedule $task_schedule
-     * @return int
-     */
-    public function update(TaskSchedule $task_schedule): int
-    {
-        return DB::table('maj_admintasks')
-            ->where('majat_id', '=', $task_schedule->id())
-            ->update([
-                'majat_status'      =>  $task_schedule->isEnabled() ? 'enabled' : 'disabled',
-                'majat_last_run'    =>  $task_schedule->lastRunTime(),
-                'majat_last_result' =>  $task_schedule->wasLastRunSuccess(),
-                'majat_frequency'   =>  $task_schedule->frequency()->totalMinutes,
-                'majat_nb_occur'    =>  $task_schedule->remainingOccurences(),
-                'majat_running'     =>  $task_schedule->isRunning()
-            ]);
-    }
-
-    /**
-     * Delete a task schedule.
-     *
-     * @param TaskSchedule $task_schedule
-     * @return int
-     */
-    public function delete(TaskSchedule $task_schedule): int
-    {
-        return DB::table('maj_admintasks')
-            ->where('majat_id', '=', $task_schedule->id())
-            ->delete();
-    }
-
-    /**
-     * Find a task by its name
-     *
-     * @param string $task_id
-     * @return TaskInterface|NULL
-     */
-    public function findTask(string $task_id): ?TaskInterface
-    {
-        if ($this->available()->has($task_id)) {
-            return app($this->available()->get($task_id));
-        }
-        return null;
-    }
-
-    /**
-     * Retrieve all tasks that are candidates to be run.
-     *
-     * @param bool $force Should the run be forced
-     * @param string $task_id Specific task ID to be run
-     * @return Collection<TaskSchedule>
-     */
-    public function findTasksToRun(bool $force, string $task_id = null): Collection
-    {
-        $query = DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_status', '=', 'enabled')
-            ->where(function (Builder $query): void {
-
-                $query->where('majat_running', '=', 0)
-                ->orWhere('majat_last_run', '<=', Carbon::now()->subSeconds(self::TASK_TIME_OUT));
-            });
-
-        if (!$force) {
-            $query->where(function (Builder $query): void {
-
-                $query->where('majat_running', '=', 0)
-                    ->orWhereRaw('DATE_ADD(majat_last_run, INTERVAL majat_frequency MINUTE) <= NOW()');
-            });
-        }
-
-        if ($task_id !== null) {
-            $query->where('majat_task_id', '=', $task_id);
-        }
-
-        return $query->get()->map(self::rowMapper());
-    }
-
-    /**
-     * Run the task associated with the schedule.
-     * The task will run if either forced to, or its next scheduled run time has been exceeded.
-     * The last run time is recorded only if the task is successful.
-     *
-     * @param TaskSchedule $task_schedule
-     * @param boolean $force
-     */
-    public function run(TaskSchedule $task_schedule, $force = false): void
-    {
-        $task_schedule = DB::table('maj_admintasks')
-            ->select()
-            ->where('majat_id', '=', $task_schedule->id())
-            ->lockForUpdate()
-            ->get()
-            ->map(self::rowMapper())
-            ->first();
-
-        if (
-            !$task_schedule->isRunning() &&
-            ($force || $task_schedule->lastRunTime()->add($task_schedule->frequency())->lessThan(Carbon::now()))
-        ) {
-            $task_schedule->setLastResult(false);
-
-            $task = $this->findTask($task_schedule->taskId());
-            if ($task !== null) {
-                $task_schedule->startRunning();
-                $this->update($task_schedule);
-
-                $first_error = $task_schedule->wasLastRunSuccess();
-                try {
-                    $task_schedule->setLastResult($task->run($task_schedule));
-                } catch (Throwable $ex) {
-                    if ($first_error) { // Only record the first error, as this could fill the log.
-                        Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()) . ' ' .
-                            '[' . get_class($ex) . '] ' . $ex->getMessage() . ' ' . $ex->getFile() . ':'
-                            . $ex->getLine() . PHP_EOL . $ex->getTraceAsString());
-                    }
-                }
-
-                if ($task_schedule->wasLastRunSuccess()) {
-                    $task_schedule->setLastRunTime(Carbon::now());
-                    $task_schedule->decrementRemainingOccurences();
-                }
-                $task_schedule->stopRunning();
-            }
-            $this->update($task_schedule);
-        }
-    }
-
-    /**
-     * Mapper to return a TaskSchedule object from an object.
-     *
-     * @return Closure(stdClass $row): TaskSchedule
-     */
-    public static function rowMapper(): Closure
-    {
-        return static function (stdClass $row): TaskSchedule {
-
-            return new TaskSchedule(
-                (int) $row->majat_id,
-                $row->majat_task_id,
-                $row->majat_status === 'enabled',
-                Carbon::parse($row->majat_last_run),
-                (bool) $row->majat_last_result,
-                CarbonInterval::minutes($row->majat_frequency),
-                (int) $row->majat_nb_occur,
-                (bool) $row->majat_running
-            );
-        };
-    }
+	/**
+	 * Time-out after which the task will be considered not running any more.
+	 * In seconds, default 5 mins.
+	 * @var integer
+	 */
+	public const TASK_TIME_OUT = 600;
+
+	private ModuleService $module_service;
+
+	/**
+	 * Constructor for TaskScheduleService
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module_service = $module_service;
+	}
+
+	/**
+	 * Returns all Tasks schedules in database.
+	 * Stored records can be synchronised with the tasks actually available to the system.
+	 *
+	 * @param bool $sync_available Should tasks synchronised with available ones
+	 * @param bool $include_disabled Should disabled tasks be returned
+	 * @return Collection<TaskSchedule> Collection of TaskSchedule
+	 */
+	public function all(bool $sync_available = false, bool $include_disabled = true): Collection
+	{
+		$tasks_schedules = DB::table('maj_admintasks')
+		->select()
+		->get()
+		->map(self::rowMapper());
+
+		if ($sync_available) {
+			$available_tasks = clone $this->available();
+			foreach ($tasks_schedules as $task_schedule) {
+				/** @var TaskSchedule $task_schedule */
+				if ($available_tasks->has($task_schedule->taskId())) {
+					$available_tasks->forget($task_schedule->taskId());
+				} else {
+					$this->delete($task_schedule);
+				}
+			}
+
+			foreach ($available_tasks as $task_name => $task) {
+				/** @var TaskInterface $task */
+				$this->insertTask($task_name, $task->defaultFrequency());
+			}
+
+			return $this->all(false, $include_disabled);
+		}
+
+		return $tasks_schedules;
+	}
+
+	/**
+	 * Returns tasks exposed through modules implementing ModuleTasksProviderInterface.
+	 *
+	 * @return Collection<array<string, string>>
+	 */
+	public function available(): Collection
+	{
+		return Registry::cache()->array()->remember('maj-available-admintasks', function () {
+			return $this->module_service
+				->findByInterface(ModuleTasksProviderInterface::class)
+				->flatMap(fn(ModuleTasksProviderInterface $module) => $module->listTasks());
+		});
+	}
+
+	/**
+	 * Find a task schedule by its ID.
+	 *
+	 * @param int $task_schedule_id
+	 * @return TaskSchedule|NULL
+	 */
+	public function find(int $task_schedule_id): ?TaskSchedule
+	{
+		return DB::table('maj_admintasks')
+			->select()
+			->where('majat_id', '=', $task_schedule_id)
+			->get()
+			->map(self::rowMapper())
+			->first();
+	}
+
+	/**
+	 * Add a new task schedule with the specified task ID, and frequency if defined.
+	 * Uses default for other settings.
+	 *
+	 * @param string $task_id
+	 * @param int $frequency
+	 * @return bool
+	 */
+	public function insertTask(string $task_id, int $frequency = 0): bool
+	{
+		$values = ['majat_task_id' => $task_id];
+		if ($frequency > 0) {
+			$values['majat_frequency'] = $frequency;
+		}
+
+		return DB::table('maj_admintasks')
+			->insert($values);
+	}
+
+	/**
+	 * Update a task schedule.
+	 * Returns the number of tasks schedules updated.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @return int
+	 */
+	public function update(TaskSchedule $task_schedule): int
+	{
+		return DB::table('maj_admintasks')
+			->where('majat_id', '=', $task_schedule->id())
+			->update([
+				'majat_status'      =>  $task_schedule->isEnabled() ? 'enabled' : 'disabled',
+				'majat_last_run'    =>  $task_schedule->lastRunTime(),
+				'majat_last_result' =>  $task_schedule->wasLastRunSuccess(),
+				'majat_frequency'   =>  $task_schedule->frequency()->totalMinutes,
+				'majat_nb_occur'    =>  $task_schedule->remainingOccurences(),
+				'majat_running'     =>  $task_schedule->isRunning()
+			]);
+	}
+
+	/**
+	 * Delete a task schedule.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @return int
+	 */
+	public function delete(TaskSchedule $task_schedule): int
+	{
+		return DB::table('maj_admintasks')
+			->where('majat_id', '=', $task_schedule->id())
+			->delete();
+	}
+
+	/**
+	 * Find a task by its name
+	 *
+	 * @param string $task_id
+	 * @return TaskInterface|NULL
+	 */
+	public function findTask(string $task_id): ?TaskInterface
+	{
+		if ($this->available()->has($task_id)) {
+			return app($this->available()->get($task_id));
+		}
+		return null;
+	}
+
+	/**
+	 * Retrieve all tasks that are candidates to be run.
+	 *
+	 * @param bool $force Should the run be forced
+	 * @param string $task_id Specific task ID to be run
+	 * @return Collection<TaskSchedule>
+	 */
+	public function findTasksToRun(bool $force, string $task_id = null): Collection
+	{
+		$query = DB::table('maj_admintasks')
+			->select()
+			->where('majat_status', '=', 'enabled')
+			->where(function (Builder $query): void {
+
+				$query->where('majat_running', '=', 0)
+				->orWhere('majat_last_run', '<=', Carbon::now()->subSeconds(self::TASK_TIME_OUT));
+			});
+
+		if (!$force) {
+			$query->where(function (Builder $query): void {
+
+				$query->where('majat_running', '=', 0)
+					->orWhereRaw('DATE_ADD(majat_last_run, INTERVAL majat_frequency MINUTE) <= NOW()');
+			});
+		}
+
+		if ($task_id !== null) {
+			$query->where('majat_task_id', '=', $task_id);
+		}
+
+		return $query->get()->map(self::rowMapper());
+	}
+
+	/**
+	 * Run the task associated with the schedule.
+	 * The task will run if either forced to, or its next scheduled run time has been exceeded.
+	 * The last run time is recorded only if the task is successful.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @param boolean $force
+	 */
+	public function run(TaskSchedule $task_schedule, $force = false): void
+	{
+		$task_schedule = DB::table('maj_admintasks')
+			->select()
+			->where('majat_id', '=', $task_schedule->id())
+			->lockForUpdate()
+			->get()
+			->map(self::rowMapper())
+			->first();
+
+		if (
+			!$task_schedule->isRunning() &&
+			($force || $task_schedule->lastRunTime()->add($task_schedule->frequency())->lessThan(Carbon::now()))
+		) {
+			$task_schedule->setLastResult(false);
+
+			$task = $this->findTask($task_schedule->taskId());
+			if ($task !== null) {
+				$task_schedule->startRunning();
+				$this->update($task_schedule);
+
+				$first_error = $task_schedule->wasLastRunSuccess();
+				try {
+					$task_schedule->setLastResult($task->run($task_schedule));
+				} catch (Throwable $ex) {
+					if ($first_error) { // Only record the first error, as this could fill the log.
+						Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()) . ' ' .
+							'[' . get_class($ex) . '] ' . $ex->getMessage() . ' ' . $ex->getFile() . ':'
+							. $ex->getLine() . PHP_EOL . $ex->getTraceAsString());
+					}
+				}
+
+				if ($task_schedule->wasLastRunSuccess()) {
+					$task_schedule->setLastRunTime(Carbon::now());
+					$task_schedule->decrementRemainingOccurences();
+				}
+				$task_schedule->stopRunning();
+			}
+			$this->update($task_schedule);
+		}
+	}
+
+	/**
+	 * Mapper to return a TaskSchedule object from an object.
+	 *
+	 * @return Closure(stdClass $row): TaskSchedule
+	 */
+	public static function rowMapper(): Closure
+	{
+		return static function (stdClass $row): TaskSchedule {
+
+			return new TaskSchedule(
+				(int) $row->majat_id,
+				$row->majat_task_id,
+				$row->majat_status === 'enabled',
+				Carbon::parse($row->majat_last_run),
+				(bool) $row->majat_last_result,
+				CarbonInterval::minutes($row->majat_frequency),
+				(int) $row->majat_nb_occur,
+				(bool) $row->majat_running
+			);
+		};
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -99,7 +99,7 @@ 
      */
     public function available(): Collection
     {
-        return Registry::cache()->array()->remember('maj-available-admintasks', function () {
+        return Registry::cache()->array()->remember('maj-available-admintasks', function() {
             return $this->module_service
                 ->findByInterface(ModuleTasksProviderInterface::class)
                 ->flatMap(fn(ModuleTasksProviderInterface $module) => $module->listTasks());
@@ -201,14 +201,14 @@ 
         $query = DB::table('maj_admintasks')
             ->select()
             ->where('majat_status', '=', 'enabled')
-            ->where(function (Builder $query): void {
+            ->where(function(Builder $query): void {
 
                 $query->where('majat_running', '=', 0)
                 ->orWhere('majat_last_run', '<=', Carbon::now()->subSeconds(self::TASK_TIME_OUT));
             });
 
         if (!$force) {
-            $query->where(function (Builder $query): void {
+            $query->where(function(Builder $query): void {
 
                 $query->where('majat_running', '=', 0)
                     ->orWhereRaw('DATE_ADD(majat_last_run, INTERVAL majat_frequency MINUTE) <= NOW()');
@@ -256,9 +256,9 @@ 
                     $task_schedule->setLastResult($task->run($task_schedule));
                 } catch (Throwable $ex) {
                     if ($first_error) { // Only record the first error, as this could fill the log.
-                        Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()) . ' ' .
-                            '[' . get_class($ex) . '] ' . $ex->getMessage() . ' ' . $ex->getFile() . ':'
-                            . $ex->getLine() . PHP_EOL . $ex->getTraceAsString());
+                        Log::addErrorLog(I18N::translate('Error while running task %s:', $task->name()).' '.
+                            '['.get_class($ex).'] '.$ex->getMessage().' '.$ex->getFile().':'
+                            . $ex->getLine().PHP_EOL.$ex->getTraceAsString());
                     }
                 }
 
@@ -279,17 +279,17 @@ 
      */
     public static function rowMapper(): Closure
     {
-        return static function (stdClass $row): TaskSchedule {
+        return static function(stdClass $row): TaskSchedule {
 
             return new TaskSchedule(
-                (int) $row->majat_id,
+                (int)$row->majat_id,
                 $row->majat_task_id,
                 $row->majat_status === 'enabled',
                 Carbon::parse($row->majat_last_run),
-                (bool) $row->majat_last_result,
+                (bool)$row->majat_last_result,
                 CarbonInterval::minutes($row->majat_frequency),
-                (int) $row->majat_nb_occur,
-                (bool) $row->majat_running
+                (int)$row->majat_nb_occur,
+                (bool)$row->majat_running
             );
         };
     }