Passed
Push — main ( c808ff...64cea5 )
by Jonathan
03:30
created
app/Module/Sosa/Http/RequestHandlers/SosaConfig.php 1 patch
Indentation   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -33,71 +33,71 @@
 block discarded – undo
33 33
  */
34 34
 class SosaConfig implements RequestHandlerInterface
35 35
 {
36
-    use ViewResponseTrait;
36
+	use ViewResponseTrait;
37 37
 
38
-    /**
39
-     * @var SosaModule|null $module
40
-     */
41
-    private $module;
38
+	/**
39
+	 * @var SosaModule|null $module
40
+	 */
41
+	private $module;
42 42
 
43
-    /**
44
-     * Constructor for SosaConfig Request Handler
45
-     *
46
-     * @param ModuleService $module_service
47
-     */
48
-    public function __construct(ModuleService $module_service)
49
-    {
50
-        $this->module = $module_service->findByInterface(SosaModule::class)->first();
51
-    }
43
+	/**
44
+	 * Constructor for SosaConfig Request Handler
45
+	 *
46
+	 * @param ModuleService $module_service
47
+	 */
48
+	public function __construct(ModuleService $module_service)
49
+	{
50
+		$this->module = $module_service->findByInterface(SosaModule::class)->first();
51
+	}
52 52
 
53
-    /**
54
-     * {@inheritDoc}
55
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
56
-     */
57
-    public function handle(ServerRequestInterface $request): ResponseInterface
58
-    {
59
-        if ($this->module === null) {
60
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
61
-        }
53
+	/**
54
+	 * {@inheritDoc}
55
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
56
+	 */
57
+	public function handle(ServerRequestInterface $request): ResponseInterface
58
+	{
59
+		if ($this->module === null) {
60
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
61
+		}
62 62
 
63
-        $tree = Validator::attributes($request)->tree();
63
+		$tree = Validator::attributes($request)->tree();
64 64
 
65
-        $users_root = array();
66
-        if (Auth::check()) {
67
-            /** @var \Fisharebest\Webtrees\User $user */
68
-            $user = Auth::user();
69
-            $users_root[] = [
70
-                'user'      => $user,
71
-                'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
72
-                'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
73
-            ];
65
+		$users_root = array();
66
+		if (Auth::check()) {
67
+			/** @var \Fisharebest\Webtrees\User $user */
68
+			$user = Auth::user();
69
+			$users_root[] = [
70
+				'user'      => $user,
71
+				'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
72
+				'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
73
+			];
74 74
 
75
-            if (Auth::isManager($tree)) {
76
-                $default_user = new DefaultUser();
77
-                $users_root[] = [
78
-                    'user' => $default_user,
79
-                    'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
80
-                    'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
81
-                ];
82
-            }
83
-        }
75
+			if (Auth::isManager($tree)) {
76
+				$default_user = new DefaultUser();
77
+				$users_root[] = [
78
+					'user' => $default_user,
79
+					'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
80
+					'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
81
+				];
82
+			}
83
+		}
84 84
 
85
-        // Use the system max generations if not set
86
-        $max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
87
-        foreach ($users_root as $key => $user_root) {
88
-            $users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
89
-                (int) $user_root['max_gen'] :
90
-                $max_gen_system;
91
-        };
85
+		// Use the system max generations if not set
86
+		$max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
87
+		foreach ($users_root as $key => $user_root) {
88
+			$users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
89
+				(int) $user_root['max_gen'] :
90
+				$max_gen_system;
91
+		};
92 92
 
93
-        return $this->viewResponse($this->module->name() . '::config-page', [
94
-            'module_name'       =>  $this->module->name(),
95
-            'title'             =>  I18N::translate('Sosa Configuration'),
96
-            'tree'              =>  $tree,
97
-            'user_id'           =>  Validator::attributes($request)->user(),
98
-            'selected_user_id'  =>  Validator::queryParams($request)->integer('user_id', 0),
99
-            'immediate_compute' =>  Validator::queryParams($request)->string('compute', '') === 'yes',
100
-            'users_root'        =>  $users_root
101
-        ]);
102
-    }
93
+		return $this->viewResponse($this->module->name() . '::config-page', [
94
+			'module_name'       =>  $this->module->name(),
95
+			'title'             =>  I18N::translate('Sosa Configuration'),
96
+			'tree'              =>  $tree,
97
+			'user_id'           =>  Validator::attributes($request)->user(),
98
+			'selected_user_id'  =>  Validator::queryParams($request)->integer('user_id', 0),
99
+			'immediate_compute' =>  Validator::queryParams($request)->string('compute', '') === 'yes',
100
+			'users_root'        =>  $users_root
101
+		]);
102
+	}
103 103
 }
Please login to merge, or discard this patch.
app/Module/Sosa/Http/RequestHandlers/SosaConfigAction.php 1 patch
Indentation   +42 added lines, -42 removed lines patch added patch discarded remove patch
@@ -31,51 +31,51 @@
 block discarded – undo
31 31
  */
32 32
 class SosaConfigAction implements RequestHandlerInterface
33 33
 {
34
-    private UserService $user_service;
35
-    private SosaRecordsService $sosa_record_service;
34
+	private UserService $user_service;
35
+	private SosaRecordsService $sosa_record_service;
36 36
 
37
-    /**
38
-     * Constructor for SosaConfigAction Request Handler
39
-     *
40
-     * @param UserService $user_service
41
-     * @param SosaRecordsService $sosa_records_service
42
-     */
43
-    public function __construct(UserService $user_service, SosaRecordsService $sosa_records_service)
44
-    {
45
-        $this->user_service = $user_service;
46
-        $this->sosa_record_service = $sosa_records_service;
47
-    }
37
+	/**
38
+	 * Constructor for SosaConfigAction Request Handler
39
+	 *
40
+	 * @param UserService $user_service
41
+	 * @param SosaRecordsService $sosa_records_service
42
+	 */
43
+	public function __construct(UserService $user_service, SosaRecordsService $sosa_records_service)
44
+	{
45
+		$this->user_service = $user_service;
46
+		$this->sosa_record_service = $sosa_records_service;
47
+	}
48 48
 
49
-    /**
50
-     * {@inheritDoc}
51
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
52
-     */
53
-    public function handle(ServerRequestInterface $request): ResponseInterface
54
-    {
55
-        $tree = Validator::attributes($request)->tree();
49
+	/**
50
+	 * {@inheritDoc}
51
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
52
+	 */
53
+	public function handle(ServerRequestInterface $request): ResponseInterface
54
+	{
55
+		$tree = Validator::attributes($request)->tree();
56 56
 
57
-        $user_id = Validator::parsedBody($request)->integer('sosa-userid', -1);
58
-        $root_id = Validator::parsedBody($request)->isXref()->string('sosa-rootid', '');
59
-        $max_gen = Validator::parsedBody($request)->integer(
60
-            'sosa-maxgen',
61
-            $this->sosa_record_service->maxSystemGenerations()
62
-        );
57
+		$user_id = Validator::parsedBody($request)->integer('sosa-userid', -1);
58
+		$root_id = Validator::parsedBody($request)->isXref()->string('sosa-rootid', '');
59
+		$max_gen = Validator::parsedBody($request)->integer(
60
+			'sosa-maxgen',
61
+			$this->sosa_record_service->maxSystemGenerations()
62
+		);
63 63
 
64
-        if (Auth::id() === $user_id || ($user_id === -1 && Auth::isManager($tree))) {
65
-            $user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
66
-            if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
67
-                $tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
68
-                $tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', (string) $max_gen);
69
-                FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
70
-                return Registry::responseFactory()->redirect(SosaConfig::class, [
71
-                    'tree' => $tree->name(),
72
-                    'compute' => 'yes',
73
-                    'user_id' => $user_id
74
-                ]);
75
-            }
76
-        }
64
+		if (Auth::id() === $user_id || ($user_id === -1 && Auth::isManager($tree))) {
65
+			$user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
66
+			if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
67
+				$tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
68
+				$tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', (string) $max_gen);
69
+				FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
70
+				return Registry::responseFactory()->redirect(SosaConfig::class, [
71
+					'tree' => $tree->name(),
72
+					'compute' => 'yes',
73
+					'user_id' => $user_id
74
+				]);
75
+			}
76
+		}
77 77
 
78
-        FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
79
-        return Registry::responseFactory()->redirect(SosaConfig::class, ['tree' => $tree->name()]);
80
-    }
78
+		FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
79
+		return Registry::responseFactory()->redirect(SosaConfig::class, ['tree' => $tree->name()]);
80
+	}
81 81
 }
Please login to merge, or discard this patch.
app/Module/Sosa/SosaModule.php 1 patch
Indentation   +255 added lines, -255 removed lines patch added patch discarded remove patch
@@ -57,261 +57,261 @@
 block discarded – undo
57 57
  * Identify and produce statistics about Sosa ancestors
58 58
  */
59 59
 class SosaModule extends AbstractModule implements
