添加注释

swow-cloud · Jan 22, 2024 · 5317055 · 5317055
1 parent e7307a8
commit 5317055
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 0 deletions.
diff --git a/cloud-admin/Log/LoggerFactory.php b/cloud-admin/Log/LoggerFactory.php
@@ -20,6 +20,7 @@
 final class LoggerFactory
 {
     /**
+     * @phpstan-param ContainerInterface $container
      * @phpstan-return LoggerInterface|void
      * @return LoggerInterface|void
      * @throws ContainerExceptionInterface

diff --git a/cloud-admin/Log/SwowSocketHandler.php b/cloud-admin/Log/SwowSocketHandler.php
@@ -27,12 +27,26 @@
 
 final class SwowSocketHandler extends AbstractProcessingHandler
 {
+    /**
+     * @phpstan-var  Socket Socket
+     */
     protected Socket $output;
 
+    /**
+     * @phpstan-var  Buffer Buffer
+     */
     protected Buffer $buffer;
 
+    /**
+     * @phpstan-var Style $style
+     */
     protected Style $style;
 
+    /**
+     * @phpstan-param int|Level|string $level
+     * @phpstan-param bool $bubble
+     * @phpstan-param bool $useLocking
+     */
     public function __construct(
         int|Level|string $level = Level::Debug,
         bool $bubble = true,
@@ -55,6 +69,7 @@ protected function write(LogRecord $record): void
     }
 
     /**
+     * @phpstan-param LogRecord $record
      * @phpstan-return Color
      */
     protected function getColorFromLevel(string $level = LogLevel::DEBUG): Color

diff --git a/cloud-admin/Middleware/ProfilerMiddleware.php b/cloud-admin/Middleware/ProfilerMiddleware.php
@@ -37,8 +37,17 @@
 
 final class ProfilerMiddleware implements MiddlewareInterface
 {
+    /**
+     * @phpstan-param ContainerInterface $container
+     * @phpstan-param ConfigInterface $config
+     */
     public function __construct(protected readonly ContainerInterface $container, protected readonly ConfigInterface $config) {}
 
+    /**
+     * @phpstan-param  ServerRequestInterface $request
+     * @phpstan-param  RequestHandlerInterface $handler
+     * @phpstan-return  ResponseInterface
+     */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         $time = microtime();
@@ -60,6 +69,10 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     /**
      * @throws ContainerExceptionInterface
      * @throws NotFoundExceptionInterface
+     * @phpstan-param  string $startTime
+     * @phpstan-param  ServerRequestInterface|null $request
+     * @phpstan-param  ResponseInterface|null $response
+     * @phpstan-return  bool
      */
     private function logAndSave(string $startTime, ?ServerRequestInterface $request, ?ResponseInterface $response): bool
     {

diff --git a/cloud-admin/Model/Model.php b/cloud-admin/Model/Model.php
@@ -31,6 +31,12 @@ class Model extends BaseModel
 
     protected ?string $dateFormat = 'Y-m-d H:i:s';
 
+    /**
+     * @phpstan-param  array $condition
+     * @phpstan-param  array $field
+     * @phpstan-param  bool $forUpdate
+     * @phpstan-return  Builder|HyperfModel|null
+     */
     public static function findOne(array $condition, array $field = ['*'], bool $forUpdate = false): null|Builder|HyperfModel
     {
         $query = self::buildByCondition($condition);
@@ -40,11 +46,20 @@ public static function findOne(array $condition, array $field = ['*'], bool $for
         return $query->first($field);
     }
 
+    /**
+     * @phpstan-param  int $id
+     * @phpstan-param  array $field
+     * @phpstan-return  Builder|HyperfModel|null
+     */
     public static function one(int $id, array $field = ['*']): null|Builder|HyperfModel
     {
         return self::findOne(['id' => $id], $field);
     }
 
+    /**
+     * @phpstan-param  array $condition
+     * @phpstan-return  Builder
+     */
     public static function buildByCondition(array $condition): Builder
     {
         $query = self::query();
@@ -62,18 +77,33 @@ public static function buildByCondition(array $condition): Builder
         return $query;
     }
 
+    /**
+     * @phpstan-param  array $condition
+     * @phpstan-param  array $data
+     * @phpstan-return  int
+     */
     public static function updateCondition(array $condition, array $data): int
     {
         $query = self::buildByCondition($condition);
         return $query->update($data);
     }
 
+    /**
+     * @phpstan-param  array $condition
+     * @phpstan-return  int
+     */
     public static function countCondition(array $condition): int
     {
         $query = self::buildByCondition($condition);
         return $query->count();
     }
 
+    /**
+     * @phpstan-param  Builder $model
+     * @phpstan-param  string $field
+     * @phpstan-param  array $createTime
+     * @phpstan-return  void
+     */
     public static function betweenTime(Builder $model, string $field, array $createTime): void
     {
         $model->where(function (Builder $builder) use ($field, $createTime) {

diff --git a/cloud-admin/RateLimit/TokenBucket.php b/cloud-admin/RateLimit/TokenBucket.php
@@ -31,6 +31,10 @@ final class TokenBucket
 
     private readonly Channel $channel;
 
+    /**
+     * @phpstan-param  int $capacity
+     * @phpstan-param  int $tokenRate
+     */
     public function __construct(private readonly int $capacity, private int $tokenRate)
     {
         $this->tokens = $capacity;
@@ -56,6 +60,9 @@ public function acquireToken(): void
         }
     }
 
+    /**
+     * @phpstan-return  void
+     */
     private function runTicker(): void
     {
         if (! $this->tickerRunning) {
@@ -72,11 +79,18 @@ private function runTicker(): void
         }
     }
 
+    /**
+     * @phpstan-param  int $tokenRate
+     * @phpstan-return  void
+     */
     private function setTokenRate(int $tokenRate): void
     {
         $this->tokenRate = $tokenRate;
     }
 
+    /**
+     * @phpstan-return  void
+     */
     private function addTokens(): void
     {
         $now = microtime(true);