-
Notifications
You must be signed in to change notification settings - Fork 3
/
VestaCommonLibModule.php
95 lines (74 loc) · 3.32 KB
/
VestaCommonLibModule.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?php
namespace Vesta;
use Cissee\WebtreesExt\AbstractModule;
use Cissee\WebtreesExt\Module\ModuleMetaInterface;
use Cissee\WebtreesExt\Module\ModuleMetaTrait;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Module\ModuleCustomInterface;
use Fisharebest\Webtrees\Module\ModuleCustomTrait;
use Fisharebest\Webtrees\View;
use function GuzzleHttp\json_decode;
class VestaCommonLibModule extends AbstractModule implements
ModuleCustomInterface, ModuleMetaInterface {
use ModuleCustomTrait,
ModuleMetaTrait,
VestaModuleCustomTrait {
VestaModuleCustomTrait::customTranslations insteadof ModuleCustomTrait;
ModuleMetaTrait::customModuleVersion insteadof ModuleCustomTrait;
ModuleMetaTrait::customModuleLatestVersion insteadof ModuleCustomTrait;
}
private $vesta;
public function __construct() {
$this->vesta = json_decode('"\u26B6"');
}
public function customModuleAuthorName(): string {
return 'Richard Cissée';
}
public function customModuleSupportUrl(): string {
return 'https://cissee.de';
}
public function customModuleMetaDatasJson(): string {
return file_get_contents(__DIR__ . '/metadata.json');
}
public function customModuleLatestMetaDatasJsonUrl(): string {
return 'https://raw.githubusercontent.com/vesta-webtrees-2-custom-modules/vesta_common/master/metadata.json';
}
public function resourcesFolder(): string {
return __DIR__ . '/resources/';
}
public function title(): string {
$title = CommonI18N::titleVestaCommon();
return $this->vesta . ' ' . $title;
}
public function description(): string {
$description = I18N::translate('A module providing common classes and translations for other \'Vesta\' custom modules.') . ' ' .
I18N::translate('Make sure to enable this module if any other Vesta module is enabled.');
//I18N::translate('This module cannot be disabled.');
//actually not too much breaks when this module is disabled
//(apart from the stuff in onBoot())
//but it seems easier not to go into details here ...
if (!$this->isEnabled()) {
$description = ModuleI18N::translate($this, $description);
}
return $description;
}
public function boot(): void {
$this->flashWhatsNew('\Vesta\WhatsNew', 3);
// Register a namespace for our views.
View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
// Replace an existing view with our own version.
View::registerCustomView('::admin/upgrade/wizard', $this->name() . '::admin/upgrade/wizard');
//allow custom modules to add head/body content to admin pages as well
View::registerCustomView('::layouts/administration', $this->name() . '::layouts/administration');
View::registerCustomView('::components/select-with-optgroup', $this->name() . '::components/select-with-optgroup');
}
//Issue #62
//blocking this goes against best practices wrt investigating webtrees bugs
//also 'has no useful effect' is no longer strictly true as there are actual changes made by this module itself
/*
public function isEnabled(): bool {
//disabling this module has no useful effect, so we block disabling
return true;
}
*/
}