60
-    ModuleMyArtJaubInterface,
61
-    ModuleGlobalInterface,
62
-    ModuleMenuInterface,
63
-    ModuleSidebarInterface,
64
-    ModuleGeoAnalysisProviderInterface,
65
-    ModuleHookSubscriberInterface
60
+	ModuleMyArtJaubInterface,
61
+	ModuleGlobalInterface,
62
+	ModuleMenuInterface,
63
+	ModuleSidebarInterface,
64
+	ModuleGeoAnalysisProviderInterface,
65
+	ModuleHookSubscriberInterface
66 66
 {
67
-    use ModuleMyArtJaubTrait {
68
-        boot as traitBoot;
69
-    }
70
-    use ModuleGlobalTrait;
71
-    use ModuleMenuTrait;
72
-    use ModuleSidebarTrait;
73
-
74
-    // How to update the database schema for this module
75
-    private const SCHEMA_TARGET_VERSION   = 3;
76
-    private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
77
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
67
+	use ModuleMyArtJaubTrait {
68
+		boot as traitBoot;
69
+	}
70
+	use ModuleGlobalTrait;
71
+	use ModuleMenuTrait;
72
+	use ModuleSidebarTrait;
73
+
74
+	// How to update the database schema for this module
75
+	private const SCHEMA_TARGET_VERSION   = 3;
76
+	private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
77
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
78 78
 /**
79
-     * {@inheritDoc}
80
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
81
-     */
82
-    public function title(): string
83
-    {
84
-        return /* I18N: Name of the “Sosa” module */ I18N::translate('Sosa');
85
-    }
86
-
87
-    /**
88
-     * {@inheritDoc}
89
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
90
-     */
91
-    public function description(): string
92
-    {
93
-        //phpcs:ignore Generic.Files.LineLength.TooLong
94
-        return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
95
-    }
96
-
97
-    /**
98
-     * {@inheritDoc}
99
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
100
-     */
101
-    public function boot(): void
102
-    {
103
-        $this->traitBoot();
104
-        app(MigrationService::class)->updateSchema(
105
-            self::SCHEMA_MIGRATION_PREFIX,
106
-            self::SCHEMA_SETTING_NAME,
107
-            self::SCHEMA_TARGET_VERSION
108
-        );
109
-    }
110
-
111
-    /**
112
-     * {@inheritDoc}
113
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
114
-     */
115
-    public function loadRoutes(Map $router): void
116
-    {
117
-        $router->attach('', '', static function (Map $router): void {
118
-
119
-            $router->attach('', '/module-maj/sosa', static function (Map $router): void {
120
-
121
-                $router->attach('', '/list', static function (Map $router): void {
122
-                    $router->tokens(['gen' => '\d+']);
123
-                    $router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
124
-                    $router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
125
-                    $router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
126
-                    $router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
127
-                });
128
-
129
-                $router->attach('', '/statistics/{tree}', static function (Map $router): void {
130
-
131
-                    $router->get(SosaStatistics::class, '', SosaStatistics::class);
132
-                    $router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
133
-                });
134
-
135
-                $router->attach('', '/config/{tree}', static function (Map $router): void {
136
-
137
-                    $router->get(SosaConfig::class, '', SosaConfig::class);
138
-                    $router->post(SosaConfigAction::class, '', SosaConfigAction::class);
139
-                    $router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
140
-                    $router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
141
-                });
142
-            });
143
-        });
144
-    }
145
-
146
-    /**
147
-     * {@inheritDoc}
148
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
149
-     */
150
-    public function customModuleVersion(): string
151
-    {
152
-        return '2.1.3-v.1';
153
-    }
154
-
155
-    /**
156
-     * {@inheritDoc}
157
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
158
-     */
159
-    public function defaultMenuOrder(): int
160
-    {
161
-        return 7;
162
-    }
163
-
164
-    /**
165
-     * {@inhericDoc}
166
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
167
-     */
168
-    public function getMenu(Tree $tree): ?Menu
169
-    {
170
-        $menu = new Menu(I18N::translate('Sosa Statistics'));
171
-        $menu->setClass('menu-maj-sosa');
172
-        $menu->setSubmenus([
173
-            new Menu(
174
-                I18N::translate('Sosa Ancestors'),
175
-                route(AncestorsList::class, ['tree' => $tree->name()]),
176
-                'menu-maj-sosa-list',
177
-                ['rel' => 'nofollow']
178
-            ),
179
-            new Menu(
180
-                I18N::translate('Missing Ancestors'),
181
-                route(MissingAncestorsList::class, ['tree' => $tree->name()]),
182
-                'menu-maj-sosa-missing',
183
-                ['rel' => 'nofollow']
184
-            ),
185
-            new Menu(
186
-                I18N::translate('Sosa Statistics'),
187
-                route(SosaStatistics::class, ['tree' => $tree->name()]),
188
-                'menu-maj-sosa-stats'
189
-            )
190
-        ]);
191
-
192
-        if (Auth::check()) {
193
-            $menu->addSubmenu(new Menu(
194
-                I18N::translate('Sosa Configuration'),
195
-                route(SosaConfig::class, ['tree' => $tree->name()]),
196
-                'menu-maj-sosa-config'
197
-            ));
198
-
199
-            /** @var ServerRequestInterface $request */
200
-            $request = app(ServerRequestInterface::class);
201
-            $route = Validator::attributes($request)->route();
202
-
203
-            $root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
204
-
205
-            if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
206
-                $xref = Validator::attributes($request)->isXref()->string('xref', '');
207
-
208
-                $menu->addSubmenu(new Menu(
209
-                    I18N::translate('Complete Sosas'),
210
-                    '#',
211
-                    'menu-maj-sosa-compute',
212
-                    [
213
-                        'rel'           => 'nofollow',
214
-                        'data-wt-href'  => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
215
-                        'data-bs-target'    => '#wt-ajax-modal',
216
-                        'data-bs-toggle'    => 'modal',
217
-                        'data-bs-backdrop'  => 'static'
218
-                    ]
219
-                ));
220
-            }
221
-        }
222
-
223
-        return $menu;
224
-    }
225
-
226
-    /**
227
-     * {@inheritDoc}
228
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
229
-     */
230
-    public function headContent(): string
231
-    {
232
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
233
-    }
234
-
235
-    /**
236
-     * {@inheritDoc}
237
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
238
-     */
239
-    public function bodyContent(): string
240
-    {
241
-        return '<script src="' . $this->assetUrl('js/sosa.min.js') . '"></script>';
242
-    }
243
-
244
-    /**
245
-     * {@inheritDoc}
246
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
247
-     */
248
-    public function sidebarTitle(Individual $individual): string
249
-    {
250
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
251
-
252
-        return view($this->name() . '::sidebar/title', [
253
-            'module_name'   =>  $this->name(),
254
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
255
-        ]);
256
-    }
257
-
258
-    /**
259
-     * {@inheritDoc}
260
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
261
-     */
262
-    public function getSidebarContent(Individual $individual): string
263
-    {
264
-        $sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
265
-        $sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
266
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
267
-
268
-        return view($this->name() . '::sidebar/content', [
269
-            'sosa_ancestor' =>  $individual,
270
-            'sosa_root'     =>  $sosa_root,
271
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
272
-        ]);
273
-    }
274
-
275
-    /**
276
-     * {@inheritDoc}
277
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
278
-     */
279
-    public function hasSidebarContent(Individual $individual): bool
280
-    {
281
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
282
-
283
-        return app(SosaRecordsService::class)
284
-            ->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
285
-    }
286
-
287
-    /**
288
-     * {@inheritDoc}
289
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
290
-     */
291
-    public function defaultSidebarOrder(): int
292
-    {
293
-        return 1;
294
-    }
295
-
296
-    /**
297
-     * {@inheritDoc}
298
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
299
-     */
300
-    public function listGeoAnalyses(): array
301
-    {
302
-        return [
303
-            SosaByGenerationGeoAnalysis::class
304
-        ];
305
-    }
306
-
307
-    /**
308
-     * {@inheritDoc}
309
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
310
-     */
311
-    public function listSubscribedHooks(): array
312
-    {
313
-        return [
314
-            app()->makeWith(SosaIconHook::class, [ 'module' => $this ])
315
-        ];
316
-    }
79
+	 * {@inheritDoc}
80
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
81
+	 */
82
+	public function title(): string
83
+	{
84
+		return /* I18N: Name of the “Sosa” module */ I18N::translate('Sosa');
85
+	}
86
+
87
+	/**
88
+	 * {@inheritDoc}
89
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
90
+	 */
91
+	public function description(): string
92
+	{
93
+		//phpcs:ignore Generic.Files.LineLength.TooLong
94
+		return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
95
+	}
96
+
97
+	/**
98
+	 * {@inheritDoc}
99
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
100
+	 */
101
+	public function boot(): void
102
+	{
103
+		$this->traitBoot();
104
+		app(MigrationService::class)->updateSchema(
105
+			self::SCHEMA_MIGRATION_PREFIX,
106
+			self::SCHEMA_SETTING_NAME,
107
+			self::SCHEMA_TARGET_VERSION
108
+		);
109
+	}
110
+
111
+	/**
112
+	 * {@inheritDoc}
113
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
114
+	 */
115
+	public function loadRoutes(Map $router): void
116
+	{
117
+		$router->attach('', '', static function (Map $router): void {
118
+
119
+			$router->attach('', '/module-maj/sosa', static function (Map $router): void {
120
+
121
+				$router->attach('', '/list', static function (Map $router): void {
122
+					$router->tokens(['gen' => '\d+']);
123
+					$router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
124
+					$router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
125
+					$router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
126
+					$router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
127
+				});
128
+
129
+				$router->attach('', '/statistics/{tree}', static function (Map $router): void {
130
+
131
+					$router->get(SosaStatistics::class, '', SosaStatistics::class);
132
+					$router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
133
+				});
134
+
135
+				$router->attach('', '/config/{tree}', static function (Map $router): void {
136
+
137
+					$router->get(SosaConfig::class, '', SosaConfig::class);
138
+					$router->post(SosaConfigAction::class, '', SosaConfigAction::class);
139
+					$router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
140
+					$router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
141
+				});
142
+			});
143
+		});
144
+	}
145
+
146
+	/**
147
+	 * {@inheritDoc}
148
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
149
+	 */
150
+	public function customModuleVersion(): string
151
+	{
152
+		return '2.1.3-v.1';
153
+	}
154
+
155
+	/**
156
+	 * {@inheritDoc}
157
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
158
+	 */
159
+	public function defaultMenuOrder(): int
160
+	{
161
+		return 7;
162
+	}
163
+
164
+	/**
165
+	 * {@inhericDoc}
166
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
167
+	 */
168
+	public function getMenu(Tree $tree): ?Menu
169
+	{
170
+		$menu = new Menu(I18N::translate('Sosa Statistics'));
171
+		$menu->setClass('menu-maj-sosa');
172
+		$menu->setSubmenus([
173
+			new Menu(
174
+				I18N::translate('Sosa Ancestors'),
175
+				route(AncestorsList::class, ['tree' => $tree->name()]),
176
+				'menu-maj-sosa-list',
177
+				['rel' => 'nofollow']
178
+			),
179
+			new Menu(
180
+				I18N::translate('Missing Ancestors'),
181
+				route(MissingAncestorsList::class, ['tree' => $tree->name()]),
182
+				'menu-maj-sosa-missing',
183
+				['rel' => 'nofollow']
184
+			),
185
+			new Menu(
186
+				I18N::translate('Sosa Statistics'),
187
+				route(SosaStatistics::class, ['tree' => $tree->name()]),
188
+				'menu-maj-sosa-stats'
189
+			)
190
+		]);
191
+
192
+		if (Auth::check()) {
193
+			$menu->addSubmenu(new Menu(
194
+				I18N::translate('Sosa Configuration'),
195
+				route(SosaConfig::class, ['tree' => $tree->name()]),
196
+				'menu-maj-sosa-config'
197
+			));
198
+
199
+			/** @var ServerRequestInterface $request */
200
+			$request = app(ServerRequestInterface::class);
201
+			$route = Validator::attributes($request)->route();
202
+
203
+			$root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
204
+
205
+			if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
206
+				$xref = Validator::attributes($request)->isXref()->string('xref', '');
207
+
208
+				$menu->addSubmenu(new Menu(
209
+					I18N::translate('Complete Sosas'),
210
+					'#',
211
+					'menu-maj-sosa-compute',
212
+					[
213
+						'rel'           => 'nofollow',
214
+						'data-wt-href'  => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
215
+						'data-bs-target'    => '#wt-ajax-modal',
216
+						'data-bs-toggle'    => 'modal',
217
+						'data-bs-backdrop'  => 'static'
218
+					]
219
+				));
220
+			}
221
+		}
222
+
223
+		return $menu;
224
+	}
225
+
226
+	/**
227
+	 * {@inheritDoc}
228
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
229
+	 */
230
+	public function headContent(): string
231
+	{
232
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
233
+	}
234
+
235
+	/**
236
+	 * {@inheritDoc}
237
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
238
+	 */
239
+	public function bodyContent(): string
240
+	{
241
+		return '<script src="' . $this->assetUrl('js/sosa.min.js') . '"></script>';
242
+	}
243
+
244
+	/**
245
+	 * {@inheritDoc}
246
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
247
+	 */
248
+	public function sidebarTitle(Individual $individual): string
249
+	{
250
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
251
+
252
+		return view($this->name() . '::sidebar/title', [
253
+			'module_name'   =>  $this->name(),
254
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
255
+		]);
256
+	}
257
+
258
+	/**
259
+	 * {@inheritDoc}
260
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
261
+	 */
262
+	public function getSidebarContent(Individual $individual): string
263
+	{
264
+		$sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
265
+		$sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
266
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
267
+
268
+		return view($this->name() . '::sidebar/content', [
269
+			'sosa_ancestor' =>  $individual,
270
+			'sosa_root'     =>  $sosa_root,
271
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
272
+		]);
273
+	}
274
+
275
+	/**
276
+	 * {@inheritDoc}
277
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
278
+	 */
279
+	public function hasSidebarContent(Individual $individual): bool
280
+	{
281
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
282
+
283
+		return app(SosaRecordsService::class)
284
+			->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
285
+	}
286
+
287
+	/**
288
+	 * {@inheritDoc}
289
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
290
+	 */
291
+	public function defaultSidebarOrder(): int
292
+	{
293
+		return 1;
294
+	}
295
+
296
+	/**
297
+	 * {@inheritDoc}
298
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
299
+	 */
300
+	public function listGeoAnalyses(): array
301
+	{
302
+		return [
303
+			SosaByGenerationGeoAnalysis::class
304
+		];
305
+	}
306
+
307
+	/**
308
+	 * {@inheritDoc}
309
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
310
+	 */
311
+	public function listSubscribedHooks(): array
312
+	{
313
+		return [
314
+			app()->makeWith(SosaIconHook::class, [ 'module' => $this ])
315
+		];
316
+	}
317 317
 }
