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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Tree;
use Psr\Http\Message\ServerRequestInterface;
/**
* Interface ModuleBlockInterface - Classes and libraries for module system
*/
interface ModuleBlockInterface extends ModuleInterface
{
// Places we can display blocks
public const string CONTEXT_EMBED = 'embed';
public const string CONTEXT_TREE_PAGE = 'tree';
public const string CONTEXT_USER_PAGE = 'user';
// We show blocks in two columns on the tree/user pages.
public const string MAIN_BLOCKS = 'main';
public const string SIDE_BLOCKS = 'side';
public const array DEFAULT_TREE_PAGE_BLOCKS = [
self::MAIN_BLOCKS => [
1 => FamilyTreeStatisticsModule::class,
2 => FamilyTreeNewsModule::class,
3 => FamilyTreeFavoritesModule::class,
4 => ReviewChangesModule::class,
],
self::SIDE_BLOCKS => [
1 => WelcomeBlockModule::class,
2 => SlideShowModule::class,
3 => OnThisDayModule::class,
4 => LoggedInUsersModule::class,
],
];
public const array DEFAULT_USER_PAGE_BLOCKS = [
self::MAIN_BLOCKS => [
1 => OnThisDayModule::class,
2 => UserMessagesModule::class,
3 => UserFavoritesModule::class,
],
self::SIDE_BLOCKS => [
1 => UserWelcomeModule::class,
2 => SlideShowModule::class,
3 => UpcomingAnniversariesModule::class,
4 => LoggedInUsersModule::class,
],
];
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param string $context
* @param array<string,string> $config
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string;
/**
* Should this block load asynchronously using AJAX?
*
* Simple blocks are faster in-line, more complex ones can be loaded later.
*
* @return bool
*/
public function loadAjax(): bool;
/**
* Can this block be shown on the user’s home page?
*
* @return bool
*/
public function isUserBlock(): bool;
/**
* Can this block be shown on the tree’s home page?
*
* @return bool
*/
public function isTreeBlock(): bool;
/**
* An HTML form to edit block settings
*
* @param Tree $tree
* @param int $block_id
*
* @return string
*/
public function editBlockConfiguration(Tree $tree, int $block_id): string;
/**
* Update the configuration for a block.
*
* @param ServerRequestInterface $request
* @param int $block_id
*
* @return void
*/
public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void;
}
|
