@@ -1,14 +1,14 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | /** |
4 | - * webtrees-lib: MyArtJaub library for webtrees |
|
5 | - * |
|
6 | - * @package MyArtJaub\Webtrees |
|
7 | - * @subpackage Hooks |
|
8 | - * @author Jonathan Jaubart <[email protected]> |
|
9 | - * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | - * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | - */ |
|
4 | + * webtrees-lib: MyArtJaub library for webtrees |
|
5 | + * |
|
6 | + * @package MyArtJaub\Webtrees |
|
7 | + * @subpackage Hooks |
|
8 | + * @author Jonathan Jaubart <[email protected]> |
|
9 | + * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | + * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | + */ |
|
12 | 12 | |
13 | 13 | declare(strict_types=1); |
14 | 14 | |
@@ -20,12 +20,12 @@ discard block |
||
20 | 20 | interface HookServiceInterface |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * Select the hook collector to use for a specific hook interface |
|
25 | - * |
|
26 | - * @template THook of HookInterface |
|
27 | - * @param class-string<THook> $hook_interface |
|
28 | - * @return HookCollectorInterface<THook>|NULL |
|
29 | - */ |
|
30 | - public function use(string $hook_interface): ?HookCollectorInterface; |
|
23 | + /** |
|
24 | + * Select the hook collector to use for a specific hook interface |
|
25 | + * |
|
26 | + * @template THook of HookInterface |
|
27 | + * @param class-string<THook> $hook_interface |
|
28 | + * @return HookCollectorInterface<THook>|NULL |
|
29 | + */ |
|
30 | + public function use(string $hook_interface): ?HookCollectorInterface; |
|
31 | 31 | } |
@@ -1,14 +1,14 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | /** |
4 | - * webtrees-lib: MyArtJaub library for webtrees |
|
5 | - * |
|
6 | - * @package MyArtJaub\Webtrees |
|
7 | - * @subpackage Hooks |
|
8 | - * @author Jonathan Jaubart <[email protected]> |
|
9 | - * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | - * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | - */ |
|
4 | + * webtrees-lib: MyArtJaub library for webtrees |
|
5 | + * |
|
6 | + * @package MyArtJaub\Webtrees |
|
7 | + * @subpackage Hooks |
|
8 | + * @author Jonathan Jaubart <[email protected]> |
|
9 | + * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | + * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | + */ |
|
12 | 12 | |
13 | 13 | declare(strict_types=1); |
14 | 14 | |
@@ -22,10 +22,10 @@ discard block |
||
22 | 22 | interface HookInterface |
23 | 23 | { |
24 | 24 | |
25 | - /** |
|
26 | - * Get the module attached to the hook |
|
27 | - * |
|
28 | - * @return ModuleInterface |
|
29 | - */ |
|
30 | - public function module(): ModuleInterface; |
|
25 | + /** |
|
26 | + * Get the module attached to the hook |
|
27 | + * |
|
28 | + * @return ModuleInterface |
|
29 | + */ |
|
30 | + public function module(): ModuleInterface; |
|
31 | 31 | } |
@@ -1,14 +1,14 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | 3 | /** |
4 | - * webtrees-lib: MyArtJaub library for webtrees |
|
5 | - * |
|
6 | - * @package MyArtJaub\Webtrees |
|
7 | - * @subpackage Hooks |
|
8 | - * @author Jonathan Jaubart <[email protected]> |
|
9 | - * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | - * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | - */ |
|
4 | + * webtrees-lib: MyArtJaub library for webtrees |
|
5 | + * |
|
6 | + * @package MyArtJaub\Webtrees |
|
7 | + * @subpackage Hooks |
|
8 | + * @author Jonathan Jaubart <[email protected]> |
|
9 | + * @copyright Copyright (c) 2011-2021, Jonathan Jaubart |
|
10 | + * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 |
|
11 | + */ |
|
12 | 12 | |
13 | 13 | declare(strict_types=1); |
14 | 14 | |
@@ -19,11 +19,11 @@ discard block |
||
19 | 19 | */ |
20 | 20 | interface FamilyDatatablesExtenderInterface extends HookInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * Get the columns to be added to families datatables |
|
24 | - * |
|
25 | - * @param iterable<\Fisharebest\Webtrees\Family> $records |
|
26 | - * @return array<string, array<string, array<string, mixed>>> |
|
27 | - */ |
|
28 | - public function familyColumns(iterable $records): array; |
|
22 | + /** |
|
23 | + * Get the columns to be added to families datatables |
|
24 | + * |
|
25 | + * @param iterable<\Fisharebest\Webtrees\Family> $records |
|
26 | + * @return array<string, array<string, array<string, mixed>>> |
|
27 | + */ |
|
28 | + public function familyColumns(iterable $records): array; |
|
29 | 29 | } |
@@ -19,10 +19,10 @@ |
||
19 | 19 | */ |
20 | 20 | interface ModulePlaceMapperProviderInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * List place mappers provided by the module as an array. |
|
24 | - * |
|
25 | - * @return string[] List of place mappers |
|
26 | - */ |
|
27 | - public function listPlaceMappers(): array; |
|
22 | + /** |
|
23 | + * List place mappers provided by the module as an array. |
|
24 | + * |
|
25 | + * @return string[] List of place mappers |
|
26 | + */ |
|
27 | + public function listPlaceMappers(): array; |
|
28 | 28 | } |
@@ -22,26 +22,26 @@ |
||
22 | 22 | */ |
23 | 23 | interface GeoAnalysisInterface |
24 | 24 | { |
25 | - /** |
|
26 | - * Get the geographical dispersion analysis title |
|
27 | - * |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function title(): string; |
|
25 | + /** |
|
26 | + * Get the geographical dispersion analysis title |
|
27 | + * |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function title(): string; |
|
31 | 31 | |
32 | - /** |
|
33 | - * Gets the function to translate |
|
34 | - * |
|
35 | - * @return callable(int $count): string |
|
36 | - */ |
|
37 | - public function itemsDescription(): callable; |
|
32 | + /** |
|
33 | + * Gets the function to translate |
|
34 | + * |
|
35 | + * @return callable(int $count): string |
|
36 | + */ |
|
37 | + public function itemsDescription(): callable; |
|
38 | 38 | |
39 | - /** |
|
40 | - * Get the results of the geographical dispersion analysis |
|
41 | - * |
|
42 | - * @param Tree $tree |
|
43 | - * @param int $depth |
|
44 | - * @return GeoAnalysisResults |
|
45 | - */ |
|
46 | - public function results(Tree $tree, int $depth): GeoAnalysisResults; |
|
39 | + /** |
|
40 | + * Get the results of the geographical dispersion analysis |
|
41 | + * |
|
42 | + * @param Tree $tree |
|
43 | + * @param int $depth |
|
44 | + * @return GeoAnalysisResults |
|
45 | + */ |
|
46 | + public function results(Tree $tree, int $depth): GeoAnalysisResults; |
|
47 | 47 | } |
@@ -19,24 +19,24 @@ |
||
19 | 19 | */ |
20 | 20 | interface MapDefinitionInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * Get the map ID |
|
24 | - * |
|
25 | - * @return string |
|
26 | - */ |
|
27 | - public function id(): string; |
|
22 | + /** |
|
23 | + * Get the map ID |
|
24 | + * |
|
25 | + * @return string |
|
26 | + */ |
|
27 | + public function id(): string; |
|
28 | 28 | |
29 | - /** |
|
30 | - * Get the map title |
|
31 | - * |
|
32 | - * @return string |
|
33 | - */ |
|
34 | - public function title(): string; |
|
29 | + /** |
|
30 | + * Get the map title |
|
31 | + * |
|
32 | + * @return string |
|
33 | + */ |
|
34 | + public function title(): string; |
|
35 | 35 | |
36 | - /** |
|
37 | - * Get the features in the map |
|
38 | - * |
|
39 | - * @return \Brick\Geo\IO\GeoJSON\Feature[] |
|
40 | - */ |
|
41 | - public function features(): array; |
|
36 | + /** |
|
37 | + * Get the features in the map |
|
38 | + * |
|
39 | + * @return \Brick\Geo\IO\GeoJSON\Feature[] |
|
40 | + */ |
|
41 | + public function features(): array; |
|
42 | 42 | } |
@@ -19,26 +19,26 @@ |
||
19 | 19 | */ |
20 | 20 | interface MapViewConfigInterface |
21 | 21 | { |
22 | - /** |
|
23 | - * Get the feature property to be used for mapping the map feature with the analysis results |
|
24 | - * |
|
25 | - * @return string |
|
26 | - */ |
|
27 | - public function mapMappingProperty(): string; |
|
22 | + /** |
|
23 | + * Get the feature property to be used for mapping the map feature with the analysis results |
|
24 | + * |
|
25 | + * @return string |
|
26 | + */ |
|
27 | + public function mapMappingProperty(): string; |
|
28 | 28 | |
29 | - /** |
|
30 | - * Get the config of the mapper associated with the map view |
|
31 | - * |
|
32 | - * @return PlaceMapperConfigInterface |
|
33 | - */ |
|
34 | - public function mapperConfig(): PlaceMapperConfigInterface; |
|
29 | + /** |
|
30 | + * Get the config of the mapper associated with the map view |
|
31 | + * |
|
32 | + * @return PlaceMapperConfigInterface |
|
33 | + */ |
|
34 | + public function mapperConfig(): PlaceMapperConfigInterface; |
|
35 | 35 | |
36 | - /** |
|
37 | - * Get a MapViewConfigInterface object with the new properties |
|
38 | - * |
|
39 | - * @param string $mapping_property |
|
40 | - * @param PlaceMapperConfigInterface $mapper_config |
|
41 | - * @return static |
|
42 | - */ |
|
43 | - public function with(string $mapping_property, PlaceMapperConfigInterface $mapper_config): self; |
|
36 | + /** |
|
37 | + * Get a MapViewConfigInterface object with the new properties |
|
38 | + * |
|
39 | + * @param string $mapping_property |
|
40 | + * @param PlaceMapperConfigInterface $mapper_config |
|
41 | + * @return static |
|
42 | + */ |
|
43 | + public function with(string $mapping_property, PlaceMapperConfigInterface $mapper_config): self; |
|
44 | 44 | } |
@@ -20,10 +20,10 @@ |
||
20 | 20 | interface ModuleGeoAnalysisProviderInterface |
21 | 21 | { |
22 | 22 | |
23 | - /** |
|
24 | - * List geographical analyses provided by the module as an array. |
|
25 | - * |
|
26 | - * @return string[] List of geographical analyses |
|
27 | - */ |
|
28 | - public function listGeoAnalyses(): array; |
|
23 | + /** |
|
24 | + * List geographical analyses provided by the module as an array. |
|
25 | + * |
|
26 | + * @return string[] List of geographical analyses |
|
27 | + */ |
|
28 | + public function listGeoAnalyses(): array; |
|
29 | 29 | } |
@@ -22,54 +22,54 @@ |
||
22 | 22 | */ |
23 | 23 | interface PlaceMapperInterface |
24 | 24 | { |
25 | - /** |
|
26 | - * Get the Place mapper title |
|
27 | - * |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function title(): string; |
|
25 | + /** |
|
26 | + * Get the Place mapper title |
|
27 | + * |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function title(): string; |
|
31 | 31 | |
32 | - /** |
|
33 | - * Boot the Place mapper |
|
34 | - */ |
|
35 | - public function boot(): void; |
|
32 | + /** |
|
33 | + * Boot the Place mapper |
|
34 | + */ |
|
35 | + public function boot(): void; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Get the configuration associated to the mapper |
|
39 | - * |
|
40 | - * @return PlaceMapperConfigInterface |
|
41 | - */ |
|
42 | - public function config(): PlaceMapperConfigInterface; |
|
37 | + /** |
|
38 | + * Get the configuration associated to the mapper |
|
39 | + * |
|
40 | + * @return PlaceMapperConfigInterface |
|
41 | + */ |
|
42 | + public function config(): PlaceMapperConfigInterface; |
|
43 | 43 | |
44 | - /** |
|
45 | - * Set the configured associated to the mapper |
|
46 | - * |
|
47 | - * @param PlaceMapperConfigInterface $config |
|
48 | - */ |
|
49 | - public function setConfig(PlaceMapperConfigInterface $config): void; |
|
44 | + /** |
|
45 | + * Set the configured associated to the mapper |
|
46 | + * |
|
47 | + * @param PlaceMapperConfigInterface $config |
|
48 | + */ |
|
49 | + public function setConfig(PlaceMapperConfigInterface $config): void; |
|
50 | 50 | |
51 | - /** |
|
52 | - * Get the data associated to the mapper, for a specific key |
|
53 | - * |
|
54 | - * @param string $key |
|
55 | - * @return null|mixed |
|
56 | - */ |
|
57 | - public function data(string $key); |
|
51 | + /** |
|
52 | + * Get the data associated to the mapper, for a specific key |
|
53 | + * |
|
54 | + * @param string $key |
|
55 | + * @return null|mixed |
|
56 | + */ |
|
57 | + public function data(string $key); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Set the data associated to the mapper, for a specific key |
|
61 | - * |
|
62 | - * @param string $key |
|
63 | - * @param mixed $data |
|
64 | - */ |
|
65 | - public function setData(string $key, $data): void; |
|
59 | + /** |
|
60 | + * Set the data associated to the mapper, for a specific key |
|
61 | + * |
|
62 | + * @param string $key |
|
63 | + * @param mixed $data |
|
64 | + */ |
|
65 | + public function setData(string $key, $data): void; |
|
66 | 66 | |
67 | - /** |
|
68 | - * Return the property value of the feature identifying a place in a GeoJson map. |
|
69 | - * |
|
70 | - * @param Place $place |
|
71 | - * @param string $feature_property |
|
72 | - * @return string|NULL |
|
73 | - */ |
|
74 | - public function map(Place $place, string $feature_property): ?string; |
|
67 | + /** |
|
68 | + * Return the property value of the feature identifying a place in a GeoJson map. |
|
69 | + * |
|
70 | + * @param Place $place |
|
71 | + * @param string $feature_property |
|
72 | + * @return string|NULL |
|
73 | + */ |
|
74 | + public function map(Place $place, string $feature_property): ?string; |
|
75 | 75 | } |