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