From: nupplaPhil <admin@philipp.info>
Date: Wed, 22 Jan 2020 22:31:00 +0000 (+0100)
Subject: Add phpdoc
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=d0c153943ad53e6b868005a6bb8c75ca4b5379cc;p=friendica.git

Add phpdoc
---

diff --git a/src/Module/BaseNotifications.php b/src/Module/BaseNotifications.php
index be2ad16b2b..feec56aea3 100644
--- a/src/Module/BaseNotifications.php
+++ b/src/Module/BaseNotifications.php
@@ -11,6 +11,11 @@ use Friendica\DI;
 use Friendica\Model\Notify;
 use Friendica\Network\HTTPException\ForbiddenException;
 
+/**
+ * Base Module for each tab of the notification display
+ *
+ * General possibility to print it as JSON as well
+ */
 abstract class BaseNotifications extends BaseModule
 {
 	/** @var array Array of URL parameters */
@@ -40,9 +45,12 @@ abstract class BaseNotifications extends BaseModule
 		Notify::INTRO    => 'i',
 	];
 
+	/** @var int The default count of items per page */
 	const PER_PAGE = 20;
 
+	/** @var boolean True, if ALL entries should get shown */
 	protected static $show;
+	/** @var int The determined start item of the current page */
 	protected static $start;
 
 	/**
@@ -62,7 +70,7 @@ abstract class BaseNotifications extends BaseModule
 		$page = ($_REQUEST['page'] ?? 0) ?: 1;
 
 		self::$start = ($page * self::PER_PAGE) - self::PER_PAGE;
-		self::$show = ($_REQUEST['show'] ?? '') === 'all';
+		self::$show  = ($_REQUEST['show'] ?? '') === 'all';
 	}
 
 	public static function post(array $parameters = [])
@@ -99,7 +107,19 @@ abstract class BaseNotifications extends BaseModule
 		System::jsonExit(static::getNotifies()['notifs'] ?? []);
 	}
 
-	public static function printContent(string $notif_header, array $notif_content, string $notif_nocontent, array $notif_show_lnk)
+	/**
+	 * Shows the printable result of notifications for a specific tab
+	 *
+	 * @param string $notif_header    The notification header
+	 * @param array  $notif_content   The array with the notifications
+	 * @param string $notif_nocontent The string in case there are no notifications
+	 * @param array  $notif_show_lnk  The possible links at the top
+	 *
+	 * @return string The rendered output
+	 *
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	protected static function printContent(string $notif_header, array $notif_content, string $notif_nocontent, array $notif_show_lnk)
 	{
 		// Get the nav tabs for the notification pages
 		$tabs = self::getTabs();
diff --git a/src/Module/Notifications/Introductions.php b/src/Module/Notifications/Introductions.php
index 7befb45ce0..7de1820362 100644
--- a/src/Module/Notifications/Introductions.php
+++ b/src/Module/Notifications/Introductions.php
@@ -10,6 +10,9 @@ use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Module\BaseNotifications;
 
+/**
+ * Prints notifications about introduction
+ */
 class Introductions extends BaseNotifications
 {
 	/**
diff --git a/src/Module/Notifications/Notifications.php b/src/Module/Notifications/Notifications.php
index b1172cadc3..b15c7feca0 100644
--- a/src/Module/Notifications/Notifications.php
+++ b/src/Module/Notifications/Notifications.php
@@ -8,6 +8,13 @@ use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Module\BaseNotifications;
 
+/**
+ * Prints all notification types except introduction:
+ * - Network
+ * - System
+ * - Personal
+ * - Home
+ */
 class Notifications extends BaseNotifications
 {
 	/**