Please login to merge, or discard this patch.
app/Module/WelcomeBlock/WelcomeBlockModule.php 1 patch
Indentation   +159 added lines, -159 removed lines patch added patch discarded remove patch
@@ -34,163 +34,163 @@
 block discarded – undo
34 34
  */
35 35
 class WelcomeBlockModule extends AbstractModule implements ModuleMyArtJaubInterface, ModuleBlockInterface
36 36
 {
37
-    use ModuleMyArtJaubTrait;
38
-    use ModuleBlockTrait;
39
-
40
-    /**
41
-     * {@inheritDoc}
42
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
43
-     */
44
-    public function title(): string
45
-    {
46
-        return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
47
-    }
48
-
49
-    /**
50
-     * {@inheritDoc}
51
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
52
-     */
53
-    public function description(): string
54
-    {
55
-        //phpcs:ignore Generic.Files.LineLength.TooLong
56
-        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.');
57
-    }
58
-
59
-    /**
60
-     * {@inheritDoc}
61
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
62
-     */
63
-    public function loadRoutes(Map $router): void
64
-    {
65
-        $router->attach('', '', static function (Map $router): void {
66
-
67
-            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
68
-                $router->tokens(['block_id' => '\d+']);
69
-                $router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
70
-            });
71
-        });
72
-    }
73
-
74
-    /**
75
-     * {@inheritDoc}
76
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
77
-     */
78
-    public function customModuleVersion(): string
79
-    {
80
-        return '2.1.3-v.1';
81
-    }
82
-
83
-    /**
84
-     * {@inheritDoc}
85
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
86
-     *
87
-     * @param mixed[] $config
88
-     */
89
-    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
90
-    {
91
-        $fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
92
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
93
-
94
-        $fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
95
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
96
-
97
-        $content = view($this->name() . '::block-embed', [
98
-            'block_id'                  =>  $block_id,
99
-            'fab_welcome_block_view'    =>  $fab_welcome_block_view,
100
-            'fab_login_block_view'      =>  $fab_login_block_view,
101
-            'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
102
-            'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
103
-        ]);
104
-
105
-        if ($context !== self::CONTEXT_EMBED) {
106
-            return view('modules/block-template', [
107
-                'block'      => Str::kebab($this->name()),
108
-                'id'         => $block_id,
109
-                'config_url' => $this->configUrl($tree, $context, $block_id),
110
-                'title'      => e($tree->title()),
111
-                'content'    => $content,
112
-            ]);
113
-        }
114
-
115
-        return $content;
116
-    }
117
-
118
-    /**
119
-     * {@inheritDoc}
120
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
121
-     */
122
-    public function isTreeBlock(): bool
123
-    {
124
-        return true;
125
-    }
126
-
127
-    /**
128
-     * {@inheritDoc}
129
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
130
-     */
131
-    public function editBlockConfiguration(Tree $tree, int $block_id): string
132
-    {
133
-        return view($this->name() . '::config', $this->matomoSettings($block_id));
134
-    }
135
-
136
-    /**
137
-     * {@inheritDoc}
138
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
139
-     */
140
-    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
141
-    {
142
-        $matomo_enabled = Validator::parsedBody($request)->string('matomo_enabled', '') === 'yes';
143
-        $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
144
-        if (!$matomo_enabled) {
145
-            return;
146
-        }
147
-
148
-        $matomo_url = trim(Validator::parsedBody($request)->string('matomo_url', ''));
149
-        if (filter_var($matomo_url, FILTER_VALIDATE_URL) === false) {
150
-            FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
151
-            return;
152
-        }
153
-
154
-        $matomo_siteid = Validator::parsedBody($request)->integer('matomo_siteid', -1);
155
-        if ($matomo_siteid === -1) {
156
-            FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
157
-            return;
158
-        }
159
-
160
-        $matomo_token = trim(Validator::parsedBody($request)->string('matomo_token', ''));
161
-
162
-        $this
163
-            ->setBlockSetting($block_id, 'matomo_url', $matomo_url)
164
-            ->setBlockSetting($block_id, 'matomo_token', $matomo_token)
165
-            ->setBlockSetting($block_id, 'matomo_siteid', (string) $matomo_siteid);
166
-
167
-        Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
168
-    }
169
-
170
-    /**
171
-     * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
172
-     *
173
-     * @param int $block_id
174
-     * @return bool
175
-     */
176
-    public function isMatomoEnabled(int $block_id): bool
177
-    {
178
-        return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
179
-    }
180
-
181
-    /**
182
-     * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
183
-     *
184
-     * @param int $block_id
185
-     * @return array<string, mixed>
186
-     */
187
-    public function matomoSettings(int $block_id): array
188
-    {
189
-        return [
190
-            'matomo_enabled' => $this->isMatomoEnabled($block_id),
191
-            'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
192
-            'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
193
-            'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
194
-        ];
195
-    }
37
+	use ModuleMyArtJaubTrait;
38
+	use ModuleBlockTrait;
39
+
40
+	/**
41
+	 * {@inheritDoc}
42
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
43
+	 */
44
+	public function title(): string
45
+	{
46
+		return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
47
+	}
48
+
49
+	/**
50
+	 * {@inheritDoc}
51
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
52
+	 */
53
+	public function description(): string
54
+	{
55
+		//phpcs:ignore Generic.Files.LineLength.TooLong
56
+		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.');
57
+	}
58
+
59
+	/**
60
+	 * {@inheritDoc}
61
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
62
+	 */
63
+	public function loadRoutes(Map $router): void
64
+	{
65
+		$router->attach('', '', static function (Map $router): void {
66
+
67
+			$router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
68
+				$router->tokens(['block_id' => '\d+']);
69
+				$router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
70
+			});
71
+		});
72
+	}
73
+
74
+	/**
75
+	 * {@inheritDoc}
76
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
77
+	 */
78
+	public function customModuleVersion(): string
79
+	{
80
+		return '2.1.3-v.1';
81
+	}
82
+
83
+	/**
84
+	 * {@inheritDoc}
85
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
86
+	 *
87
+	 * @param mixed[] $config
88
+	 */
89
+	public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
90
+	{
91
+		$fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
92
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
93
+
94
+		$fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
95
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
96
+
97
+		$content = view($this->name() . '::block-embed', [
98
+			'block_id'                  =>  $block_id,
99
+			'fab_welcome_block_view'    =>  $fab_welcome_block_view,
100
+			'fab_login_block_view'      =>  $fab_login_block_view,
101
+			'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
102
+			'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
103
+		]);
104
+
105
+		if ($context !== self::CONTEXT_EMBED) {
106
+			return view('modules/block-template', [
107
+				'block'      => Str::kebab($this->name()),
108
+				'id'         => $block_id,
109
+				'config_url' => $this->configUrl($tree, $context, $block_id),
110
+				'title'      => e($tree->title()),
111
+				'content'    => $content,
112
+			]);
113
+		}
114
+
115
+		return $content;
116
+	}
117
+
118
+	/**
119
+	 * {@inheritDoc}
120
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
121
+	 */
122
+	public function isTreeBlock(): bool
123
+	{
124
+		return true;
125
+	}
126
+
127
+	/**
128
+	 * {@inheritDoc}
129
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
130
+	 */
131
+	public function editBlockConfiguration(Tree $tree, int $block_id): string
132
+	{
133
+		return view($this->name() . '::config', $this->matomoSettings($block_id));
134
+	}
135
+
136
+	/**
137
+	 * {@inheritDoc}
138
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
139
+	 */
140
+	public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
141
+	{
142
+		$matomo_enabled = Validator::parsedBody($request)->string('matomo_enabled', '') === 'yes';
143
+		$this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
144
+		if (!$matomo_enabled) {
145
+			return;
146
+		}
147
+
148
+		$matomo_url = trim(Validator::parsedBody($request)->string('matomo_url', ''));
149
+		if (filter_var($matomo_url, FILTER_VALIDATE_URL) === false) {
150
+			FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
151
+			return;
152
+		}
153
+
154
+		$matomo_siteid = Validator::parsedBody($request)->integer('matomo_siteid', -1);
155
+		if ($matomo_siteid === -1) {
156
+			FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
157
+			return;
158
+		}
159
+
160
+		$matomo_token = trim(Validator::parsedBody($request)->string('matomo_token', ''));
161
+
162
+		$this
163
+			->setBlockSetting($block_id, 'matomo_url', $matomo_url)
164
+			->setBlockSetting($block_id, 'matomo_token', $matomo_token)
165
+			->setBlockSetting($block_id, 'matomo_siteid', (string) $matomo_siteid);
166
+
167
+		Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
168
+	}
169
+
170
+	/**
171
+	 * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
172
+	 *
173
+	 * @param int $block_id
174
+	 * @return bool
175
+	 */
176
+	public function isMatomoEnabled(int $block_id): bool
177
+	{
178
+		return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
179
+	}
180
+
181
+	/**
182
+	 * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
183
+	 *
184
+	 * @param int $block_id
185
+	 * @return array<string, mixed>
186
+	 */
187
+	public function matomoSettings(int $block_id): array
188
+	{
189
+		return [
190
+			'matomo_enabled' => $this->isMatomoEnabled($block_id),
191
+			'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
192
+			'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
193
+			'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
194
+		];
195
+	}
196 196
 }
