Merge pull request #9411 from tobiasd/20201011-de

[friendica.git] / src / Model / PushSubscriber.php

diff --git a/src/Model/PushSubscriber.php b/src/Model/PushSubscriber.php
index 44495daeefb4b1b66c251326bf4d8813f325a68b..2a7be3c35a1c6eb86f8264d6015f81e0f3aea4d4 100644 (file)
--- a/src/Model/PushSubscriber.php
+++ b/src/Model/PushSubscriber.php
@@ -1,7 +1,24 @@
 <?php
 /**
- * @file src/Model/PushSubscriber.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Model;
 
 use Friendica\Core\Logger;
@@ -9,15 +26,14 @@ use Friendica\Core\Worker;
 use Friendica\Database\DBA;
 use Friendica\Util\DateTimeFormat;
 
-require_once 'include/dba.php';
-
 class PushSubscriber
 {
        /**
-        * @brief Send subscription notifications for the given user
+        * Send subscription notifications for the given user
         *
-        * @param integer $uid      User ID
-        * @param string  $priority Priority for push workers
+        * @param integer $uid User ID
+        * @param int     $default_priority
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function publishFeed($uid, $default_priority = PRIORITY_HIGH)
        {
@@ -28,9 +44,10 @@ class PushSubscriber
        }
 
        /**
-        * @brief start workers to transmit the feed data
+        * start workers to transmit the feed data
         *
-        * @param string $priority Priority for push workers
+        * @param int $default_priority
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function requeue($default_priority = PRIORITY_HIGH)
        {
@@ -54,7 +71,7 @@ class PushSubscriber
        }
 
        /**
-        * @brief Renew the feed subscription
+        * Renew the feed subscription
         *
         * @param integer $uid          User ID
         * @param string  $nick         Priority for push workers
@@ -62,6 +79,7 @@ class PushSubscriber
         * @param string  $hub_callback Callback address
         * @param string  $hub_topic    Feed topic
         * @param string  $hub_secret   Subscription secret
+        * @throws \Exception
         */
        public static function renew($uid, $nick, $subscribe, $hub_callback, $hub_topic, $hub_secret)
        {
@@ -97,9 +115,10 @@ class PushSubscriber
        }
 
        /**
-        * @brief Delay the push subscriber
+        * Delay the push subscriber
         *
         * @param integer $id Subscriber ID
+        * @throws \Exception
         */
        public static function delay($id)
        {
@@ -134,10 +153,11 @@ class PushSubscriber
        }
 
        /**
-        * @brief Reset the push subscriber
+        * Reset the push subscriber
         *
         * @param integer $id          Subscriber ID
-        * @param date    $last_update Date of last transmitted item
+        * @param string  $last_update Date of last transmitted item
+        * @throws \Exception
         */
        public static function reset($id, $last_update)
        {