jon48 / webtrees-lib

app/Module/Hooks/HooksModule.php

Indentation +101 added lines, -101 removed lines

@@ -42,106 +42,106 @@
  * Provide entry points to extend core webtrees code.
  */
 class HooksModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleConfigInterface,
-    ModuleHookSubscriberInterface
+	ModuleMyArtJaubInterface,
+	ModuleConfigInterface,
+	ModuleHookSubscriberInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleConfigTrait;
-
-    // How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_HOOKS_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Hooks” module */ I18N::translate('Hooks');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return /* I18N: Description of the “Hooks” module */ I18N::translate('Implements hooks management.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        $this->traitBoot();
-        app()->bind(HookServiceInterface::class, HookService::class);
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/hooks', static function (Map $router): void {
-
-                $router->attach('', '/config/admin', static function (Map $router): void {
-
-                    $router->get(AdminConfigPage::class, '', AdminConfigPage::class);
-                    $router->get(ModulesHooksPage::class, '/{hook_name}', ModulesHooksPage::class);
-                    $router->post(ModulesHooksAction::class, '/{hook_name}', ModulesHooksAction::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.6-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
-     */
-    public function listSubscribedHooks(): array
-    {
-        return [
-            app()->makeWith(FactSourceTextExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(FamilyDatatablesExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(IndividualDatatablesExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(NameAccordionExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(RecordNameTextExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(SosaFamilyDatatablesExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(SosaIndividualDatatablesExtenderCollector::class, ['module' => $this]),
-            app()->makeWith(SosaMissingDatatablesExtenderCollector::class, ['module' => $this])
-        ];
-    }
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleConfigTrait;
+
+	// How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_HOOKS_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Hooks” module */ I18N::translate('Hooks');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return /* I18N: Description of the “Hooks” module */ I18N::translate('Implements hooks management.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		$this->traitBoot();
+		app()->bind(HookServiceInterface::class, HookService::class);
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/hooks', static function (Map $router): void {
+
+				$router->attach('', '/config/admin', static function (Map $router): void {
+
+					$router->get(AdminConfigPage::class, '', AdminConfigPage::class);
+					$router->get(ModulesHooksPage::class, '/{hook_name}', ModulesHooksPage::class);
+					$router->post(ModulesHooksAction::class, '/{hook_name}', ModulesHooksAction::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.6-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
+	 */
+	public function listSubscribedHooks(): array
+	{
+		return [
+			app()->makeWith(FactSourceTextExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(FamilyDatatablesExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(IndividualDatatablesExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(NameAccordionExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(RecordNameTextExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(SosaFamilyDatatablesExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(SosaIndividualDatatablesExtenderCollector::class, ['module' => $this]),
+			app()->makeWith(SosaMissingDatatablesExtenderCollector::class, ['module' => $this])
+		];
+	}
 }

app/Module/IsSourced/Hooks/IsSourcedStatusHook.php

Indentation +45 added lines, -45 removed lines

@@ -25,53 +25,53 @@
  */
 class IsSourcedStatusHook implements RecordNameTextExtenderInterface
 {
-    private ModuleInterface $module;
-    private SourceStatusService $source_status_service;
+	private ModuleInterface $module;
+	private SourceStatusService $source_status_service;
 
-    /**
-     * Constructor for IsSourcedStatusHook
-     *
-     * @param ModuleInterface $module
-     * @param SourceStatusService $source_status_service
-     */
-    public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
-    {
-        $this->module = $module;
-        $this->source_status_service = $source_status_service;
-    }
+	/**
+	 * Constructor for IsSourcedStatusHook
+	 *
+	 * @param ModuleInterface $module
+	 * @param SourceStatusService $source_status_service
+	 */
+	public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
+	{
+		$this->module = $module;
+		$this->source_status_service = $source_status_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNamePrepend()
-     */
-    public function recordNamePrepend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNamePrepend()
+	 */
+	public function recordNamePrepend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNameAppend()
-     */
-    public function recordNameAppend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
-    {
-        if ($use_long && $record instanceof Individual) {
-            return view($this->module()->name() . '::hooks/name-append', [
-                'module_name'           =>  $this->module()->name(),
-                'source_status_service' =>  $this->source_status_service,
-                'individual'            =>  $record,
-                'size_style'            =>  $size
-            ]);
-        }
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNameAppend()
+	 */
+	public function recordNameAppend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
+	{
+		if ($use_long && $record instanceof Individual) {
+			return view($this->module()->name() . '::hooks/name-append', [
+				'module_name'           =>  $this->module()->name(),
+				'source_status_service' =>  $this->source_status_service,
+				'individual'            =>  $record,
+				'size_style'            =>  $size
+			]);
+		}
+		return '';
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
     public function recordNameAppend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
     {
         if ($use_long && $record instanceof Individual) {
-            return view($this->module()->name() . '::hooks/name-append', [
+            return view($this->module()->name().'::hooks/name-append', [
                 'module_name'           =>  $this->module()->name(),
                 'source_status_service' =>  $this->source_status_service,
                 'individual'            =>  $record,

app/Module/IsSourced/IsSourcedModule.php

Indentation +90 added lines, -90 removed lines

@@ -33,105 +33,105 @@
  * IsSourced Module
  */
 class IsSourcedModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleSidebarInterface,
-    ModuleHookSubscriberInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleSidebarInterface,
+	ModuleHookSubscriberInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleGlobalTrait;
-    use ModuleSidebarTrait;
+	use ModuleMyArtJaubTrait;
+	use ModuleGlobalTrait;
+	use ModuleSidebarTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sourced events');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sourced events');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Indicate if events related to an record are sourced.');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Indicate if events related to an record are sourced.');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.6-v.1';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.6-v.1';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        return true;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		return true;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        /** @var SourceStatusService $source_status_service */
-        $source_status_service = app(SourceStatusService::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		/** @var SourceStatusService $source_status_service */
+		$source_status_service = app(SourceStatusService::class);
 
-        $spouse_families_status = $individual->spouseFamilies()->map(
-            function (Family $sfamily) use ($source_status_service): array {
-                return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
-            }
-        )->filter(function (array $item): bool {
-            return $item[1]->isSet();
-        });
+		$spouse_families_status = $individual->spouseFamilies()->map(
+			function (Family $sfamily) use ($source_status_service): array {
+				return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
+			}
+		)->filter(function (array $item): bool {
+			return $item[1]->isSet();
+		});
 
-        return view($this->name() . '::sidebar/content', [
-            'module_name'               => $this->name(),
-            'individual'                =>  $individual,
-            'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
-            'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
-            'source_status_marriages'   =>  $spouse_families_status,
-            'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
-        ]);
-    }
+		return view($this->name() . '::sidebar/content', [
+			'module_name'               => $this->name(),
+			'individual'                =>  $individual,
+			'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
+			'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
+			'source_status_marriages'   =>  $spouse_families_status,
+			'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
+		]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
-     */
-    public function listSubscribedHooks(): array
-    {
-        return [
-            app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
-            app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
+	 */
+	public function listSubscribedHooks(): array
+	{
+		return [
+			app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
+			app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
+		];
+	}
 }

app/Common/Hooks/AbstractHookCollector.php

Indentation +64 added lines, -64 removed lines

@@ -27,77 +27,77 @@
  */
 abstract class AbstractHookCollector implements HookCollectorInterface, HookInterface
 {
-    /** @var Collection<int, array<THook>> $hooks */
-    protected Collection $hooks;
+	/** @var Collection<int, array<THook>> $hooks */
+	protected Collection $hooks;
 
-    private ModuleInterface $module;
+	private ModuleInterface $module;
 
-    /**
-     * Constructor for AbstractHookCollector
-     *
-     * @param ModuleInterface $module
-     */
-    public function __construct(ModuleInterface $module)
-    {
-        $this->hooks = new Collection();
-        $this->module = $module;
-    }
+	/**
+	 * Constructor for AbstractHookCollector
+	 *
+	 * @param ModuleInterface $module
+	 */
+	public function __construct(ModuleInterface $module)
+	{
+		$this->hooks = new Collection();
+		$this->module = $module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
-     */
-    public function name(): string
-    {
-        return $this->module->name() . '-' .
-            mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
+	 */
+	public function name(): string
+	{
+		return $this->module->name() . '-' .
+			mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
-     */
-    abstract public function title(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
+	 */
+	abstract public function title(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
-     */
-    abstract public function description(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
+	 */
+	abstract public function description(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
-     */
-    abstract public function hookInterface(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
+	 */
+	abstract public function hookInterface(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
-     */
-    public function register(HookInterface $hook_instance, int $order): void
-    {
-        $this->hooks->put($order, [...$this->hooks->get($order, []), $hook_instance]);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
+	 */
+	public function register(HookInterface $hook_instance, int $order): void
+	{
+		$this->hooks->put($order, [...$this->hooks->get($order, []), $hook_instance]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
-     *
-     * @return Collection<THook>
-     */
-    public function hooks(): Collection
-    {
-        /** @var Collection<THook> */
-        return $this->hooks->sortKeys()->flatten();
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
+	 *
+	 * @return Collection<THook>
+	 */
+	public function hooks(): Collection
+	{
+		/** @var Collection<THook> */
+		return $this->hooks->sortKeys()->flatten();
+	}
 }