Please login to merge, or discard this patch.
app/Module/AdminTasks/AdminTasksModule.php 1 patch
Indentation   +122 added lines, -122 removed lines patch added patch discarded remove patch
@@ -41,127 +41,127 @@
 block discarded – undo
41 41
  * Allow for tasks to be run on a (nearly-)regular schedule
42 42
  */
43 43
 class AdminTasksModule extends AbstractModule implements
44
-    ModuleMyArtJaubInterface,
45
-    ModuleConfigInterface,
46
-    ModuleGlobalInterface,
47
-    ModuleTasksProviderInterface
44
+	ModuleMyArtJaubInterface,
45
+	ModuleConfigInterface,
46
+	ModuleGlobalInterface,
47
+	ModuleTasksProviderInterface
48 48
 {
49
-    use ModuleMyArtJaubTrait {
50
-        boot as traitBoot;
51
-    }
52
-    use ModuleConfigTrait;
53
-    use ModuleGlobalTrait;
54
-
55
-    //How to update the database schema for this module
56
-    private const SCHEMA_TARGET_VERSION   = 2;
57
-    private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
58
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
59
-
60
-    /**
61
-     * {@inheritDoc}
62
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
63
-     */
64
-    public function title(): string
65
-    {
66
-        return I18N::translate('Administration Tasks');
67
-    }
68
-
69
-    /**
70
-     * {@inheritDoc}
71
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
72
-     */
73
-    public function description(): string
74
-    {
75
-        return I18N::translate('Manage and run nearly-scheduled administration tasks.');
76
-    }
77
-
78
-    /**
79
-     * {@inheritDoc}
80
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
81
-     */
82
-    public function boot(): void
83
-    {
84
-        $this->traitBoot();
85
-        app(MigrationService::class)->updateSchema(
86
-            self::SCHEMA_MIGRATION_PREFIX,
87
-            self::SCHEMA_SETTING_NAME,
88
-            self::SCHEMA_TARGET_VERSION
89
-        );
90
-    }
91
-
92
-    /**
93
-     * {@inheritDoc}
94
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
95
-     */
96
-    public function loadRoutes(Map $router): void
97
-    {
98
-        $router->attach('', '', static function (Map $router): void {
99
-
100
-            $router->attach('', '/module-maj/admintasks', static function (Map $router): void {
101
-                $router->tokens(['enable' => '[01]']);
102
-
103
-                $router->attach('', '/admin', static function (Map $router): void {
104
-
105
-                    $router->extras([
106
-                        'middleware' => [
107
-                            AuthAdministrator::class,
108
-                        ],
109
-                    ]);
110
-                    $router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
111
-
112
-                    $router->attach('', '/tasks', static function (Map $router): void {
113
-
114
-                        $router->get(TasksList::class, '', TasksList::class);
115
-                        $router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
116
-                        $router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
117
-                        $router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
118
-                    });
119
-                });
120
-
121
-                $router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
122
-                    ->allows(RequestMethodInterface::METHOD_POST);
123
-
124
-                $router->post(TokenGenerate::class, '/token', TokenGenerate::class)
125
-                    ->extras(['middleware' => [AuthAdministrator::class]]);
126
-            });
127
-        });
128
-    }
129
-
130
-    /**
131
-     * {@inheritDoc}
132
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
133
-     */
134
-    public function customModuleVersion(): string
135
-    {
136
-        return '2.1.3-v.1';
137
-    }
138
-
139
-    /**
140
-     * {@inheritDoc}
141
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
142
-     */
143
-    public function getConfigLink(): string
144
-    {
145
-        return route(AdminConfigPage::class);
146
-    }
147
-
148
-    /**
149
-     * {@inheritDoc}
150
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
151
-     */
152
-    public function bodyContent(): string
153
-    {
154
-        return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
155
-    }
156
-
157
-    /**
158
-     * {@inheritDoc}
159
-     * @see ModuleTasksProviderInterface::listTasks()
160
-     */
161
-    public function listTasks(): array
162
-    {
163
-        return [
164
-            'maj-healthcheck' => HealthCheckEmailTask::class
165
-        ];
166
-    }
49
+	use ModuleMyArtJaubTrait {
50
+		boot as traitBoot;
51
+	}
52
+	use ModuleConfigTrait;
53
+	use ModuleGlobalTrait;
54
+
55
+	//How to update the database schema for this module
56
+	private const SCHEMA_TARGET_VERSION   = 2;
57
+	private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
58
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
59
+
60
+	/**
61
+	 * {@inheritDoc}
62
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
63
+	 */
64
+	public function title(): string
65
+	{
66
+		return I18N::translate('Administration Tasks');
67
+	}
68
+
69
+	/**
70
+	 * {@inheritDoc}
71
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
72
+	 */
73
+	public function description(): string
74
+	{
75
+		return I18N::translate('Manage and run nearly-scheduled administration tasks.');
76
+	}
77
+
78
+	/**
79
+	 * {@inheritDoc}
80
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
81
+	 */
82
+	public function boot(): void
83
+	{
84
+		$this->traitBoot();
85
+		app(MigrationService::class)->updateSchema(
86
+			self::SCHEMA_MIGRATION_PREFIX,
87
+			self::SCHEMA_SETTING_NAME,
88
+			self::SCHEMA_TARGET_VERSION
89
+		);
90
+	}
91
+
92
+	/**
93
+	 * {@inheritDoc}
94
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
95
+	 */
96
+	public function loadRoutes(Map $router): void
97
+	{
98
+		$router->attach('', '', static function (Map $router): void {
99
+
100
+			$router->attach('', '/module-maj/admintasks', static function (Map $router): void {
101
+				$router->tokens(['enable' => '[01]']);
102
+
103
+				$router->attach('', '/admin', static function (Map $router): void {
104
+
105
+					$router->extras([
106
+						'middleware' => [
107
+							AuthAdministrator::class,
108
+						],
109
+					]);
110
+					$router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
111
+
112
+					$router->attach('', '/tasks', static function (Map $router): void {
113
+
114
+						$router->get(TasksList::class, '', TasksList::class);
115
+						$router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
116
+						$router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
117
+						$router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
118
+					});
119
+				});
120
+
121
+				$router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
122
+					->allows(RequestMethodInterface::METHOD_POST);
123
+
124
+				$router->post(TokenGenerate::class, '/token', TokenGenerate::class)
125
+					->extras(['middleware' => [AuthAdministrator::class]]);
126
+			});
127
+		});
128
+	}
129
+
130
+	/**
131
+	 * {@inheritDoc}
132
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
133
+	 */
134
+	public function customModuleVersion(): string
135
+	{
136
+		return '2.1.3-v.1';
137
+	}
138
+
139
+	/**
140
+	 * {@inheritDoc}
141
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
142
+	 */
143
+	public function getConfigLink(): string
144
+	{
145
+		return route(AdminConfigPage::class);
146
+	}
147
+
148
+	/**
149
+	 * {@inheritDoc}
150
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
151
+	 */
152
+	public function bodyContent(): string
153
+	{
154
+		return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
155
+	}
156
+
157
+	/**
158
+	 * {@inheritDoc}
159
+	 * @see ModuleTasksProviderInterface::listTasks()
160
+	 */
161
+	public function listTasks(): array
162
+	{
163
+		return [
164
+			'maj-healthcheck' => HealthCheckEmailTask::class
165
+		];
166
+	}
167 167
 }
