From fa6b6c1cf532d5d75d7338317bdcc0ef8986fa6f Mon Sep 17 00:00:00 2001
From: Chenx221 <chenx221@yandex.com>
Date: Tue, 26 Mar 2024 14:40:34 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=B9=E6=B3=95=E6=B3=A8?=
 =?UTF-8?q?=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 models/User.php          |  8 ++++++--
 models/ZipForm.php       |  4 ++--
 utils/AdminSword.php     | 11 +++++++++++
 utils/FileSizeHelper.php | 14 +++++++++++++-
 utils/IPLocation.php     | 16 ++++++++++++++++
 5 files changed, 48 insertions(+), 5 deletions(-)

diff --git a/models/User.php b/models/User.php
index 3e8e710..6960449 100644
--- a/models/User.php
+++ b/models/User.php
@@ -188,7 +188,6 @@ class User extends ActiveRecord implements IdentityInterface
 
     /**
      * 用户登录处理
-     *
      * @return bool 返回用户名密码验证状态
      */
     public function login(): bool
@@ -211,7 +210,6 @@ class User extends ActiveRecord implements IdentityInterface
 
     /**
      * 验证密码
-     *
      * @param $password
      * @return bool
      */
@@ -298,6 +296,12 @@ class User extends ActiveRecord implements IdentityInterface
         return true;
     }
 
+    /**
+     * @param $insert
+     * @param $changedAttributes
+     * @return void
+     * @throws \Exception
+     */
     public function afterSave($insert, $changedAttributes): void
     {
         parent::afterSave($insert, $changedAttributes);
diff --git a/models/ZipForm.php b/models/ZipForm.php
index fc4e1a0..10a9587 100644
--- a/models/ZipForm.php
+++ b/models/ZipForm.php
@@ -10,7 +10,7 @@ class ZipForm extends Model
     public $zipFormat;
 
 
-    public function rules()
+    public function rules(): array
     {
         return [
             [['zipFilename', 'zipFormat'], 'required'],
@@ -20,7 +20,7 @@ class ZipForm extends Model
         ];
     }
 
-    public function attributeLabels()
+    public function attributeLabels(): array
     {
         return [
             'zipFilename' => '压缩文件名',
diff --git a/utils/AdminSword.php b/utils/AdminSword.php
index d52415c..fa0fa73 100644
--- a/utils/AdminSword.php
+++ b/utils/AdminSword.php
@@ -4,9 +4,20 @@ namespace app\utils;
 
 use app\models\User;
 use Yii;
+use yii\base\Exception;
 
+/**
+ * 管理员工具
+ */
 class AdminSword
 {
+    /**
+     * 强制用户下线
+     * 通过修改用户的auth_key来实现
+     * @param $id
+     * @return string
+     * @throws Exception
+     */
     public static function forceUserLogout($id):string
     {
         $user = User::findOne($id);
diff --git a/utils/FileSizeHelper.php b/utils/FileSizeHelper.php
index 912a63b..398a99d 100644
--- a/utils/FileSizeHelper.php
+++ b/utils/FileSizeHelper.php
@@ -11,7 +11,7 @@ class FileSizeHelper
 {
     /**
      * 计算指定目录的大小
-     *
+     * 返回大小单位为字节
      * @param string $directory 目录路径
      * @return int 目录的大小（字节）
      */
@@ -33,6 +33,7 @@ class FileSizeHelper
     /**
      * 判断用户home是否有足够的容量存放文件
      * @param int $file_size 文件大小B(可选,如果文件已经添加到网盘时，不需要这个参数)
+     * @param int|null $user_id
      * @return bool
      */
     public static function hasEnoughSpace(int $file_size = 0, int $user_id = null): bool
@@ -57,6 +58,7 @@ class FileSizeHelper
     }
 
     /**
+     * 获取用户home目录的大小
      * @param int|null $user_id
      * @return int
      */
@@ -70,6 +72,7 @@ class FileSizeHelper
     }
 
     /**
+     * 获取用户vault目录的大小
      * @param int|null $user_id
      * @return int
      */
@@ -83,6 +86,7 @@ class FileSizeHelper
     }
 
     /**
+     * 获取用户所有目录的大小
      * @param int|null $user_id
      * @return int
      */
@@ -95,6 +99,8 @@ class FileSizeHelper
     }
 
     /**
+     * 获取用户home目录的大小
+     * 返回格式化后的大小(字符串)
      * @param int|null $user_id
      * @return string
      */
@@ -105,7 +111,10 @@ class FileSizeHelper
         }
         return self::formatBytes(self::getUserAllDirSize($user_id));
     }
+
     /**
+     * 格式化文件大小(单位转换)
+     * 传入Byte
      * @param $bytes
      * @param $precision
      * @return string
@@ -124,6 +133,8 @@ class FileSizeHelper
     }
 
     /**
+     * 格式化文件大小(单位转换)
+     * 传入MB
      * @param $megabytes
      * @param int $precision
      * @return string
@@ -138,6 +149,7 @@ class FileSizeHelper
     }
 
     /**
+     * 获取用户已使用的容量百分比
      * @param $user_id
      * @return string
      */
diff --git a/utils/IPLocation.php b/utils/IPLocation.php
index 3168eb3..685bb54 100644
--- a/utils/IPLocation.php
+++ b/utils/IPLocation.php
@@ -12,6 +12,9 @@ class IPLocation
     private IPinfo $client;
     private bool $is_disabled = true;
 
+    /**
+     * 初始化IPLOCATION实例
+     */
     public function __construct()
     {
         $status = Yii::$app->params['enableIpInfo'];
@@ -21,6 +24,13 @@ class IPLocation
         }
     }
 
+    /**
+     * 获取IP详细信息
+     * 传入ip地址，返回ip详细信息(Details对象)
+     * 报SSL certificate problem错误进来看这里
+     * @param string $ip
+     * @return Details|null
+     */
     public static function getDetails(string $ip): ?Details
     {
         $instance = new self();
@@ -42,6 +52,12 @@ class IPLocation
         }
     }
 
+    /**
+     * 获取IP详细信息
+     * 输出格式化的IP详细信息(字符串)
+     * @param string $ip
+     * @return string
+     */
     public static function getFormatDetails(string $ip): string
     {
         $details = self::getDetails($ip);