jon48 / webtrees-lib

app/Contracts/Tasks/TaskInterface.php

Indentation +19 added lines, -19 removed lines

@@ -19,25 +19,25 @@
  */
 interface TaskInterface
 {
-    /**
-     * Display name of the task
-     *
-     * @return string
-     */
-    public function name(): string;
+	/**
+	 * Display name of the task
+	 *
+	 * @return string
+	 */
+	public function name(): string;
     
-    /**
-     * Return the default frequency for the execution of the task, in minutes.
-     *
-     * @return int Frequency for the execution of the task
-     */
-    public function defaultFrequency(): int;
+	/**
+	 * Return the default frequency for the execution of the task, in minutes.
+	 *
+	 * @return int Frequency for the execution of the task
+	 */
+	public function defaultFrequency(): int;
     
-    /**
-     * Run the task's actions, and return whether the execution has been successful.
-     *
-     * @param TaskSchedule $task_schedule
-     * @return bool Has the execution been a success
-     */
-    public function run(TaskSchedule $task_schedule): bool;
+	/**
+	 * Run the task's actions, and return whether the execution has been successful.
+	 *
+	 * @param TaskSchedule $task_schedule
+	 * @return bool Has the execution been a success
+	 */
+	public function run(TaskSchedule $task_schedule): bool;
 }

app/Contracts/Tasks/ConfigurableTaskInterface.php

Indentation +15 added lines, -15 removed lines

@@ -22,20 +22,20 @@
 interface ConfigurableTaskInterface
 {
     
-    /**
-     * Returns the HTML code to display the specific task configuration.
-     *
-     * @param ServerRequestInterface $request
-     * @return string HTML code
-     */
-    public function configView(ServerRequestInterface $request): string;
+	/**
+	 * Returns the HTML code to display the specific task configuration.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @return string HTML code
+	 */
+	public function configView(ServerRequestInterface $request): string;
  
-    /**
-     * Update the specific configuration of the task.
-     *
-     * @param ServerRequestInterface $request
-     * @param TaskSchedule $task_schedule
-     * @return bool Result of the update
-     */
-    public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool;
+	/**
+	 * Update the specific configuration of the task.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param TaskSchedule $task_schedule
+	 * @return bool Result of the update
+	 */
+	public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool;
 }

app/Contracts/Tasks/ModuleTasksProviderInterface.php

Indentation +7 added lines, -7 removed lines

@@ -20,11 +20,11 @@
 interface ModuleTasksProviderInterface
 {
     
-    /**
-     * List tasks provided by the module as an associative array.
-     * They keys are used as task IDs for storage and reference.
-     *
-     * @return array<string, string> List of tasks
-     */
-    public function listTasks(): array;
+	/**
+	 * List tasks provided by the module as an associative array.
+	 * They keys are used as task IDs for storage and reference.
+	 *
+	 * @return array<string, string> List of tasks
+	 */
+	public function listTasks(): array;
 }

app/Module/PatronymicLineage/PatronymicLineageModule.php

Indentation +95 added lines, -95 removed lines

@@ -34,100 +34,100 @@
  * Display lineages of people with the same surname.
  */
 class PatronymicLineageModule extends IndividualListModule implements
