]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/OpenWebAuthToken.php
Merge pull request #12674 from nupplaphil/bug/config_typesafe
[friendica.git] / src / Model / OpenWebAuthToken.php
index 7c14cd3046c24bcad7bd56d74c3e5f1111aa15f5..e99d40f12f65ccd56af0ee4ec500de37b6df16a1 100644 (file)
@@ -1,8 +1,24 @@
 <?php
-
 /**
- * @file src/Model/OpenWebAuthToken.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @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\Database\DBA;
@@ -16,43 +32,44 @@ class OpenWebAuthToken
        /**
         * Create an entry in the 'openwebauth-token' table.
         *
-        * @param string $type   Verify type.
-        * @param int    $uid    The user ID.
+        * @param string $type Verify type.
+        * @param int    $uid  The user ID.
         * @param string $token
         * @param string $meta
-        *
         * @return boolean
+        * @throws \Exception
         */
-       public static function create($type, $uid, $token, $meta)
+       public static function create(string $type, int $uid, string $token, string $meta)
        {
                $fields = [
-                       "type" => $type,
-                       "uid" => $uid,
-                       "token" => $token,
-                       "meta" => $meta,
-                       "created" => DateTimeFormat::utcNow()
+                       'type'    => $type,
+                       'uid'     => $uid,
+                       'token'   => $token,
+                       'meta'    => $meta,
+                       'created' => DateTimeFormat::utcNow()
                ];
-               return DBA::insert("openwebauth-token", $fields);
+               return DBA::insert('openwebauth-token', $fields);
        }
 
        /**
         * Get the "meta" field of an entry in the openwebauth-token table.
         *
-        * @param string $type   Verify type.
-        * @param int    $uid    The user ID.
+        * @param string $type Verify type.
+        * @param int    $uid  The user ID.
         * @param string $token
         *
         * @return string|boolean The meta enry or false if not found.
+        * @throws \Exception
         */
-       public static function getMeta($type, $uid, $token)
+       public static function getMeta(string $type, int $uid, string $token)
        {
-               $condition = ["type" => $type, "uid" => $uid, "token" => $token];
+               $condition = ['type' => $type, 'uid' => $uid, 'token' => $token];
 
-               $entry = DBA::selectFirst("openwebauth-token", ["id", "meta"], $condition);
+               $entry = DBA::selectFirst('openwebauth-token', ['id', 'meta'], $condition);
                if (DBA::isResult($entry)) {
-                       DBA::delete("openwebauth-token", ["id" => $entry["id"]]);
+                       DBA::delete('openwebauth-token', ['id' => $entry['id']]);
 
-                       return $entry["meta"];
+                       return $entry['meta'];
                }
                return false;
        }
@@ -62,11 +79,13 @@ class OpenWebAuthToken
         *
         * @param string $type     Verify type.
         * @param string $interval SQL compatible time interval
+        * @return void
+        * @throws \Exception
         */
-       public static function purge($type, $interval)
+       public static function purge(string $type, string $interval)
        {
-               $condition = ["`type` = ? AND `created` < ?", $type, DateTimeFormat::utcNow() . " - INTERVAL " . $interval];
-               DBA::delete("openwebauth-token", $condition);
+               $condition = ["`type` = ? AND `created` < ?", $type, DateTimeFormat::utcNow() . ' - INTERVAL ' . $interval];
+               DBA::delete('openwebauth-token', $condition);
        }
 
 }