Please login to merge, or discard this patch.
app/Module/Certificates/Elements/SourceCertificate.php 1 patch
Indentation   +52 added lines, -52 removed lines patch added patch discarded remove patch
@@ -28,61 +28,61 @@
 block discarded – undo
28 28
  */
29 29
 class SourceCertificate extends AbstractElement
30 30
 {
31
-    protected CertificatesModule $module;
32
-    protected CertificateFilesystemService $certif_filesystem;
33
-    protected UrlObfuscatorService $url_obfuscator_service;
31
+	protected CertificatesModule $module;
32
+	protected CertificateFilesystemService $certif_filesystem;
33
+	protected UrlObfuscatorService $url_obfuscator_service;
34 34
 
35
-    /**
36
-     * Constructor for SourceCertificate element
37
-     *
38
-     * @param string $label
39
-     * @param CertificatesModule $module
40
-     * @param CertificateFilesystemService $certif_filesystem
41
-     * @param UrlObfuscatorService $url_obfuscator_service
42
-     */
43
-    public function __construct(
44
-        string $label,
45
-        CertificatesModule $module,
46
-        CertificateFilesystemService $certif_filesystem = null,
47
-        UrlObfuscatorService $url_obfuscator_service = null
48
-    ) {
49
-        parent::__construct($label, null);
50
-        $this->module = $module;
51
-        $this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
52
-        $this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
53
-    }
35
+	/**
36
+	 * Constructor for SourceCertificate element
37
+	 *
38
+	 * @param string $label
39
+	 * @param CertificatesModule $module
40
+	 * @param CertificateFilesystemService $certif_filesystem
41
+	 * @param UrlObfuscatorService $url_obfuscator_service
42
+	 */
43
+	public function __construct(
44
+		string $label,
45
+		CertificatesModule $module,
46
+		CertificateFilesystemService $certif_filesystem = null,
47
+		UrlObfuscatorService $url_obfuscator_service = null
48
+	) {
49
+		parent::__construct($label, null);
50
+		$this->module = $module;
51
+		$this->certif_filesystem = $certif_filesystem ?? app(CertificateFilesystemService::class);
52
+		$this->url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
53
+	}
54 54
 
55
-    /**
56
-     * {@inheritDoc}
57
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
58
-     */
59
-    public function canonical(string $value): string
60
-    {
61
-        return strtr($value, '\\', '/');
62
-    }
55
+	/**
56
+	 * {@inheritDoc}
57
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::canonical()
58
+	 */
59
+	public function canonical(string $value): string
60
+	{
61
+		return strtr($value, '\\', '/');
62
+	}
63 63
 
64
-    /**
65
-     * {@inheritDoc}
66
-     * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
67
-     */
68
-    public function edit(string $id, string $name, string $value, Tree $tree): string
69
-    {
70
-        list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
64
+	/**
65
+	 * {@inheritDoc}
66
+	 * @see \Fisharebest\Webtrees\Elements\AbstractElement::edit()
67
+	 */
68
+	public function edit(string $id, string $name, string $value, Tree $tree): string
69
+	{
70
+		list($city, $file) = explode('/', $this->canonical($value), 2) + ['', ''];
71 71
 
72
-        $cities = array_map(function (string $item): array {
73
-            return [$this->url_obfuscator_service->obfuscate($item), $item];
74
-        }, $this->certif_filesystem->cities($tree));
72
+		$cities = array_map(function (string $item): array {
73
+			return [$this->url_obfuscator_service->obfuscate($item), $item];
74
+		}, $this->certif_filesystem->cities($tree));
75 75
 
76
-        return view($this->module->name() . '::components/edit-certificate', [
77
-            'module_name'   =>  $this->module->name(),
78
-            'tree'          =>  $tree,
79
-            'id'            =>  $id,
80
-            'name'          =>  $name,
81
-            'cities'        =>  $cities,
82
-            'value'         =>  $this->canonical($value),
83
-            'value_city'    =>  $city,
84
-            'value_file'    =>  $file,
85
-            'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
86
-        ]);
87
-    }
76
+		return view($this->module->name() . '::components/edit-certificate', [
77
+			'module_name'   =>  $this->module->name(),
78
+			'tree'          =>  $tree,
79
+			'id'            =>  $id,
80
+			'name'          =>  $name,
81
+			'cities'        =>  $cities,
82
+			'value'         =>  $this->canonical($value),
83
+			'value_city'    =>  $city,
84
+			'value_file'    =>  $file,
85
+			'js_script_url' =>  $this->module->assetUrl('js/certificates.min.js')
86
+		]);
87
+	}
88 88
 }