-    ModuleMyArtJaubInterface,
-    ModuleListInterface,
-    ModuleGlobalInterface
+	ModuleMyArtJaubInterface,
+	ModuleListInterface,
+	ModuleGlobalInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleListTrait;
-    use ModuleGlobalTrait;
-
-     /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/lineages', static function (Map $router): void {
-
-                $router->attach('', '/Page', static function (Map $router): void {
-
-                    $router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
-                    $router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
-     */
-    public function listUrl(Tree $tree, array $parameters = []): string
-    {
-        $surname = $parameters['surname'] ?? '';
-
-        $xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
-        if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
-            $surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
-        }
-
-        if ($surname !== '') {
-            return route(LineagesPage::class, [
-                'tree'      =>  $tree->name(),
-                'surname'   =>  $surname
-            ] + $parameters);
-        }
-        return route(SurnamesList::class, [
-            'tree'  =>  $tree->name()
-        ] + $parameters);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
-     */
-    public function listMenuClass(): string
-    {
-        return 'menu-maj-patrolineage';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	use ModuleMyArtJaubTrait;
+	use ModuleListTrait;
+	use ModuleGlobalTrait;
+
+	 /**
+	  * {@inheritDoc}
+	  * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	  */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/lineages', static function (Map $router): void {
+
+				$router->attach('', '/Page', static function (Map $router): void {
+
+					$router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
+					$router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
+	 */
+	public function listUrl(Tree $tree, array $parameters = []): string
+	{
+		$surname = $parameters['surname'] ?? '';
+
+		$xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
+		if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
+			$surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
+		}
+
+		if ($surname !== '') {
+			return route(LineagesPage::class, [
+				'tree'      =>  $tree->name(),
+				'surname'   =>  $surname
+			] + $parameters);
+		}
+		return route(SurnamesList::class, [
+			'tree'  =>  $tree->name()
+		] + $parameters);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
+	 */
+	public function listMenuClass(): string
+	{
+		return 'menu-maj-patrolineage';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 }

app/Module/PatronymicLineage/Http/RequestHandlers/LineagesPage.php

Indentation +65 added lines, -65 removed lines

@@ -31,69 +31,69 @@
  */
 class LineagesPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var PatronymicLineageModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var IndividualListModule|null $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * Constructor for LineagesPage Request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-        $this->indilist_module = $module_service->findByInterface(IndividualListModule::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.'));
-        }
-
-        if ($this->indilist_module === null) {
-            throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
-        }
-
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $surname = $request->getAttribute('surname');
-
-        $initial = mb_substr($surname, 0, 1);
-        $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function (int $count, string $initial): bool {
-
-                return $initial === '@' || $initial === ',';
-            });
-
-        $title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
-
-        $lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
-
-        return $this->viewResponse($this->module->name() . '::lineages-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  'no',
-            'surname'       =>  $surname,
-            'lineages'      =>  $lineages,
-            'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var PatronymicLineageModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var IndividualListModule|null $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * Constructor for LineagesPage Request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+		$this->indilist_module = $module_service->findByInterface(IndividualListModule::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.'));
+		}
+
+		if ($this->indilist_module === null) {
+			throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
+		}
+
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$surname = $request->getAttribute('surname');
+
+		$initial = mb_substr($surname, 0, 1);
+		$initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function (int $count, string $initial): bool {
+
+				return $initial === '@' || $initial === ',';
+			});
+
+		$title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
+
+		$lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
+
+		return $this->viewResponse($this->module->name() . '::lineages-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  'no',
+			'surname'       =>  $surname,
+			'lineages'      =>  $lineages,
+			'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
+		]);
+	}
 }

app/Module/PatronymicLineage/Http/RequestHandlers/SurnamesList.php

Indentation +70 added lines, -70 removed lines

@@ -30,74 +30,74 @@
  */
 class SurnamesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var PatronymicLineageModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var IndividualListModule|null $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * Constructor for SurnamesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-        $this->indilist_module = $module_service->findByInterface(IndividualListModule::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.'));
-        }
-
-        if ($this->indilist_module === null) {
-            throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
-        }
-
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $initial = $request->getAttribute('alpha');
-        $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function (int $count, string $initial): bool {
-
-                return $initial === '@' || $initial === ',';
-            });
-
-        $show_all = $request->getQueryParams()['show_all'] ?? 'no';
-
-        if ($show_all === 'yes') {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
-            $surnames = $this->indilist_module->surnames($tree, '', '', false, false, I18N::locale());
-        } elseif ($initial !== null && mb_strlen($initial) == 1) {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
-            $surnames = $this->indilist_module->surnames($tree, '', $initial, false, false, I18N::locale());
-        } else {
-            $title =  I18N::translate('Patronymic Lineages');
-            $surnames = [];
-        }
-
-        return $this->viewResponse($this->module->name() . '::surnames-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  $show_all,
-            'surnames'      =>  $surnames
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var PatronymicLineageModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var IndividualListModule|null $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * Constructor for SurnamesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+		$this->indilist_module = $module_service->findByInterface(IndividualListModule::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.'));
+		}
+
+		if ($this->indilist_module === null) {
+			throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
+		}
+
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$initial = $request->getAttribute('alpha');
+		$initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function (int $count, string $initial): bool {
+
+				return $initial === '@' || $initial === ',';
+			});
+
+		$show_all = $request->getQueryParams()['show_all'] ?? 'no';
+
+		if ($show_all === 'yes') {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
+			$surnames = $this->indilist_module->surnames($tree, '', '', false, false, I18N::locale());
+		} elseif ($initial !== null && mb_strlen($initial) == 1) {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
+			$surnames = $this->indilist_module->surnames($tree, '', $initial, false, false, I18N::locale());
+		} else {
+			$title =  I18N::translate('Patronymic Lineages');
+			$surnames = [];
+		}
+
+		return $this->viewResponse($this->module->name() . '::surnames-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  $show_all,
+			'surnames'      =>  $surnames
+		]);
+	}
 }

