xref: /webtrees/app/Module/LoginBlockModule.php (revision 1e7a7a28dc1ca3b4463e0c60d00ce3163e72010d) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Site;
23use Fisharebest\Webtrees\Tree;
24use Illuminate\Support\Str;
25use Symfony\Component\HttpFoundation\Request;
26
27/**
28 * Class LoginBlockModule
29 */
30class LoginBlockModule extends AbstractModule implements ModuleBlockInterface
31{
32    use ModuleBlockTrait;
33
34    /**
35     * How should this module be identified in the control panel, etc.?
36     *
37     * @return string
38     */
39    public function title(): string
40    {
41        /* I18N: Name of a module */
42        return I18N::translate('Sign in');
43    }
44
45    /**
46     * A sentence describing what this module does.
47     *
48     * @return string
49     */
50    public function description(): string
51    {
52        /* I18N: Description of the “Sign in” module */
53        return I18N::translate('An alternative way to sign in and sign out.');
54    }
55
56    /**
57     * Generate the HTML content of this block.
58     *
59     * @param Tree     $tree
60     * @param int      $block_id
61     * @param string   $ctype
62     * @param string[] $cfg
63     *
64     * @return string
65     */
66    public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
67    {
68        if (Auth::check()) {
69            $title   = I18N::translate('Sign out');
70            $content = view('modules/login_block/sign-out', [
71                'user' => Auth::user(),
72            ]);
73        } else {
74            $title   = I18N::translate('Sign in');
75            $content = view('modules/login_block/sign-in', [
76                'allow_register' => (bool) Site::getPreference('USE_REGISTRATION_MODULE'),
77            ]);
78        }
79
80        if ($ctype !== '') {
81            return view('modules/block-template', [
82                'block'      => Str::kebab($this->name()),
83                'id'         => $block_id,
84                'config_url' => '',
85                'title'      => $title,
86                'content'    => $content,
87            ]);
88        }
89
90        return $content;
91    }
92
93    /** {@inheritdoc} */
94    public function loadAjax(): bool
95    {
96        return false;
97    }
98
99    /** {@inheritdoc} */
100    public function isUserBlock(): bool
101    {
102        return true;
103    }
104
105    /** {@inheritdoc} */
106    public function isTreeBlock(): bool
107    {
108        return true;
109    }
110
111    /**
112     * Update the configuration for a block.
113     *
114     * @param Request $request
115     * @param int     $block_id
116     *
117     * @return void
118     */
119    public function saveBlockConfiguration(Request $request, int $block_id): void
120    {
121    }
122
123    /**
124     * An HTML form to edit block settings
125     *
126     * @param Tree $tree
127     * @param int  $block_id
128     *
129     * @return void
130     */
131    public function editBlockConfiguration(Tree $tree, int $block_id): void
132    {
133    }
134}
135