Please login to merge, or discard this patch.
app/Module/Certificates/CertificatesModule.php 1 patch
Indentation   +175 added lines, -175 removed lines patch added patch discarded remove patch
@@ -44,180 +44,180 @@
 block discarded – undo
44 44
  * Certificates Module.
45 45
  */
46 46
 class CertificatesModule extends AbstractModule implements
47
-    ModuleMyArtJaubInterface,
48
-    ModuleConfigInterface,
49
-    ModuleGlobalInterface,
50
-    ModuleListInterface,
51
-    ModuleHookSubscriberInterface
47
+	ModuleMyArtJaubInterface,
48
+	ModuleConfigInterface,
49
+	ModuleGlobalInterface,
50
+	ModuleListInterface,
51
+	ModuleHookSubscriberInterface
52 52
 {
53
-    use ModuleMyArtJaubTrait {
54
-        ModuleMyArtJaubTrait::boot as traitMajBoot;
55
-    }
56
-    use ModuleConfigTrait;
57
-    use ModuleGlobalTrait;
58
-    use ModuleListTrait;
59
-
60
-    /**
61
-     * {@inheritDoc}
62
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
63
-     */
64
-    public function title(): string
65
-    {
66
-        return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
67
-    }
68
-
69
-    /**
70
-     * {@inheritDoc}
71
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
72
-     */
73
-    public function description(): string
74
-    {
75
-        //phpcs:ignore Generic.Files.LineLength.TooLong
76
-        return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
77
-    }
78
-
79
-    /**
80
-     * {@inheritDoc}
81
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
82
-     */
83
-    public function boot(): void
84
-    {
85
-        $this->traitMajBoot();
86
-
87
-        Registry::elementFactory()->registerTags([
88
-            'FAM:SOUR:_ACT'     =>  new SourceCertificate(I18N::translate('Certificate'), $this),
89
-            'FAM:*:SOUR:_ACT'   =>  new SourceCertificate(I18N::translate('Certificate'), $this),
90
-            'INDI:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
91
-            'INDI:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this),
92
-            'OBJE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
93
-            'OBJE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this),
94
-            'NOTE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
95
-            'NOTE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this)
96
-        ]);
97
-
98
-        Registry::elementFactory()->registerSubTags([
99
-            'FAM:SOUR'      =>  [['_ACT', '0:1']],
100
-            'FAM:*:SOUR'    =>  [['_ACT', '0:1']],
101
-            'INDI:SOUR'     =>  [['_ACT', '0:1']],
102
-            'INDI:*:SOUR'   =>  [['_ACT', '0:1']],
103
-            'OBJE:SOUR'     =>  [['_ACT', '0:1']],
104
-            'OBJE:*:SOUR'   =>  [['_ACT', '0:1']],
105
-            'NOTE:SOUR'     =>  [['_ACT', '0:1']],
106
-            'NOTE:*:SOUR'   =>  [['_ACT', '0:1']]
107
-        ]);
108
-    }
109
-
110
-    /**
111
-     * {@inheritDoc}
112
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
113
-     */
114
-    public function loadRoutes($router): void
115
-    {
116
-        $router->attach('', '', static function (Map $router): void {
117
-
118
-            $router->attach('', '/module-maj/certificates', static function (Map $router): void {
119
-
120
-                $router->attach('', '/admin', static function (Map $router): void {
121
-
122
-                    $router->get(AdminConfigPage::class, '/config{/tree}', AdminConfigPage::class);
123
-                    $router->post(AdminConfigAction::class, '/config/{tree}', AdminConfigAction::class)
124
-                        ->extras([
125
-                            'middleware' => [
126
-                                AuthManager::class,
127
-                            ],
128
-                        ]);
129
-                });
130
-
131
-                $router->get(AutoCompleteFile::class, '/autocomplete/file/{tree}/{query}', AutoCompleteFile::class)
132
-                    ->extras([
133
-                        'middleware'            =>  [AuthTreePreference::class],
134
-                        'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
135
-                    ]);
136
-
137
-                $router->get(CertificatesList::class, '/list/{tree}{/cityobf}', CertificatesList::class)
138
-                    ->extras([
139
-                        'middleware'            =>  [AuthTreePreference::class],
140
-                        'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
141
-                    ]);
142
-
143
-                $router->attach('', '/certificate/{tree}/{cid}', static function (Map $router): void {
144
-
145
-                    $router->extras([
146
-                        'middleware'            =>  [AuthTreePreference::class],
147
-                        'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
148
-                    ]);
149
-
150
-                    $router->get(CertificatePage::class, '', CertificatePage::class);
151
-                    $router->get(CertificateImage::class, '/image', CertificateImage::class);
152
-                });
153
-            });
154
-        });
155
-    }
156
-
157
-    /**
158
-     * {@inheritDoc}
159
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
160
-     */
161
-    public function customModuleVersion(): string
162
-    {
163
-        return '2.1.3-v.1';
164
-    }
165
-
166
-    /**
167
-     * {@inheritDoc}
168
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
169
-     */
170
-    public function getConfigLink(): string
171
-    {
172
-        return route(AdminConfigPage::class);
173
-    }
174
-
175
-    /**
176
-     * {@inheritDoc}
177
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
178
-     */
179
-    public function headContent(): string
180
-    {
181
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
182
-    }
183
-
184
-    /**
185
-     * {@inheritDoc}
186
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
187
-     *
188
-     * @param array<bool|int|string|array<mixed>|null> $parameters
189
-     */
190
-    public function listUrl(Tree $tree, array $parameters = []): string
191
-    {
192
-        return route(CertificatesList::class, ['tree' => $tree->name() ] + $parameters);
193
-    }
194
-
195
-    /**
196
-     * {@inheritDoc}
197
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
198
-     */
199
-    public function listMenuClass(): string
200
-    {
201
-        return 'menu-maj-certificates';
202
-    }
203
-
204
-    /**
205
-     * {@inheritDoc}
206
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listIsEmpty()
207
-     */
208
-    public function listIsEmpty(Tree $tree): bool
209
-    {
210
-        return Auth::accessLevel($tree) > (int) $tree->getPreference('MAJ_CERTIF_SHOW_CERT', (string) Auth::PRIV_HIDE);
211
-    }
212
-
213
-    /**
214
-     * {@inheritDoc}
215
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
216
-     */
217
-    public function listSubscribedHooks(): array
218
-    {
219
-        return [
220
-            app()->makeWith(SourceCertificateIconHook::class, ['module' => $this])
221
-        ];
222
-    }
53
+	use ModuleMyArtJaubTrait {
54
+		ModuleMyArtJaubTrait::boot as traitMajBoot;
55
+	}
56
+	use ModuleConfigTrait;
57
+	use ModuleGlobalTrait;
58
+	use ModuleListTrait;
59
+
60
+	/**
61
+	 * {@inheritDoc}
62
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
63
+	 */
64
+	public function title(): string
65
+	{
66
+		return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
67
+	}
68
+
69
+	/**
70
+	 * {@inheritDoc}
71
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
72
+	 */
73
+	public function description(): string
74
+	{
75
+		//phpcs:ignore Generic.Files.LineLength.TooLong
76
+		return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
77
+	}
78
+
79
+	/**
80
+	 * {@inheritDoc}
81
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
82
+	 */
83
+	public function boot(): void
84
+	{
85
+		$this->traitMajBoot();
86
+
87
+		Registry::elementFactory()->registerTags([
88
+			'FAM:SOUR:_ACT'     =>  new SourceCertificate(I18N::translate('Certificate'), $this),
89
+			'FAM:*:SOUR:_ACT'   =>  new SourceCertificate(I18N::translate('Certificate'), $this),
90
+			'INDI:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
91
+			'INDI:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this),
92
+			'OBJE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
93
+			'OBJE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this),
94
+			'NOTE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate'), $this),
95
+			'NOTE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'), $this)
96
+		]);
97
+
98
+		Registry::elementFactory()->registerSubTags([
99
+			'FAM:SOUR'      =>  [['_ACT', '0:1']],
100
+			'FAM:*:SOUR'    =>  [['_ACT', '0:1']],
101
+			'INDI:SOUR'     =>  [['_ACT', '0:1']],
102
+			'INDI:*:SOUR'   =>  [['_ACT', '0:1']],
103
+			'OBJE:SOUR'     =>  [['_ACT', '0:1']],
104
+			'OBJE:*:SOUR'   =>  [['_ACT', '0:1']],
105
+			'NOTE:SOUR'     =>  [['_ACT', '0:1']],
106
+			'NOTE:*:SOUR'   =>  [['_ACT', '0:1']]
107
+		]);
108
+	}
109
+
110
+	/**
111
+	 * {@inheritDoc}
112
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
113
+	 */
114
+	public function loadRoutes($router): void
115
+	{
116
+		$router->attach('', '', static function (Map $router): void {
117
+
118
+			$router->attach('', '/module-maj/certificates', static function (Map $router): void {
119
+
120
+				$router->attach('', '/admin', static function (Map $router): void {
121
+
122
+					$router->get(AdminConfigPage::class, '/config{/tree}', AdminConfigPage::class);
123
+					$router->post(AdminConfigAction::class, '/config/{tree}', AdminConfigAction::class)
124
+						->extras([
125
+							'middleware' => [
126
+								AuthManager::class,
127
+							],
128
+						]);
129
+				});
130
+
131
+				$router->get(AutoCompleteFile::class, '/autocomplete/file/{tree}/{query}', AutoCompleteFile::class)
132
+					->extras([
133
+						'middleware'            =>  [AuthTreePreference::class],
134
+						'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
135
+					]);
136
+
137
+				$router->get(CertificatesList::class, '/list/{tree}{/cityobf}', CertificatesList::class)
138
+					->extras([
139
+						'middleware'            =>  [AuthTreePreference::class],
140
+						'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
141
+					]);
142
+
143
+				$router->attach('', '/certificate/{tree}/{cid}', static function (Map $router): void {
144
+
145
+					$router->extras([
146
+						'middleware'            =>  [AuthTreePreference::class],
147
+						'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
148
+					]);
149
+
150
+					$router->get(CertificatePage::class, '', CertificatePage::class);
151
+					$router->get(CertificateImage::class, '/image', CertificateImage::class);
152
+				});
153
+			});
154
+		});
155
+	}
156
+
157
+	/**
158
+	 * {@inheritDoc}
159
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
160
+	 */
161
+	public function customModuleVersion(): string
162
+	{
163
+		return '2.1.3-v.1';
164
+	}
165
+
166
+	/**
167
+	 * {@inheritDoc}
168
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
169
+	 */
170
+	public function getConfigLink(): string
171
+	{
172
+		return route(AdminConfigPage::class);
173
+	}
174
+
175
+	/**
176
+	 * {@inheritDoc}
177
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
178
+	 */
179
+	public function headContent(): string
180
+	{
181
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
182
+	}
183
+
184
+	/**
185
+	 * {@inheritDoc}
186
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
187
+	 *
188
+	 * @param array<bool|int|string|array<mixed>|null> $parameters
189
+	 */
190
+	public function listUrl(Tree $tree, array $parameters = []): string
191
+	{
192
+		return route(CertificatesList::class, ['tree' => $tree->name() ] + $parameters);
193
+	}
194
+
195
+	/**
196
+	 * {@inheritDoc}
197
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
198
+	 */
199
+	public function listMenuClass(): string
200
+	{
201
+		return 'menu-maj-certificates';
202
+	}
203
+
204
+	/**
205
+	 * {@inheritDoc}
206
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listIsEmpty()
207
+	 */
208
+	public function listIsEmpty(Tree $tree): bool
209
+	{
210
+		return Auth::accessLevel($tree) > (int) $tree->getPreference('MAJ_CERTIF_SHOW_CERT', (string) Auth::PRIV_HIDE);
211
+	}
212
+
213
+	/**
214
+	 * {@inheritDoc}
215
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
216
+	 */
217
+	public function listSubscribedHooks(): array
218
+	{
219
+		return [
220
+			app()->makeWith(SourceCertificateIconHook::class, ['module' => $this])
221
+		];
222
+	}
223 223
 }