app/Module/PatronymicLineage/Model/LineageRootNode.php

Indentation +58 added lines, -58 removed lines

@@ -24,68 +24,68 @@
 class LineageRootNode extends LineageNode
 {
 
-    /**
-     * @var Collection<string, int> $places Places for the lineage node
-     */
-    private $places;
+	/**
+	 * @var Collection<string, int> $places Places for the lineage node
+	 */
+	private $places;
 
-    /**
-     * @var int $nb_children Number of node childs
-     */
-    private $nb_children;
+	/**
+	 * @var int $nb_children Number of node childs
+	 */
+	private $nb_children;
 
-    /**
-     * Constructor for LineageRootNode
-     *
-     * @param Individual|null $node_indi
-     */
-    public function __construct(?Individual $node_indi = null)
-    {
-        parent::__construct($node_indi, $this);
-        $this->places = new Collection();
-        $this->nb_children = 0;
-    }
+	/**
+	 * Constructor for LineageRootNode
+	 *
+	 * @param Individual|null $node_indi
+	 */
+	public function __construct(?Individual $node_indi = null)
+	{
+		parent::__construct($node_indi, $this);
+		$this->places = new Collection();
+		$this->nb_children = 0;
+	}
 
-    /**
-     * Adds a place to the list of lineage's place
-     *
-     * @param Place $place
-     */
-    public function addPlace(Place $place): void
-    {
-        $place_name = $place->gedcomName();
-        if (mb_strlen($place_name) > 0) {
-            $this->places->put($place_name, $this->places->get($place_name, 0) + 1);
-        }
-    }
+	/**
+	 * Adds a place to the list of lineage's place
+	 *
+	 * @param Place $place
+	 */
+	public function addPlace(Place $place): void
+	{
+		$place_name = $place->gedcomName();
+		if (mb_strlen($place_name) > 0) {
+			$this->places->put($place_name, $this->places->get($place_name, 0) + 1);
+		}
+	}
 
-    /**
-     * Returns the number of child nodes.
-     * This number is more to be used as indication rather than an accurate one.
-     *
-     * @return int
-     */
-    public function numberChildNodes(): int
-    {
-        return $this->nb_children;
-    }
+	/**
+	 * Returns the number of child nodes.
+	 * This number is more to be used as indication rather than an accurate one.
+	 *
+	 * @return int
+	 */
+	public function numberChildNodes(): int
+	{
+		return $this->nb_children;
+	}
 
-    /**
-     * Increments the number of child nodes by one
-     *
-     */
-    public function incrementChildNodes(): void
-    {
-        $this->nb_children++;
-    }
+	/**
+	 * Increments the number of child nodes by one
+	 *
+	 */
+	public function incrementChildNodes(): void
+	{
+		$this->nb_children++;
+	}
 
-    /**
-     * Returns the list of place for the lineage
-     *
-     * @return Collection<string, int>
-     */
-    public function places(): Collection
-    {
-        return $this->places;
-    }
+	/**
+	 * Returns the list of place for the lineage
+	 *
+	 * @return Collection<string, int>
+	 */
+	public function places(): Collection
+	{
+		return $this->places;
+	}
 }

