xref: /webtrees/app/Module/LoginBlockModule.php (revision fcfa147e10aaa6c7ff580c29bd6e5b88666befc1) 
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\I18N;
24use Fisharebest\Webtrees\Site;
25use Fisharebest\Webtrees\Tree;
26use Illuminate\Support\Str;
27
28/**
29 * Class LoginBlockModule
30 */
31class LoginBlockModule extends AbstractModule implements ModuleBlockInterface
32{
33    use ModuleBlockTrait;
34
35    /**
36     * How should this module be identified in the control panel, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        /* I18N: Name of a module */
43        return I18N::translate('Sign in');
44    }
45
46    /**
47     * A sentence describing what this module does.
48     *
49     * @return string
50     */
51    public function description(): string
52    {
53        /* I18N: Description of the “Sign in” module */
54        return I18N::translate('An alternative way to sign in and sign out.');
55    }
56
57    /**
58     * Generate the HTML content of this block.
59     *
60     * @param Tree     $tree
61     * @param int      $block_id
62     * @param string   $context
63     * @param string[] $config
64     *
65     * @return string
66     */
67    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
68    {
69        if (Auth::check()) {
70            $title   = I18N::translate('Sign out');
71            $content = view('modules/login_block/sign-out', [
72                'user' => Auth::user(),
73            ]);
74        } else {
75            $title   = I18N::translate('Sign in');
76            $content = view('modules/login_block/sign-in', [
77                'allow_register' => (bool) Site::getPreference('USE_REGISTRATION_MODULE'),
78                'url'            => route('tree-page', ['tree' => $tree->name()]),
79            ]);
80        }
81
82        if ($context !== self::CONTEXT_EMBED) {
83            return view('modules/block-template', [
84                'block'      => Str::kebab($this->name()),
85                'id'         => $block_id,
86                'config_url' => '',
87                'title'      => $title,
88                'content'    => $content,
89            ]);
90        }
91
92        return $content;
93    }
94
95    /**
96     * Should this block load asynchronously using AJAX?
97     *
98     * Simple blocks are faster in-line, more complex ones can be loaded later.
99     *
100     * @return bool
101     */
102    public function loadAjax(): bool
103    {
104        return false;
105    }
106
107    /**
108     * Can this block be shown on the user’s home page?
109     *
110     * @return bool
111     */
112    public function isUserBlock(): bool
113    {
114        return true;
115    }
116
117    /**
118     * Can this block be shown on the tree’s home page?
119     *
120     * @return bool
121     */
122    public function isTreeBlock(): bool
123    {
124        return true;
125    }
126}
127