1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2015 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use PDO;
/**
* Class UserFavoritesModule
*
* The "user favorites" module is almost identical to the "family tree favorites" module
*/
class UserFavoritesModule extends FamilyTreeFavoritesModule {
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “Favorites” module */ I18N::translate('Display and manage a user’s favorite pages.');
}
/**
* Can this block be shown on the user’s home page?
*
* @return bool
*/
public function isUserBlock() {
return true;
}
/**
* Can this block be shown on the tree’s home page?
*
* @return bool
*/
public function isGedcomBlock() {
return false;
}
/**
* Get the favorites for a user (for the current family tree)
*
* @param int $user_id
*
* @return string[][]
*/
public static function getFavorites($user_id) {
global $WT_TREE;
return
Database::prepare(
"SELECT SQL_CACHE favorite_id AS id, user_id, gedcom_id, xref AS gid, favorite_type AS type, title AS title, note AS note, url AS url" .
" FROM `##favorite` WHERE user_id=? AND gedcom_id=?")
->execute(array($user_id, $WT_TREE->getTreeId()))
->fetchAll(PDO::FETCH_ASSOC);
}
/**
* This is a general purpose hook, allowing modules to respond to routes
* of the form module.php?mod=FOO&mod_action=BAR
*
* @param string $mod_action
*/
public function modAction($mod_action) {
global $WT_TREE;
switch ($mod_action) {
case 'menu-add-favorite':
// Process the "add to user favorites" menu item on indi/fam/etc. pages
$record = GedcomRecord::getInstance(Filter::post('xref', WT_REGEX_XREF), $WT_TREE);
if (Auth::check() && $record->canShowName()) {
self::addFavorite(array(
'user_id' => Auth::id(),
'gedcom_id' => $record->getTree()->getTreeId(),
'gid' => $record->getXref(),
'type' => $record::RECORD_TYPE,
'url' => null,
'note' => null,
'title' => null,
));
FlashMessages::addMessage(/* I18N: %s is the name of an individual, source or other record */ I18N::translate('“%s” has been added to your favorites.', $record->getFullName()));
}
break;
}
}
}
|