Please login to merge, or discard this patch.
app/Module/WelcomeBlock/Services/MatomoStatsService.php 1 patch
Indentation   +100 added lines, -100 removed lines patch added patch discarded remove patch
@@ -29,113 +29,113 @@
 block discarded – undo
29 29
  */
30 30
 class MatomoStatsService
31 31
 {
32
-    protected ?HandlerStack $handler = null;
32
+	protected ?HandlerStack $handler = null;
33 33
 
34
-    /**
35
-     * Set or get the http handler for the service
36
-     *
37
-     * @param HandlerStack $handler
38
-     * @return HandlerStack
39
-     */
40
-    public function httpHandler(HandlerStack $handler = null): HandlerStack
41
-    {
42
-        if ($this->handler === null) {
43
-            $this->handler = HandlerStack::create();
44
-        }
45
-        if ($handler !== null) {
46
-            $this->handler = $handler;
47
-        }
48
-        return $this->handler;
49
-    }
34
+	/**
35
+	 * Set or get the http handler for the service
36
+	 *
37
+	 * @param HandlerStack $handler
38
+	 * @return HandlerStack
39
+	 */
40
+	public function httpHandler(HandlerStack $handler = null): HandlerStack
41
+	{
42
+		if ($this->handler === null) {
43
+			$this->handler = HandlerStack::create();
44
+		}
45
+		if ($handler !== null) {
46
+			$this->handler = $handler;
47
+		}
48
+		return $this->handler;
49
+	}
50 50
 
51
-    /**
52
-     * Returns the number of visits for the current year (up to the day before).
53
-     * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
54
-     *
55
-     * @param WelcomeBlockModule $module
56
-     * @param int $block_id
57
-     * @return int|NULL
58
-     */
59
-    public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
60
-    {
61
-        return Registry::cache()->file()->remember(
62
-            $module->name() . '-matomovisits-yearly-' . $block_id,
63
-            function () use ($module, $block_id): ?int {
64
-                $visits_year = $this->visits($module, $block_id, 'year');
65
-                if ($visits_year === null) {
66
-                    return null;
67
-                }
68
-                $visits_today = (int) $this->visits($module, $block_id, 'day');
51
+	/**
52
+	 * Returns the number of visits for the current year (up to the day before).
53
+	 * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
54
+	 *
55
+	 * @param WelcomeBlockModule $module
56
+	 * @param int $block_id
57
+	 * @return int|NULL
58
+	 */
59
+	public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
60
+	{
61
+		return Registry::cache()->file()->remember(
62
+			$module->name() . '-matomovisits-yearly-' . $block_id,
63
+			function () use ($module, $block_id): ?int {
64
+				$visits_year = $this->visits($module, $block_id, 'year');
65
+				if ($visits_year === null) {
66
+					return null;
67
+				}
68
+				$visits_today = (int) $this->visits($module, $block_id, 'day');
69 69
 
70
-                return $visits_year - $visits_today;
71
-            },
72
-            Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
73
-        );
74
-    }
70
+				return $visits_year - $visits_today;
71
+			},
72
+			Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
73
+		);
74
+	}
75 75
 
76
-    /**
77
-     * Returns the number of visits for the current day.
78
-     *
79
-     * @param WelcomeBlockModule $module
80
-     * @param int $block_id
81
-     * @return int|NULL
82
-     */
83
-    public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
84
-    {
85
-        return Registry::cache()->array()->remember(
86
-            $module->name() . '-matomovisits-daily-' . $block_id,
87
-            function () use ($module, $block_id): ?int {
88
-                return $this->visits($module, $block_id, 'day');
89
-            }
90
-        );
91
-    }
76
+	/**
77
+	 * Returns the number of visits for the current day.
78
+	 *
79
+	 * @param WelcomeBlockModule $module
80
+	 * @param int $block_id
81
+	 * @return int|NULL
82
+	 */
83
+	public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
84
+	{
85
+		return Registry::cache()->array()->remember(
86
+			$module->name() . '-matomovisits-daily-' . $block_id,
87
+			function () use ($module, $block_id): ?int {
88
+				return $this->visits($module, $block_id, 'day');
89
+			}
90
+		);
91
+	}
92 92
 
93
-    /**
94
-     * Invoke the Matomo API to retrieve the number of visits over a period.
95
-     *
96
-     * @param WelcomeBlockModule $module
97
-     * @param int $block_id
98
-     * @param string $period
99
-     * @return int|NULL
100
-     */
101
-    protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
102
-    {
103
-        $settings = $module->matomoSettings($block_id);
93
+	/**
94
+	 * Invoke the Matomo API to retrieve the number of visits over a period.
95
+	 *
96
+	 * @param WelcomeBlockModule $module
97
+	 * @param int $block_id
98
+	 * @param string $period
99
+	 * @return int|NULL
100
+	 */
101
+	protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
102
+	{
103
+		$settings = $module->matomoSettings($block_id);
104 104
 
105
-        if (
106
-            $settings['matomo_enabled'] === true
107
-            && mb_strlen($settings['matomo_url']) > 0
108
-            && mb_strlen($settings['matomo_token']) > 0
109
-            && $settings['matomo_siteid'] > 0
110
-        ) {
111
-            try {
112
-                $http_client = new Client([
113
-                    RequestOptions::TIMEOUT => 30,
114
-                    'handler'   => $this->handler
115
-                ]);
105
+		if (
106
+			$settings['matomo_enabled'] === true
107
+			&& mb_strlen($settings['matomo_url']) > 0
108
+			&& mb_strlen($settings['matomo_token']) > 0
109
+			&& $settings['matomo_siteid'] > 0
110
+		) {
111
+			try {
112
+				$http_client = new Client([
113
+					RequestOptions::TIMEOUT => 30,
114
+					'handler'   => $this->handler
115
+				]);
116 116
 
117
-                $response = $http_client->get($settings['matomo_url'], [
118
-                    'query' =>  [
119
-                        'module'    =>  'API',
120
-                        'method'    =>  'VisitsSummary.getVisits',
121
-                        'idSite'    =>  $settings['matomo_siteid'],
122
-                        'period'    =>  $period,
123
-                        'date'      =>  'today',
124
-                        'token_auth' =>  $settings['matomo_token'],
125
-                        'format'    =>  'json'
126
-                    ]
127
-                ]);
117
+				$response = $http_client->get($settings['matomo_url'], [
118
+					'query' =>  [
119
+						'module'    =>  'API',
120
+						'method'    =>  'VisitsSummary.getVisits',
121
+						'idSite'    =>  $settings['matomo_siteid'],
122
+						'period'    =>  $period,
123
+						'date'      =>  'today',
124
+						'token_auth' =>  $settings['matomo_token'],
125
+						'format'    =>  'json'
126
+					]
127
+				]);
128 128
 
129
-                if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
130
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
131
-                    if ($result !== null) {
132
-                        return (int)$result;
133
-                    }
134
-                }
135
-            } catch (GuzzleException $ex) {
136
-            }
137
-        }
129
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
130
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
131
+					if ($result !== null) {
132
+						return (int)$result;
133
+					}
134
+				}
135
+			} catch (GuzzleException $ex) {
136
+			}
137
+		}
138 138
 
139
-        return null;
140
-    }
139
+		return null;
140
+	}
141 141
 }
