jon48 / webtrees-lib

src/Webtrees/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +153 added lines, -153 removed lines

@@ -30,157 +30,157 @@
  */
 class WelcomeBlockModule extends AbstractModuleMaj implements ModuleBlockInterface
 {
-    use ModuleBlockTrait;
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
-
-                $router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.6-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
-     */
-    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
-    {
-        $fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $content = view($this->name() . '::block-embed', [
-            'block_id'                  =>  $block_id,
-            'fab_welcome_block_view'    =>  $fab_welcome_block_view,
-            'fab_login_block_view'      =>  $fab_login_block_view,
-            'matomo_enabled'            =>  $this->isMatomoEnabled($block_id)
-        ]);
-
-        if ($context !== self::CONTEXT_EMBED) {
-            return view('modules/block-template', [
-                'block'      => Str::kebab($this->name()),
-                'id'         => $block_id,
-                'config_url' => $this->configUrl($tree, $context, $block_id),
-                'title'      => $tree->title(),
-                'content'    => $content,
-            ]);
-        }
-
-        return $content;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
-     */
-    public function isTreeBlock(): bool
-    {
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
-     */
-    public function editBlockConfiguration(Tree $tree, int $block_id): string
-    {
-        return view($this->name() . '::config', $this->matomoSettings($block_id));
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
-     */
-    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
-    {
-        $params = (array) $request->getParsedBody();
-
-        $matomo_enabled = $params['matomo_enabled'] == 'yes';
-        $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
-        if (!$matomo_enabled) {
-            return;
-        }
-
-        if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
-            return;
-        }
-
-        if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
-            return;
-        }
-
-        $this
-            ->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
-            ->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
-            ->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
-
-        app('cache.files')->forget($this->name() . '-matomovisits-yearly-' . $block_id);
-    }
-
-    /**
-     * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return bool
-     */
-    public function isMatomoEnabled(int $block_id): bool
-    {
-        return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
-    }
-
-    /**
-     * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return array<string, mixed>
-     */
-    public function matomoSettings(int $block_id): array
-    {
-        return [
-            'matomo_enabled' => $this->isMatomoEnabled($block_id),
-            'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
-            'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
-            'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
-        ];
-    }
+	use ModuleBlockTrait;
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
+
+				$router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.6-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
+	 */
+	public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
+	{
+		$fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$content = view($this->name() . '::block-embed', [
+			'block_id'                  =>  $block_id,
+			'fab_welcome_block_view'    =>  $fab_welcome_block_view,
+			'fab_login_block_view'      =>  $fab_login_block_view,
+			'matomo_enabled'            =>  $this->isMatomoEnabled($block_id)
+		]);
+
+		if ($context !== self::CONTEXT_EMBED) {
+			return view('modules/block-template', [
+				'block'      => Str::kebab($this->name()),
+				'id'         => $block_id,
+				'config_url' => $this->configUrl($tree, $context, $block_id),
+				'title'      => $tree->title(),
+				'content'    => $content,
+			]);
+		}
+
+		return $content;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
+	 */
+	public function isTreeBlock(): bool
+	{
+		return true;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
+	 */
+	public function editBlockConfiguration(Tree $tree, int $block_id): string
+	{
+		return view($this->name() . '::config', $this->matomoSettings($block_id));
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
+	 */
+	public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
+	{
+		$params = (array) $request->getParsedBody();
+
+		$matomo_enabled = $params['matomo_enabled'] == 'yes';
+		$this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
+		if (!$matomo_enabled) {
+			return;
+		}
+
+		if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
+			return;
+		}
+
+		if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
+			return;
+		}
+
+		$this
+			->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
+			->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
+			->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
+
+		app('cache.files')->forget($this->name() . '-matomovisits-yearly-' . $block_id);
+	}
+
+	/**
+	 * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return bool
+	 */
+	public function isMatomoEnabled(int $block_id): bool
+	{
+		return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
+	}
+
+	/**
+	 * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return array<string, mixed>
+	 */
+	public function matomoSettings(int $block_id): array
+	{
+		return [
+			'matomo_enabled' => $this->isMatomoEnabled($block_id),
+			'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
+			'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
+			'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
+		];
+	}
 }

src/Webtrees/Module/WelcomeBlock/Services/MatomoStatsService.php

Indentation +83 added lines, -83 removed lines

@@ -30,95 +30,95 @@
 class MatomoStatsService
 {
 
-    /**
-     * Returns the number of visits for the current year (up to the day before).
-     * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        $cache = Registry::cache()->file();
+	/**
+	 * Returns the number of visits for the current year (up to the day before).
+	 * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		$cache = Registry::cache()->file();
 
-        return $cache->remember(
-            $module->name() . '-matomovisits-yearly-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                $visits_year = $this->visits($module, $block_id, 'year');
-                if ($visits_year === null) {
-                    return null;
-                }
-                $visits_today = (int) $this->visits($module, $block_id, 'day');
+		return $cache->remember(
+			$module->name() . '-matomovisits-yearly-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				$visits_year = $this->visits($module, $block_id, 'year');
+				if ($visits_year === null) {
+					return null;
+				}
+				$visits_today = (int) $this->visits($module, $block_id, 'day');
 
-                return $visits_year - $visits_today;
-            },
-            Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
-        );
-    }
+				return $visits_year - $visits_today;
+			},
+			Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
+		);
+	}
 
-    /**
-     * Returns the number of visits for the current day.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return app('cache.array')->remember(
-            $module->name() . '-matomovisits-daily-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                return $this->visits($module, $block_id, 'day');
-            }
-        );
-    }
+	/**
+	 * Returns the number of visits for the current day.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return app('cache.array')->remember(
+			$module->name() . '-matomovisits-daily-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				return $this->visits($module, $block_id, 'day');
+			}
+		);
+	}
 
-    /**
-     * Invoke the Matomo API to retrieve the number of visits over a period.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @param string $period
-     * @return int|NULL
-     */
-    protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
-    {
-        $settings = $module->matomoSettings($block_id);
+	/**
+	 * Invoke the Matomo API to retrieve the number of visits over a period.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @param string $period
+	 * @return int|NULL
+	 */
+	protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
+	{
+		$settings = $module->matomoSettings($block_id);
 
-        if (
-            $settings['matomo_enabled'] === true
-            && mb_strlen($settings['matomo_url']) > 0
-            && mb_strlen($settings['matomo_token']) > 0
-            && $settings['matomo_siteid'] > 0
-        ) {
-            try {
-                $http_client = new Client([
-                    RequestOptions::TIMEOUT => 30
-                ]);
+		if (
+			$settings['matomo_enabled'] === true
+			&& mb_strlen($settings['matomo_url']) > 0
+			&& mb_strlen($settings['matomo_token']) > 0
+			&& $settings['matomo_siteid'] > 0
+		) {
+			try {
+				$http_client = new Client([
+					RequestOptions::TIMEOUT => 30
+				]);
 
-                $response = $http_client->get($settings['matomo_url'], [
-                    'query' =>  [
-                        'module'    =>  'API',
-                        'method'    =>  'VisitsSummary.getVisits',
-                        'idSite'    =>  $settings['matomo_siteid'],
-                        'period'    =>  $period,
-                        'date'      =>  'today',
-                        'token_auth' =>  $settings['matomo_token'],
-                        'format'    =>  'json'
-                    ]
-                ]);
+				$response = $http_client->get($settings['matomo_url'], [
+					'query' =>  [
+						'module'    =>  'API',
+						'method'    =>  'VisitsSummary.getVisits',
+						'idSite'    =>  $settings['matomo_siteid'],
+						'period'    =>  $period,
+						'date'      =>  'today',
+						'token_auth' =>  $settings['matomo_token'],
+						'format'    =>  'json'
+					]
+				]);
 
-                if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
-                    if ($result !== null) {
-                        return (int)$result;
-                    }
-                }
-            } catch (RequestException $ex) {
-            }
-        }
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+					if ($result !== null) {
+						return (int)$result;
+					}
+				}
+			} catch (RequestException $ex) {
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

src/Webtrees/Module/AdminTasks/AdminTasksModule.php

Indentation +118 added lines, -118 removed lines

@@ -40,123 +40,123 @@
  * Allow for tasks to be run on a (nearly-)regular schedule
  */
 class AdminTasksModule extends AbstractModuleMaj implements
-    ModuleCustomInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleTasksProviderInterface
+	ModuleCustomInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleTasksProviderInterface
 {
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-
-    //How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Administration Tasks');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Manage and run nearly-scheduled administration tasks.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::boot()
-     */
-    public function boot(): void
-    {
-        parent::boot();
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/admintasks', static function (Map $router): void {
-
-                $router->attach('', '/admin', static function (Map $router): void {
-
-                    $router->extras([
-                        'middleware' => [
-                            AuthAdministrator::class,
-                        ],
-                    ]);
-                    $router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
-
-                    $router->attach('', '/tasks', static function (Map $router): void {
-
-                        $router->get(TasksList::class, '', TasksList::class);
-                        $router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
-                        $router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
-                        $router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
-                    });
-                });
-
-                $router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
-                    ->allows(RequestMethodInterface::METHOD_POST);
-
-                $router->post(TokenGenerate::class, '/token', TokenGenerate::class)
-                    ->extras(['middleware' => [AuthAdministrator::class]]);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.5-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Contracts\ModuleTasksProviderInterface::listTasks()
-     */
-    public function listTasks(): array
-    {
-        return [
-            'maj-healthcheck' => HealthCheckEmailTask::class
-        ];
-    }
+	use ModuleConfigTrait;
+	use ModuleGlobalTrait;
+
+	//How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Administration Tasks');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Manage and run nearly-scheduled administration tasks.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::boot()
+	 */
+	public function boot(): void
+	{
+		parent::boot();
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/admintasks', static function (Map $router): void {
+
+				$router->attach('', '/admin', static function (Map $router): void {
+
+					$router->extras([
+						'middleware' => [
+							AuthAdministrator::class,
+						],
+					]);
+					$router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
+
+					$router->attach('', '/tasks', static function (Map $router): void {
+
+						$router->get(TasksList::class, '', TasksList::class);
+						$router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
+						$router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
+						$router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
+					});
+				});
+
+				$router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
+					->allows(RequestMethodInterface::METHOD_POST);
+
+				$router->post(TokenGenerate::class, '/token', TokenGenerate::class)
+					->extras(['middleware' => [AuthAdministrator::class]]);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.5-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Contracts\ModuleTasksProviderInterface::listTasks()
+	 */
+	public function listTasks(): array
+	{
+		return [
+			'maj-healthcheck' => HealthCheckEmailTask::class
+		];
+	}
 }

src/Webtrees/Module/AdminTasks/Model/TaskSchedule.php

Indentation +286 added lines, -286 removed lines

@@ -25,290 +25,290 @@
 class TaskSchedule
 {
 
-    /**
-     * Task Schedule ID
-     * @var int $id
-     */
-    private $id;
-
-    /**
-     * Task schedule status
-     * @var bool $enabled
-     */
-    private $enabled;
-
-    /**
-     * ID of the task attached to schedule
-     * @var string $task_id
-     */
-    private $task_id;
-
-    /**
-     * Last updated date
-     * @var Carbon $last_run
-     */
-    private $last_run;
-
-    /**
-     * Last run result
-     * @var bool $last_result
-     */
-    private $last_result;
-
-    /**
-     * Task run frequency
-     * @var CarbonInterval $frequency
-     */
-    private $frequency;
-
-    /**
-     * Task remaining runs
-     * @var int $nb_occurrences
-     */
-    private $nb_occurrences;
-
-    /**
-     * Current running status of the task
-     * @var bool $is_running
-     */
-    private $is_running;
-
-    /**
-     * Constructor for TaskSchedule
-     *
-     * @param int $id Schedule ID
-     * @param string $task_id Task ID
-     * @param bool $enabled Is the schedule enabled
-     * @param Carbon $last_run Last successful run date/time
-     * @param bool $last_result Result of the last run
-     * @param CarbonInterval $frequency Schedule frequency
-     * @param int $nb_occurrences Number of remaining occurrences to be run
-     * @param bool $is_running Is the task currently running
-     */
-    public function __construct(
-        int $id,
-        string $task_id,
-        bool $enabled,
-        Carbon $last_run,
-        bool $last_result,
-        CarbonInterval $frequency,
-        int $nb_occurrences,
-        bool $is_running
-    ) {
-        $this->id = $id;
-        $this->task_id = $task_id;
-        $this->enabled = $enabled;
-        $this->last_run = $last_run;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occurrences;
-        $this->is_running = $is_running;
-    }
-
-    /**
-     * Get the schedule ID.
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
-
-    /**
-     * Get the task ID.
-     *
-     * @return string
-     */
-    public function taskId(): string
-    {
-        return $this->task_id;
-    }
-
-    /**
-     * Returns whether the schedule is enabled
-     *
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled;
-    }
-
-    /**
-     * Enable the schedule
-     *
-     * @return self
-     */
-    public function enable(): self
-    {
-        $this->enabled = true;
-        return $this;
-    }
-
-    /**
-     * Disable the schedule
-     *
-     * @return self
-     */
-    public function disable(): self
-    {
-        $this->enabled = false;
-        return $this;
-    }
-
-    /**
-     * Get the frequency of the schedule
-     *
-     * @return CarbonInterval
-     */
-    public function frequency(): CarbonInterval
-    {
-        return $this->frequency;
-    }
-
-    /**
-     * Set the frequency of the schedule
-     *
-     * @param CarbonInterval $frequency
-     * @return self
-     */
-    public function setFrequency(CarbonInterval $frequency): self
-    {
-        $this->frequency = $frequency;
-        return $this;
-    }
-
-    /**
-     * Get the date/time of the last successful run.
-     *
-     * @return Carbon
-     */
-    public function lastRunTime(): Carbon
-    {
-        return $this->last_run;
-    }
-
-    /**
-     * Set the last successful run date/time
-     *
-     * @param Carbon $last_run
-     * @return self
-     */
-    public function setLastRunTime(Carbon $last_run): self
-    {
-        $this->last_run = $last_run;
-        return $this;
-    }
-
-    /**
-     * Returns whether the last run was successful
-     *
-     * @return bool
-     */
-    public function wasLastRunSuccess(): bool
-    {
-        return $this->last_result;
-    }
-
-    /**
-     * Set the last run result
-     *
-     * @param bool $last_result
-     * @return self
-     */
-    public function setLastResult(bool $last_result): self
-    {
-        $this->last_result = $last_result;
-        return $this;
-    }
-
-    /**
-     * Get the number of remaining of occurrences of task runs.
-     * Returns 0 if the tasks must be run indefinitely.
-     *
-     * @return int
-     */
-    public function remainingOccurences(): int
-    {
-        return $this->nb_occurrences;
-    }
-
-    /**
-     * Decrements the number of remaining occurences by 1.
-     * The task will be disabled when the number reaches 0.
-     *
-     * @return self
-     */
-    public function decrementRemainingOccurences(): self
-    {
-        if ($this->nb_occurrences > 0) {
-            $this->nb_occurrences--;
-            if ($this->nb_occurrences == 0) {
-                $this->disable();
-            }
-        }
-        return $this;
-    }
-
-    /**
-     * Set the number of remaining occurences of task runs.
-     *
-     * @param int $nb_occurrences
-     * @return self
-     */
-    public function setRemainingOccurences(int $nb_occurrences): self
-    {
-        $this->nb_occurrences = $nb_occurrences;
-        return $this;
-    }
-
-    /**
-     * Returns whether the task is running
-     * @return bool
-     */
-    public function isRunning(): bool
-    {
-        return $this->is_running;
-    }
-
-    /**
-     * Informs the schedule that the task is going to run
-     *
-     * @return self
-     */
-    public function startRunning(): self
-    {
-        $this->is_running = true;
-        return $this;
-    }
-
-    /**
-     * Informs the schedule that the task has stopped running.
-     * @return self
-     */
-    public function stopRunning(): self
-    {
-        $this->is_running = false;
-        return $this;
-    }
-
-    /**
-     * Returns the schedule details as an associate array
-     *
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return [
-            'id'            =>  $this->id,
-            'task_id'       =>  $this->task_id,
-            'enabled'       =>  $this->enabled,
-            'last_run'      =>  $this->last_run,
-            'last_result'   =>  $this->last_result,
-            'frequency'     =>  $this->frequency,
-            'nb_occurrences' =>  $this->nb_occurrences,
-            'is_running'    =>  $this->is_running
-        ];
-    }
+	/**
+	 * Task Schedule ID
+	 * @var int $id
+	 */
+	private $id;
+
+	/**
+	 * Task schedule status
+	 * @var bool $enabled
+	 */
+	private $enabled;
+
+	/**
+	 * ID of the task attached to schedule
+	 * @var string $task_id
+	 */
+	private $task_id;
+
+	/**
+	 * Last updated date
+	 * @var Carbon $last_run
+	 */
+	private $last_run;
+
+	/**
+	 * Last run result
+	 * @var bool $last_result
+	 */
+	private $last_result;
+
+	/**
+	 * Task run frequency
+	 * @var CarbonInterval $frequency
+	 */
+	private $frequency;
+
+	/**
+	 * Task remaining runs
+	 * @var int $nb_occurrences
+	 */
+	private $nb_occurrences;
+
+	/**
+	 * Current running status of the task
+	 * @var bool $is_running
+	 */
+	private $is_running;
+
+	/**
+	 * Constructor for TaskSchedule
+	 *
+	 * @param int $id Schedule ID
+	 * @param string $task_id Task ID
+	 * @param bool $enabled Is the schedule enabled
+	 * @param Carbon $last_run Last successful run date/time
+	 * @param bool $last_result Result of the last run
+	 * @param CarbonInterval $frequency Schedule frequency
+	 * @param int $nb_occurrences Number of remaining occurrences to be run
+	 * @param bool $is_running Is the task currently running
+	 */
+	public function __construct(
+		int $id,
+		string $task_id,
+		bool $enabled,
+		Carbon $last_run,
+		bool $last_result,
+		CarbonInterval $frequency,
+		int $nb_occurrences,
+		bool $is_running
+	) {
+		$this->id = $id;
+		$this->task_id = $task_id;
+		$this->enabled = $enabled;
+		$this->last_run = $last_run;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occurrences;
+		$this->is_running = $is_running;
+	}
+
+	/**
+	 * Get the schedule ID.
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
+
+	/**
+	 * Get the task ID.
+	 *
+	 * @return string
+	 */
+	public function taskId(): string
+	{
+		return $this->task_id;
+	}
+
+	/**
+	 * Returns whether the schedule is enabled
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled;
+	}
+
+	/**
+	 * Enable the schedule
+	 *
+	 * @return self
+	 */
+	public function enable(): self
+	{
+		$this->enabled = true;
+		return $this;
+	}
+
+	/**
+	 * Disable the schedule
+	 *
+	 * @return self
+	 */
+	public function disable(): self
+	{
+		$this->enabled = false;
+		return $this;
+	}
+
+	/**
+	 * Get the frequency of the schedule
+	 *
+	 * @return CarbonInterval
+	 */
+	public function frequency(): CarbonInterval
+	{
+		return $this->frequency;
+	}
+
+	/**
+	 * Set the frequency of the schedule
+	 *
+	 * @param CarbonInterval $frequency
+	 * @return self
+	 */
+	public function setFrequency(CarbonInterval $frequency): self
+	{
+		$this->frequency = $frequency;
+		return $this;
+	}
+
+	/**
+	 * Get the date/time of the last successful run.
+	 *
+	 * @return Carbon
+	 */
+	public function lastRunTime(): Carbon
+	{
+		return $this->last_run;
+	}
+
+	/**
+	 * Set the last successful run date/time
+	 *
+	 * @param Carbon $last_run
+	 * @return self
+	 */
+	public function setLastRunTime(Carbon $last_run): self
+	{
+		$this->last_run = $last_run;
+		return $this;
+	}
+
+	/**
+	 * Returns whether the last run was successful
+	 *
+	 * @return bool
+	 */
+	public function wasLastRunSuccess(): bool
+	{
+		return $this->last_result;
+	}
+
+	/**
+	 * Set the last run result
+	 *
+	 * @param bool $last_result
+	 * @return self
+	 */
+	public function setLastResult(bool $last_result): self
+	{
+		$this->last_result = $last_result;
+		return $this;
+	}
+
+	/**
+	 * Get the number of remaining of occurrences of task runs.
+	 * Returns 0 if the tasks must be run indefinitely.
+	 *
+	 * @return int
+	 */
+	public function remainingOccurences(): int
+	{
+		return $this->nb_occurrences;
+	}
+
+	/**
+	 * Decrements the number of remaining occurences by 1.
+	 * The task will be disabled when the number reaches 0.
+	 *
+	 * @return self
+	 */
+	public function decrementRemainingOccurences(): self
+	{
+		if ($this->nb_occurrences > 0) {
+			$this->nb_occurrences--;
+			if ($this->nb_occurrences == 0) {
+				$this->disable();
+			}
+		}
+		return $this;
+	}
+
+	/**
+	 * Set the number of remaining occurences of task runs.
+	 *
+	 * @param int $nb_occurrences
+	 * @return self
+	 */
+	public function setRemainingOccurences(int $nb_occurrences): self
+	{
+		$this->nb_occurrences = $nb_occurrences;
+		return $this;
+	}
+
+	/**
+	 * Returns whether the task is running
+	 * @return bool
+	 */
+	public function isRunning(): bool
+	{
+		return $this->is_running;
+	}
+
+	/**
+	 * Informs the schedule that the task is going to run
+	 *
+	 * @return self
+	 */
+	public function startRunning(): self
+	{
+		$this->is_running = true;
+		return $this;
+	}
+
+	/**
+	 * Informs the schedule that the task has stopped running.
+	 * @return self
+	 */
+	public function stopRunning(): self
+	{
+		$this->is_running = false;
+		return $this;
+	}
+
+	/**
+	 * Returns the schedule details as an associate array
+	 *
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return [
+			'id'            =>  $this->id,
+			'task_id'       =>  $this->task_id,
+			'enabled'       =>  $this->enabled,
+			'last_run'      =>  $this->last_run,
+			'last_result'   =>  $this->last_result,
+			'frequency'     =>  $this->frequency,
+			'nb_occurrences' =>  $this->nb_occurrences,
+			'is_running'    =>  $this->is_running
+		];
+	}
 }

src/Webtrees/Module/AdminTasks/Http/RequestHandlers/TokenGenerate.php

Indentation +31 added lines, -31 removed lines

@@ -29,35 +29,35 @@
  */
 class TokenGenerate implements RequestHandlerInterface
 {
-    /**
-     * @var AdminTasksModule $module
-     */
-    private $module;
-
-    /**
-     * Constructor for TokenGenerate request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-    }
-
-    /**
-     * {@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 = Functions::generateRandomToken();
-        $this->module->setPreference('MAJ_AT_FORCE_EXEC_TOKEN', $token);
-        Log::addConfigurationLog($this->module->title() . ' : New token generated.');
-
-        return response(['token' => $token]);
-    }
+	/**
+	 * @var AdminTasksModule $module
+	 */
+	private $module;
+
+	/**
+	 * Constructor for TokenGenerate request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+	}
+
+	/**
+	 * {@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 = Functions::generateRandomToken();
+		$this->module->setPreference('MAJ_AT_FORCE_EXEC_TOKEN', $token);
+		Log::addConfigurationLog($this->module->title() . ' : New token generated.');
+
+		return response(['token' => $token]);
+	}
 }

src/Webtrees/Module/AdminTasks/Http/RequestHandlers/TasksList.php

Indentation +106 added lines, -106 removed lines

@@ -31,110 +31,110 @@
  */
 class TasksList implements RequestHandlerInterface
 {
-    /**
-     * @var AdminTasksModule $module
-     */
-    private $module;
-
-    /**
-     * @var TaskScheduleService $taskschedules_service
-     */
-    private $taskschedules_service;
-
-    /**
-     * @var DatatablesService $datatables_service
-     */
-    private $datatables_service;
-
-    /**
-     * Constructor for TasksList Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TaskScheduleService $taskschedules_service
-     * @param DatatablesService $datatables_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        TaskScheduleService $taskschedules_service,
-        DatatablesService $datatables_service
-    ) {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->taskschedules_service = $taskschedules_service;
-        $this->datatables_service = $datatables_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.'));
-        }
-
-        $task_schedules = $this->taskschedules_service->all(true, true)
-            ->map(function (TaskSchedule $value): array {
-
-                $row = $value->toArray();
-                $task = $this->taskschedules_service->findTask($row['task_id']);
-                $row['task_name'] = $task !== null ? $task->name() : I18N::translate('Task not found');
-                return $row;
-            });
-
-        $search_columns = ['task_name'];
-        $sort_columns   = ['task_name', 'enabled', 'last_run'];
-        $module_name = $this->module->name();
-
-        $callback = function (array $row) use ($module_name): array {
-
-            $row['frequency']->setLocale(I18N::locale()->code());
-
-            $task_options_params = [
-                'task_sched_id' => $row['id'],
-                'task_sched_enabled' => $row['enabled'],
-                'task_edit_route' => route(TaskEditPage::class, ['task' => $row['id']]),
-                'task_status_route' => route(TaskStatusAction::class, [
-                    'task' => $row['id'],
-                    'enable' => $row['enabled'] ? 0 : 1
-                ])
-            ];
-
-            $task_run_params = [
-                'task_sched_id' => $row['id'],
-                'run_route' => route(TaskTrigger::class, [
-                    'task'  =>  $row['task_id'],
-                    'force' =>  $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
-                ])
-            ];
-
-            $datum = [
-                view($module_name . '::admin/tasks-table-options', $task_options_params),
-                view($module_name . '::components/yes-no-icons', ['yes' => $row['enabled']]),
-                '<span dir="auto">' . e($row['task_name']) . '</span>',
-                $row['last_run']->unix() === 0 ?
-                view('components/datetime', ['timestamp' => $row['last_run']]) :
-                view('components/datetime-diff', ['timestamp' => $row['last_run']]),
-                view($module_name . '::components/yes-no-icons', ['yes' => $row['last_result']]),
-                '<span dir="auto">' . e($row['frequency']->cascade()->forHumans()) . '</span>',
-                $row['nb_occurrences'] > 0 ? I18N::number($row['nb_occurrences']) : I18N::translate('Unlimited'),
-                view($module_name . '::components/yes-no-icons', [
-                    'yes' => $row['is_running'],
-                    'text_yes' => I18N::translate('Running'),
-                    'text_no' => I18N::translate('Not running')
-                ]),
-                view($module_name . '::admin/tasks-table-run', $task_run_params)
-            ];
-
-            return $datum;
-        };
-
-        return $this->datatables_service->handleCollection(
-            $request,
-            $task_schedules,
-            $search_columns,
-            $sort_columns,
-            $callback
-        );
-    }
+	/**
+	 * @var AdminTasksModule $module
+	 */
+	private $module;
+
+	/**
+	 * @var TaskScheduleService $taskschedules_service
+	 */
+	private $taskschedules_service;
+
+	/**
+	 * @var DatatablesService $datatables_service
+	 */
+	private $datatables_service;
+
+	/**
+	 * Constructor for TasksList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TaskScheduleService $taskschedules_service
+	 * @param DatatablesService $datatables_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		TaskScheduleService $taskschedules_service,
+		DatatablesService $datatables_service
+	) {
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->taskschedules_service = $taskschedules_service;
+		$this->datatables_service = $datatables_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.'));
+		}
+
+		$task_schedules = $this->taskschedules_service->all(true, true)
+			->map(function (TaskSchedule $value): array {
+
+				$row = $value->toArray();
+				$task = $this->taskschedules_service->findTask($row['task_id']);
+				$row['task_name'] = $task !== null ? $task->name() : I18N::translate('Task not found');
+				return $row;
+			});
+
+		$search_columns = ['task_name'];
+		$sort_columns   = ['task_name', 'enabled', 'last_run'];
+		$module_name = $this->module->name();
+
+		$callback = function (array $row) use ($module_name): array {
+
+			$row['frequency']->setLocale(I18N::locale()->code());
+
+			$task_options_params = [
+				'task_sched_id' => $row['id'],
+				'task_sched_enabled' => $row['enabled'],
+				'task_edit_route' => route(TaskEditPage::class, ['task' => $row['id']]),
+				'task_status_route' => route(TaskStatusAction::class, [
+					'task' => $row['id'],
+					'enable' => $row['enabled'] ? 0 : 1
+				])
+			];
+
+			$task_run_params = [
+				'task_sched_id' => $row['id'],
+				'run_route' => route(TaskTrigger::class, [
+					'task'  =>  $row['task_id'],
+					'force' =>  $this->module->getPreference('MAJ_AT_FORCE_EXEC_TOKEN')
+				])
+			];
+
+			$datum = [
+				view($module_name . '::admin/tasks-table-options', $task_options_params),
+				view($module_name . '::components/yes-no-icons', ['yes' => $row['enabled']]),
+				'<span dir="auto">' . e($row['task_name']) . '</span>',
+				$row['last_run']->unix() === 0 ?
+				view('components/datetime', ['timestamp' => $row['last_run']]) :
+				view('components/datetime-diff', ['timestamp' => $row['last_run']]),
+				view($module_name . '::components/yes-no-icons', ['yes' => $row['last_result']]),
+				'<span dir="auto">' . e($row['frequency']->cascade()->forHumans()) . '</span>',
+				$row['nb_occurrences'] > 0 ? I18N::number($row['nb_occurrences']) : I18N::translate('Unlimited'),
+				view($module_name . '::components/yes-no-icons', [
+					'yes' => $row['is_running'],
+					'text_yes' => I18N::translate('Running'),
+					'text_no' => I18N::translate('Not running')
+				]),
+				view($module_name . '::admin/tasks-table-run', $task_run_params)
+			];
+
+			return $datum;
+		};
+
+		return $this->datatables_service->handleCollection(
+			$request,
+			$task_schedules,
+			$search_columns,
+			$sort_columns,
+			$callback
+		);
+	}
 }

src/Webtrees/Module/AdminTasks/Http/RequestHandlers/TaskEditAction.php

Indentation +138 added lines, -138 removed lines

@@ -34,142 +34,142 @@
  */
 class TaskEditAction implements RequestHandlerInterface
 {
-    /**
-     * @var AdminTasksModule $module
-     */
-    private $module;
-
-    /**
-     * @var TaskScheduleService $taskschedules_service
-     */
-    private $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
-    {
-        $task_sched_id = (int) $request->getAttribute('task');
-        $task_schedule = $this->taskschedules_service->find($task_sched_id);
-
-        $admin_config_route = route(AdminConfigPage::class);
-
-        if ($task_schedule === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The task shedule with ID “%d” 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
-    {
-        $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 (Exception $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
-    {
-        $task = $this->taskschedules_service->findTask($task_schedule->taskId());
-        if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
-            return true;
-        }
-
-        /** @var TaskInterface&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;
-    }
+	/**
+	 * @var AdminTasksModule $module
+	 */
+	private $module;
+
+	/**
+	 * @var TaskScheduleService $taskschedules_service
+	 */
+	private $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
+	{
+		$task_sched_id = (int) $request->getAttribute('task');
+		$task_schedule = $this->taskschedules_service->find($task_sched_id);
+
+		$admin_config_route = route(AdminConfigPage::class);
+
+		if ($task_schedule === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The task shedule with ID “%d” 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
+	{
+		$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 (Exception $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
+	{
+		$task = $this->taskschedules_service->findTask($task_schedule->taskId());
+		if ($task === null || !($task instanceof ConfigurableTaskInterface)) {
+			return true;
+		}
+
+		/** @var TaskInterface&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;
+	}
 }

src/Webtrees/Module/AdminTasks/Tasks/HealthCheckEmailTask.php

Indentation +184 added lines, -184 removed lines

@@ -39,188 +39,188 @@
  */
 class HealthCheckEmailTask implements TaskInterface, ConfigurableTaskInterface
 {
-    /**
-     * Name of the Tree preference to check if the task is enabled for that tree
-     * @var string
-     */
-    public const TREE_PREFERENCE_NAME = 'MAJ_AT_HEALTHCHECK_ENABLED';
-
-    /**
-     * @var AdminTasksModule $module
-     */
-    private $module;
-
-    /**
-     * @var HealthCheckService $healthcheck_service;
-     */
-    private $healthcheck_service;
-
-    /**
-     * @var EmailService $email_service;
-     */
-    private $email_service;
-
-    /**
-     * @var UserService $user_service
-     */
-    private $user_service;
-
-    /**
-     * @var TreeService $tree_service
-     */
-    private $tree_service;
-
-    /**
-     * @var UpgradeService $upgrade_service
-     */
-    private $upgrade_service;
-
-    /**
-     * Constructor for HealthCheckTask
-     *
-     * @param ModuleService $module_service
-     * @param HealthCheckService $healthcheck_service
-     * @param EmailService $email_service
-     * @param UserService $user_service
-     * @param TreeService $tree_service
-     * @param UpgradeService $upgrade_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        HealthCheckService $healthcheck_service,
-        EmailService $email_service,
-        UserService $user_service,
-        TreeService $tree_service,
-        UpgradeService $upgrade_service
-    ) {
-        $this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
-        $this->healthcheck_service = $healthcheck_service;
-        $this->email_service = $email_service;
-        $this->user_service = $user_service;
-        $this->tree_service = $tree_service;
-        $this->upgrade_service = $upgrade_service;
-    }
-
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::name()
-     */
-    public function name(): string
-    {
-        return I18N::translate('Healthcheck Email');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::defaultFrequency()
-     */
-    public function defaultFrequency(): int
-    {
-        return 10080; // = 1 week = 7 * 24 * 60 min
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::run()
-     */
-    public function run(TaskSchedule $task_schedule): bool
-    {
-        if ($this->module === null) {
-            return false;
-        }
-
-        $res = true;
-
-        // Compute the number of days to compute
-        $interval_lastrun = $task_schedule->lastRunTime()->diffAsCarbonInterval(Carbon::now());
-        //@phpcs:ignore Generic.Files.LineLength.TooLong
-        $interval = $interval_lastrun->greaterThan($task_schedule->frequency()) ? $interval_lastrun : $task_schedule->frequency();
-        $nb_days = (int) $interval->ceilDay()->totalDays;
-
-        $view_params_site = [
-            'nb_days'               =>  $nb_days,
-            'upgrade_available'     =>  $this->upgrade_service->isUpgradeAvailable(),
-            'latest_version'        =>  $this->upgrade_service->latestVersion(),
-            'download_url'          =>  $this->upgrade_service->downloadUrl(),
-            'all_users'             =>  $this->user_service->all(),
-            'unapproved'            =>  $this->user_service->unapproved(),
-            'unverified'            =>  $this->user_service->unverified(),
-        ];
-
-        foreach ($this->tree_service->all() as $tree) {
-        /** @var Tree $tree */
-
-            if ($tree->getPreference(self::TREE_PREFERENCE_NAME) !== '1') {
-                continue;
-            }
-
-            $webmaster = $this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID'));
-            if ($webmaster === null) {
-                continue;
-            }
-            I18N::init($webmaster->getPreference('language'));
-
-            $error_logs = $this->healthcheck_service->errorLogs($tree, $nb_days);
-            $nb_errors = $error_logs->sum('nblogs');
-
-            $view_params = array_merge($view_params_site, [
-                'tree'              =>  $tree,
-                'total_by_type'     =>  $this->healthcheck_service->countByRecordType($tree),
-                'change_by_type'    =>  $this->healthcheck_service->changesByRecordType($tree, $nb_days),
-                'error_logs'        =>  $error_logs,
-                'nb_errors'         =>  $nb_errors
-            ]);
-
-            $res = $res && $this->email_service->send(
-                new TreeUser($tree),
-                $webmaster,
-                new NoReplyUser(),
-                I18N::translate('Health Check Report') . ' - ' . I18N::translate('Tree %s', $tree->name()),
-                view($this->module->name() . '::tasks/healthcheck/email-healthcheck-text', $view_params),
-                view($this->module->name() . '::tasks/healthcheck/email-healthcheck-html', $view_params)
-            );
-        }
-
-        return $res;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::configView()
-     */
-    public function configView(ServerRequestInterface $request): string
-    {
-        return view($this->module->name() . '::tasks/healthcheck/config', [
-            'all_trees'     =>  $this->tree_service->all()
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::updateConfig()
-     */
-    public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool
-    {
-        try {
-            $params = (array) $request->getParsedBody();
-
-            foreach ($this->tree_service->all() as $tree) {
-                if (Auth::isManager($tree)) {
-                    $tree_enabled = (bool) ($params['HEALTHCHECK_ENABLED_' . $tree->id()] ?? false);
-                    $tree->setPreference(self::TREE_PREFERENCE_NAME, $tree_enabled ? '1' : '0');
-                }
-            }
-            return true;
-        } catch (Exception $ex) {
-            Log::addErrorLog(
-                sprintf(
-                    'Error while updating the Task schedule "%s". Exception: %s',
-                    $task_schedule->id(),
-                    $ex->getMessage()
-                )
-            );
-        }
-        return false;
-    }
+	/**
+	 * Name of the Tree preference to check if the task is enabled for that tree
+	 * @var string
+	 */
+	public const TREE_PREFERENCE_NAME = 'MAJ_AT_HEALTHCHECK_ENABLED';
+
+	/**
+	 * @var AdminTasksModule $module
+	 */
+	private $module;
+
+	/**
+	 * @var HealthCheckService $healthcheck_service;
+	 */
+	private $healthcheck_service;
+
+	/**
+	 * @var EmailService $email_service;
+	 */
+	private $email_service;
+
+	/**
+	 * @var UserService $user_service
+	 */
+	private $user_service;
+
+	/**
+	 * @var TreeService $tree_service
+	 */
+	private $tree_service;
+
+	/**
+	 * @var UpgradeService $upgrade_service
+	 */
+	private $upgrade_service;
+
+	/**
+	 * Constructor for HealthCheckTask
+	 *
+	 * @param ModuleService $module_service
+	 * @param HealthCheckService $healthcheck_service
+	 * @param EmailService $email_service
+	 * @param UserService $user_service
+	 * @param TreeService $tree_service
+	 * @param UpgradeService $upgrade_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		HealthCheckService $healthcheck_service,
+		EmailService $email_service,
+		UserService $user_service,
+		TreeService $tree_service,
+		UpgradeService $upgrade_service
+	) {
+		$this->module = $module_service->findByInterface(AdminTasksModule::class)->first();
+		$this->healthcheck_service = $healthcheck_service;
+		$this->email_service = $email_service;
+		$this->user_service = $user_service;
+		$this->tree_service = $tree_service;
+		$this->upgrade_service = $upgrade_service;
+	}
+
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::name()
+	 */
+	public function name(): string
+	{
+		return I18N::translate('Healthcheck Email');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::defaultFrequency()
+	 */
+	public function defaultFrequency(): int
+	{
+		return 10080; // = 1 week = 7 * 24 * 60 min
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\TaskInterface::run()
+	 */
+	public function run(TaskSchedule $task_schedule): bool
+	{
+		if ($this->module === null) {
+			return false;
+		}
+
+		$res = true;
+
+		// Compute the number of days to compute
+		$interval_lastrun = $task_schedule->lastRunTime()->diffAsCarbonInterval(Carbon::now());
+		//@phpcs:ignore Generic.Files.LineLength.TooLong
+		$interval = $interval_lastrun->greaterThan($task_schedule->frequency()) ? $interval_lastrun : $task_schedule->frequency();
+		$nb_days = (int) $interval->ceilDay()->totalDays;
+
+		$view_params_site = [
+			'nb_days'               =>  $nb_days,
+			'upgrade_available'     =>  $this->upgrade_service->isUpgradeAvailable(),
+			'latest_version'        =>  $this->upgrade_service->latestVersion(),
+			'download_url'          =>  $this->upgrade_service->downloadUrl(),
+			'all_users'             =>  $this->user_service->all(),
+			'unapproved'            =>  $this->user_service->unapproved(),
+			'unverified'            =>  $this->user_service->unverified(),
+		];
+
+		foreach ($this->tree_service->all() as $tree) {
+		/** @var Tree $tree */
+
+			if ($tree->getPreference(self::TREE_PREFERENCE_NAME) !== '1') {
+				continue;
+			}
+
+			$webmaster = $this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID'));
+			if ($webmaster === null) {
+				continue;
+			}
+			I18N::init($webmaster->getPreference('language'));
+
+			$error_logs = $this->healthcheck_service->errorLogs($tree, $nb_days);
+			$nb_errors = $error_logs->sum('nblogs');
+
+			$view_params = array_merge($view_params_site, [
+				'tree'              =>  $tree,
+				'total_by_type'     =>  $this->healthcheck_service->countByRecordType($tree),
+				'change_by_type'    =>  $this->healthcheck_service->changesByRecordType($tree, $nb_days),
+				'error_logs'        =>  $error_logs,
+				'nb_errors'         =>  $nb_errors
+			]);
+
+			$res = $res && $this->email_service->send(
+				new TreeUser($tree),
+				$webmaster,
+				new NoReplyUser(),
+				I18N::translate('Health Check Report') . ' - ' . I18N::translate('Tree %s', $tree->name()),
+				view($this->module->name() . '::tasks/healthcheck/email-healthcheck-text', $view_params),
+				view($this->module->name() . '::tasks/healthcheck/email-healthcheck-html', $view_params)
+			);
+		}
+
+		return $res;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::configView()
+	 */
+	public function configView(ServerRequestInterface $request): string
+	{
+		return view($this->module->name() . '::tasks/healthcheck/config', [
+			'all_trees'     =>  $this->tree_service->all()
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Model\ConfigurableTaskInterface::updateConfig()
+	 */
+	public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool
+	{
+		try {
+			$params = (array) $request->getParsedBody();
+
+			foreach ($this->tree_service->all() as $tree) {
+				if (Auth::isManager($tree)) {
+					$tree_enabled = (bool) ($params['HEALTHCHECK_ENABLED_' . $tree->id()] ?? false);
+					$tree->setPreference(self::TREE_PREFERENCE_NAME, $tree_enabled ? '1' : '0');
+				}
+			}
+			return true;
+		} catch (Exception $ex) {
+			Log::addErrorLog(
+				sprintf(
+					'Error while updating the Task schedule "%s". Exception: %s',
+					$task_schedule->id(),
+					$ex->getMessage()
+				)
+			);
+		}
+		return false;
+	}
 }

src/Webtrees/Module/AdminTasks/Schema/Migration1.php

Indentation +21 added lines, -21 removed lines

@@ -25,25 +25,25 @@
 class Migration1 implements MigrationInterface
 {
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // Clean up previous admin tasks table if it exists
-        DB::schema()->dropIfExists('maj_admintasks');
-
-        DB::schema()->create('maj_admintasks', static function (Blueprint $table): void {
-
-            $table->increments('majat_id');
-            $table->string('majat_task_id', 32)->unique();
-            $table->enum('majat_status', ['enabled', 'disabled'])->default('disabled');
-            $table->dateTime('majat_last_run')->default(Carbon::createFromTimestampUTC(0));
-            $table->boolean('majat_last_result')->default(true);
-            $table->integer('majat_frequency')->default(10080);
-            $table->smallInteger('majat_nb_occur')->default(0);
-            $table->boolean('majat_running')->default(false);
-        });
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// Clean up previous admin tasks table if it exists
+		DB::schema()->dropIfExists('maj_admintasks');
+
+		DB::schema()->create('maj_admintasks', static function (Blueprint $table): void {
+
+			$table->increments('majat_id');
+			$table->string('majat_task_id', 32)->unique();
+			$table->enum('majat_status', ['enabled', 'disabled'])->default('disabled');
+			$table->dateTime('majat_last_run')->default(Carbon::createFromTimestampUTC(0));
+			$table->boolean('majat_last_result')->default(true);
+			$table->integer('majat_frequency')->default(10080);
+			$table->smallInteger('majat_nb_occur')->default(0);
+			$table->boolean('majat_running')->default(false);
+		});
+	}
 }