3 namespace Friendica\Module;
6 use Friendica\BaseModule;
7 use Friendica\Content\Pager;
8 use Friendica\Core\Renderer;
9 use Friendica\Core\System;
11 use Friendica\Network\HTTPException\ForbiddenException;
12 use Friendica\Object\Notification\Notification;
15 * Base Module for each tab of the notification display
17 * General possibility to print it as JSON as well
19 abstract class BaseNotifications extends BaseModule
21 /** @var array Array of URL parameters */
23 Notification::NETWORK => 'network',
24 Notification::SYSTEM => 'system',
25 Notification::HOME => 'home',
26 Notification::PERSONAL => 'personal',
27 Notification::INTRO => 'intros',
30 /** @var array Array of the allowed notifications and their printable name */
32 Notification::NETWORK => 'Network',
33 Notification::SYSTEM => 'System',
34 Notification::HOME => 'Home',
35 Notification::PERSONAL => 'Personal',
36 Notification::INTRO => 'Introductions',
39 /** @var array The array of access keys for notification pages */
41 Notification::NETWORK => 'w',
42 Notification::SYSTEM => 'y',
43 Notification::HOME => 'h',
44 Notification::PERSONAL => 'r',
45 Notification::INTRO => 'i',
48 /** @var int The default count of items per page */
49 const ITEMS_PER_PAGE = 20;
50 /** @var int The default limit of notifications per page */
51 const DEFAULT_PAGE_LIMIT = 80;
53 /** @var boolean True, if ALL entries should get shown */
54 protected static $showAll;
55 /** @var int The determined start item of the current page */
56 protected static $firstItemNum;
59 * Collects all notifications from the backend
61 * @return array The determined notification array
62 * ['header', 'notifications']
64 abstract public static function getNotifications();
66 public static function init(array $parameters = [])
69 throw new ForbiddenException(DI::l10n()->t('Permission denied.'));
72 $page = ($_REQUEST['page'] ?? 0) ?: 1;
74 self::$firstItemNum = ($page * self::ITEMS_PER_PAGE) - self::ITEMS_PER_PAGE;
75 self::$showAll = ($_REQUEST['show'] ?? '') === 'all';
78 public static function rawContent(array $parameters = [])
80 // If the last argument of the query is NOT json, return
81 if (DI::args()->get(DI::args()->getArgc() - 1) !== 'json') {
86 $pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
88 // Add additional informations (needed for json output)
90 'notifications' => static::getNotifications(),
91 'items_page' => $pager->getItemsPerPage(),
92 'page' => $pager->getPage(),
95 System::jsonExit($notifications);
99 * Shows the printable result of notifications for a specific tab
101 * @param string $header The notification header
102 * @param array $notifications The array with the notifications
103 * @param string $noContent The string in case there are no notifications
104 * @param array $showLink The possible links at the top
106 * @return string The rendered output
108 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
110 protected static function printContent(string $header, array $notifications, string $noContent, array $showLink)
112 // Get the nav tabs for the notification pages
113 $tabs = self::getTabs();
116 $pager = new Pager(DI::args()->getQueryString(), self::ITEMS_PER_PAGE);
118 $notif_tpl = Renderer::getMarkupTemplate('notifications/notifications.tpl');
119 return Renderer::replaceMacros($notif_tpl, [
120 '$header' => $header ?? DI::l10n()->t('Notifications'),
122 '$notifications' => $notifications,
123 '$noContent' => $noContent,
124 '$showLink' => $showLink,
125 '$paginate' => $pager->renderMinimal(count($notifications))
130 * List of pages for the Notifications TabBar
132 * @return array with with notifications TabBar data
135 private static function getTabs()
137 $selected = DI::args()->get(1, '');
141 foreach (self::URL_TYPES as $type => $url) {
143 'label' => DI::l10n()->t(self::PRINT_TYPES[$type]),
144 'url' => 'notifications/' . $url,
145 'sel' => (($selected == $url) ? 'active' : ''),
146 'id' => $type . '-tab',
147 'accesskey' => self::ACCESS_KEYS[$type],