xref: /webtrees/app/Module/WelcomeBlockModule.php (revision b2dd3be6317810cbb439bcfcb5e03e2cf038e314) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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 */
16namespace Fisharebest\Webtrees\Module;
17
18use Fisharebest\Webtrees\Auth;
19use Fisharebest\Webtrees\Html;
20use Fisharebest\Webtrees\I18N;
21use Fisharebest\Webtrees\Module;
22use Fisharebest\Webtrees\Site;
23
24/**
25 * Class WelcomeBlockModule
26 */
27class WelcomeBlockModule extends AbstractModule implements ModuleBlockInterface {
28	/** {@inheritdoc} */
29	public function getTitle() {
30		return /* I18N: Name of a module */
31			I18N::translate('Home page');
32	}
33
34	/** {@inheritdoc} */
35	public function getDescription() {
36		return /* I18N: Description of the “Home page” module */
37			I18N::translate('A greeting message for site visitors.');
38	}
39
40	/**
41	 * Generate the HTML content of this block.
42	 *
43	 * @param int      $block_id
44	 * @param bool     $template
45	 * @param string[] $cfg
46	 *
47	 * @return string
48	 */
49	public function getBlock($block_id, $template = true, $cfg = []): string {
50		global $controller;
51
52		$individual = $controller->getSignificantIndividual();
53
54		$links = [];
55
56		if (Module::isActiveChart($individual->getTree(), 'pedigree_chart')) {
57			$links[] = [
58				'url'   => route('pedigree', ['xref' => $individual->getXref(), 'ged' => $individual->getTree()->getName()]),
59				'title' => I18N::translate('Default chart'),
60				'icon'  => 'icon-pedigree',
61			];
62		}
63
64		$links[] = [
65			'url'   => $individual->url(),
66			'title' => I18N::translate('Default individual'),
67			'icon'  => 'icon-indis',
68		];
69
70		if (Site::getPreference('USE_REGISTRATION_MODULE') === '1' && !Auth::check()) {
71			$links[] = [
72				'url'   => route('register'),
73				'title' => I18N::translate('Request a new user account'),
74				'icon'  => 'icon-user_add',
75			];
76		}
77
78		$content = view('blocks/welcome', ['links' => $links]);
79
80		if ($template) {
81			return view('blocks/template', [
82				'block'      => str_replace('_', '-', $this->getName()),
83				'id'         => $block_id,
84				'config_url' => '',
85				'title'      => $individual->getTree()->getTitle(),
86				'content'    => $content,
87			]);
88		} else {
89			return $content;
90		}
91	}
92
93	/** {@inheritdoc} */
94	public function loadAjax(): bool {
95		return false;
96	}
97
98	/** {@inheritdoc} */
99	public function isUserBlock(): bool {
100		return false;
101	}
102
103	/** {@inheritdoc} */
104	public function isGedcomBlock(): bool {
105		return true;
106	}
107
108	/**
109	 * An HTML form to edit block settings
110	 *
111	 * @param int $block_id
112	 *
113	 * @return void
114	 */
115	public function configureBlock($block_id) {
116	}
117}
118