Please login to merge, or discard this patch.
app/Module/GeoDispersion/Services/PlacesReferenceTableService.php 1 patch
Indentation   +79 added lines, -79 removed lines patch added patch discarded remove patch
@@ -21,91 +21,91 @@
 block discarded – undo
21 21
  */
22 22
 class PlacesReferenceTableService
23 23
 {
24
-    /**
25
-     * Mapping format placeholder tags => table column names
26
-     * @var array<string, string>
27
-     */
28
-    private const COLUMN_MAPPING = [
29
-        'name'  =>  'majgr_place_name',
30
-        'id'    =>  'majgr_place_admin_id',
31
-        'zip'   =>  'majgr_place_zip',
32
-        'gov'   =>  'majgr_place_gov_id',
33
-        'mls'   =>  'majgr_place_mls_id'
34
-    ];
24
+	/**
25
+	 * Mapping format placeholder tags => table column names
26
+	 * @var array<string, string>
27
+	 */
28
+	private const COLUMN_MAPPING = [
29
+		'name'  =>  'majgr_place_name',
30
+		'id'    =>  'majgr_place_admin_id',
31
+		'zip'   =>  'majgr_place_zip',
32
+		'gov'   =>  'majgr_place_gov_id',
33
+		'mls'   =>  'majgr_place_mls_id'
34
+	];
35 35
 
36
-    /**
37
-     * Get the formatted target mapping value of a place defined by a source format.
38
-     *
39
-     * @param string $source
40
-     * @param string $source_format
41
-     * @param string $target_format
42
-     * @return string|NULL
43
-     */
44
-    public function targetId(string $source, string $source_format, string $target_format): ?string
45
-    {
46
-        // Extract parts for the WHERE clause
47
-        $source_format = str_replace(['{', '}'], ['{#', '#}'], $source_format);
48
-        $source_parts = preg_split('/[{}]/i', $source_format);
49
-        if ($source_parts === false) {
50
-            return null;
51
-        }
52
-        $source_parts = array_map(function (string $part): string {
53
-            if (preg_match('/^#([^#]+)#$/i', $part, $column_id) === 1) {
54
-                return $this->columnName($column_id[1]);
55
-            }
56
-            return $this->sanitizeString(str_replace(['?', '*'], ['_', '%'], $part));
57
-        }, array_filter($source_parts));
58
-        $source_parts[] = "'%'";
59
-        $concat_statement = 'CONCAT(' . implode(', ', $source_parts) . ')';
36
+	/**
37
+	 * Get the formatted target mapping value of a place defined by a source format.
38
+	 *
39
+	 * @param string $source
40
+	 * @param string $source_format
41
+	 * @param string $target_format
42
+	 * @return string|NULL
43
+	 */
44
+	public function targetId(string $source, string $source_format, string $target_format): ?string
45
+	{
46
+		// Extract parts for the WHERE clause
47
+		$source_format = str_replace(['{', '}'], ['{#', '#}'], $source_format);
48
+		$source_parts = preg_split('/[{}]/i', $source_format);
49
+		if ($source_parts === false) {
50
+			return null;
51
+		}
52
+		$source_parts = array_map(function (string $part): string {
53
+			if (preg_match('/^#([^#]+)#$/i', $part, $column_id) === 1) {
54
+				return $this->columnName($column_id[1]);
55
+			}
56
+			return $this->sanitizeString(str_replace(['?', '*'], ['_', '%'], $part));
57
+		}, array_filter($source_parts));
58
+		$source_parts[] = "'%'";
59
+		$concat_statement = 'CONCAT(' . implode(', ', $source_parts) . ')';
60 60
 
61
-        // Extract columns used in target
62
-        $columns = [];
63
-        if (preg_match_all('/{(.*?)}/i', $target_format, $columns_select) === 1) {
64
-            $columns = array_unique(array_filter(array_map(fn($id) => $this->columnName($id), $columns_select[1])));
65
-        }
61
+		// Extract columns used in target
62
+		$columns = [];
63
+		if (preg_match_all('/{(.*?)}/i', $target_format, $columns_select) === 1) {
64
+			$columns = array_unique(array_filter(array_map(fn($id) => $this->columnName($id), $columns_select[1])));
65
+		}
66 66
 
67
-        // Get the mapping
68
-        $rows = DB::table('maj_geodata_ref')  //DB::table('maj_geodata_ref')
69
-            ->select($columns)
70
-            ->whereRaw($this->sanitizeString($source) . " LIKE " . $concat_statement)
71
-            ->get();
67
+		// Get the mapping
68
+		$rows = DB::table('maj_geodata_ref')  //DB::table('maj_geodata_ref')
69
+			->select($columns)
70
+			->whereRaw($this->sanitizeString($source) . " LIKE " . $concat_statement)
71
+			->get();
72 72
 
73
-        // Format the output ID
74
-        if ($rows->count() === 0) {
75
-            return null;
76
-        }
73
+		// Format the output ID
74
+		if ($rows->count() === 0) {
75
+			return null;
76
+		}
77 77
 
78
-        $mapping = (array) $rows->first();
79
-        if (count($columns_select) === 0) {
80
-            return $target_format;
81
-        }
78
+		$mapping = (array) $rows->first();
79
+		if (count($columns_select) === 0) {
80
+			return $target_format;
81
+		}
82 82
 
83
-        return str_replace(
84
-            array_map(fn($tag) => '{' . $tag . '}', $columns_select[1]),
85
-            array_map(fn($tag) => $mapping[$this->columnName($tag)] ?? '', $columns_select[1]),
86
-            $target_format
87
-        );
88
-    }
83
+		return str_replace(
84
+			array_map(fn($tag) => '{' . $tag . '}', $columns_select[1]),
85
+			array_map(fn($tag) => $mapping[$this->columnName($tag)] ?? '', $columns_select[1]),
86
+			$target_format
87
+		);
88
+	}
89 89
 
90
-    /**
91
-     * Get the column name for a format placeholder tag
92
-     *
93
-     * @param string $placeholder
94
-     * @return string
95
-     */
96
-    private function columnName(string $placeholder): string
97
-    {
98
-        return self::COLUMN_MAPPING[$placeholder] ?? '';
99
-    }
90
+	/**
91
+	 * Get the column name for a format placeholder tag
92
+	 *
93
+	 * @param string $placeholder
94
+	 * @return string
95
+	 */
96
+	private function columnName(string $placeholder): string
97
+	{
98
+		return self::COLUMN_MAPPING[$placeholder] ?? '';
99
+	}
100 100
 
101
-    /**
102
-     * Sanitize string for use in a SQL query.
103
-     *
104
-     * @param string $string
105
-     * @return string
106
-     */
107
-    private function sanitizeString(string $string): string
108
-    {
109
-        return DB::connection()->getPdo()->quote($string);
110
-    }
101
+	/**
102
+	 * Sanitize string for use in a SQL query.
103
+	 *
104
+	 * @param string $string
105
+	 * @return string
106
+	 */
107
+	private function sanitizeString(string $string): string
108
+	{
109
+		return DB::connection()->getPdo()->quote($string);
110
+	}
111 111
 }
Please login to merge, or discard this patch.