app/Module/WelcomeBlock/Http/RequestHandlers/MatomoStats.php

Indentation +52 added lines, -52 removed lines

@@ -31,64 +31,64 @@
  */
 class MatomoStats implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var WelcomeBlockModule|null $module
-     */
-    private $module;
+	/**
+	 * @var WelcomeBlockModule|null $module
+	 */
+	private $module;
 
-    /**
-     * @var MatomoStatsService $matomo_service
-     */
-    private $matomo_service;
+	/**
+	 * @var MatomoStatsService $matomo_service
+	 */
+	private $matomo_service;
 
-    /**
-     * Constructor for MatomoStats request handler
-     * @param ModuleService $module_service
-     * @param MatomoStatsService $matomo_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        MatomoStatsService $matomo_service
-    ) {
-        $this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
-        $this->matomo_service = $matomo_service;
-    }
+	/**
+	 * Constructor for MatomoStats request handler
+	 * @param ModuleService $module_service
+	 * @param MatomoStatsService $matomo_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		MatomoStatsService $matomo_service
+	) {
+		$this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
+		$this->matomo_service = $matomo_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/ajax';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/ajax';
 
-        if ($this->module === null) {
-            return $this->viewResponse('errors/unhandled-exception', [
-                'error' => 'The attached module could not be found.'
-            ], StatusCodeInterface::STATUS_NOT_FOUND);
-        }
+		if ($this->module === null) {
+			return $this->viewResponse('errors/unhandled-exception', [
+				'error' => 'The attached module could not be found.'
+			], StatusCodeInterface::STATUS_NOT_FOUND);
+		}
 
-        $block_id = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
-        $nb_visits_year = $nb_visits_today = null;
+		$block_id = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
+		$nb_visits_year = $nb_visits_today = null;
 
-        try {
-            if ($block_id !== false && $this->module->isMatomoEnabled($block_id)) {
-                $nb_visits_today = $this->matomo_service->visitsToday($this->module, $block_id) ?? 0;
-                $nb_visits_year = ($this->matomo_service->visitsThisYear($this->module, $block_id) ?? 0)
-                    + $nb_visits_today;
-            }
-        } catch (Throwable $ex) {
-            return $this->viewResponse('errors/unhandled-exception', [
-                'error' => I18N::translate('Error while retrieving Matomo statistics: ') .
-                    (Auth::isAdmin() ? $ex->getMessage() : I18N::translate('Log in as admin for error details'))
-            ], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
-        }
+		try {
+			if ($block_id !== false && $this->module->isMatomoEnabled($block_id)) {
+				$nb_visits_today = $this->matomo_service->visitsToday($this->module, $block_id) ?? 0;
+				$nb_visits_year = ($this->matomo_service->visitsThisYear($this->module, $block_id) ?? 0)
+					+ $nb_visits_today;
+			}
+		} catch (Throwable $ex) {
+			return $this->viewResponse('errors/unhandled-exception', [
+				'error' => I18N::translate('Error while retrieving Matomo statistics: ') .
+					(Auth::isAdmin() ? $ex->getMessage() : I18N::translate('Log in as admin for error details'))
+			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
+		}
 
-        return $this->viewResponse($this->module->name() . '::matomo-stats', [
-            'visits_year'   =>  $nb_visits_year,
-            'visits_today'  =>  $nb_visits_today
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::matomo-stats', [
+			'visits_year'   =>  $nb_visits_year,
+			'visits_today'  =>  $nb_visits_today
+		]);
+	}
 }

app/Module/WelcomeBlock/Services/MatomoStatsService.php

Indentation +82 added lines, -82 removed lines

@@ -29,93 +29,93 @@
 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
-    {
-        return Registry::cache()->file()->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');
+	/**
+	 * 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
+	{
+		return Registry::cache()->file()->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 Registry::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 Registry::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;
+	}
 }