xref: /webtrees/app/Module/ModuleBlockTrait.php (revision c06384d0dc00d3271940d4c4da1c38f13ddb0cba) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Tree;
24use Psr\Http\Message\ServerRequestInterface;
25
26use function route;
27
28/**
29 * Trait ModuleBlockTrait - default implementation of ModuleBlockInterface
30 */
31trait ModuleBlockTrait
32{
33    /**
34     * @param Tree   $tree
35     * @param string $context
36     * @param int    $block_id
37     *
38     * @return string
39     */
40    protected function configUrl(Tree $tree, string $context, int $block_id): string
41    {
42        if ($context === self::CONTEXT_TREE_PAGE && Auth::isManager($tree)) {
43            return route('tree-page-block-edit', [
44                'block_id' => $block_id,
45                'tree'     => $tree->name(),
46            ]);
47        }
48
49        if ($context === self::CONTEXT_USER_PAGE && Auth::check()) {
50            return route('user-page-block-edit', [
51                'block_id' => $block_id,
52                'tree'     => $tree->name(),
53            ]);
54        }
55
56        return '';
57    }
58
59    /**
60     * Update the configuration for a block.
61     *
62     * @param ServerRequestInterface $request
63     * @param int                    $block_id
64     *
65     * @return void
66     */
67    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
68    {
69    }
70
71    /**
72     * An HTML form to edit block settings
73     *
74     * @param Tree $tree
75     * @param int  $block_id
76     *
77     * @return string
78     */
79    public function editBlockConfiguration(Tree $tree, int $block_id): string
80    {
81        return '';
82    }
83}
84