添加注释

swow-cloud · Jan 4, 2024 · 6109006 · 6109006
1 parent d6afca8
commit 6109006
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 10 deletions.
diff --git a/cloud-admin/Annotation/EnumMessage.php b/cloud-admin/Annotation/EnumMessage.php
@@ -17,6 +17,9 @@
 #[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
 final class EnumMessage extends AbstractAnnotation
 {
-    /** @noinspection PhpMissingParentConstructorInspection */
+    /**
+     * @param string $message
+     * @phpstan-param string $message
+     */
     public function __construct(public readonly string $message = '') {}
 }
diff --git a/cloud-admin/Annotation/HttpCode.php b/cloud-admin/Annotation/HttpCode.php
@@ -18,6 +18,9 @@
 #[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
 final class HttpCode extends AbstractAnnotation
 {
-    /** @noinspection PhpMissingParentConstructorInspection */
+    /**
+     * @param int $code
+     * @phpstan-param int $code
+     */
     public function __construct(public readonly int $code = Status::OK) {}
 }
diff --git a/cloud-admin/Context/Coroutine.php b/cloud-admin/Context/Coroutine.php
@@ -15,21 +15,33 @@
 use Hyperf\Context\Context;
 use Hyperf\Contract\StdoutLoggerInterface;
 use Hyperf\Engine\Coroutine as Co;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Log\LoggerInterface;
 use Throwable;
 
 final class Coroutine
 {
+    /**
+     * @var LoggerInterface|StdoutLoggerInterface|mixed $logger
+     */
     private readonly LoggerInterface $logger;
 
+    /**
+     * @param ContainerInterface $container
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
     public function __construct(protected ContainerInterface $container)
     {
         $this->logger = $container->get(StdoutLoggerInterface::class);
     }
 
     /**
+     * @phpstan-return int
+     * @phpstan-param callable $callable
      * @return int Returns the coroutine ID of the coroutine just created.
      *             Returns -1 when coroutine create failed.
      */

diff --git a/cloud-admin/Interfaces/LockInterface.php b/cloud-admin/Interfaces/LockInterface.php
@@ -13,7 +13,15 @@
 
 interface LockInterface
 {
-    public function lock();
+    /**
+     * @return mixed
+     * @phpstan-return mixed
+     */
+    public function lock():mixed;
 
-    public function unlock();
+    /**
+     * @return bool
+     * @phpstan-return bool
+     */
+    public function unlock():bool;
 }
diff --git a/cloud-admin/Interfaces/RedisLockInterface.php b/cloud-admin/Interfaces/RedisLockInterface.php
@@ -19,7 +19,7 @@ interface RedisLockInterface
      * get lock，This method will return fasle directly after the lock is failed.
      *
      * @param string $key lock unique identifier
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function tryLock(string $key, int $ttl = 3): bool;
@@ -30,7 +30,7 @@ public function tryLock(string $key, int $ttl = 3): bool;
      * @param string $key lock unique identifier
      *
      * @param int $retries number of retries
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function lock(
@@ -42,26 +42,27 @@ public function lock(
 
     /**
      * release lock.
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function unLock(): bool;
 
     /**
      * get lock life ttl.
+     * @phpstan-return int
      */
     public function lockTtl(): int;
 
     /**
      * Let the lock last for N seconds, the default N is 3.
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function keepAlive(int $ttl = 3): bool;
 
     /**
      * check if the lock is valid.
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function isAlive(): bool;

diff --git a/cloud-admin/Interfaces/WatchDogInterface.php b/cloud-admin/Interfaces/WatchDogInterface.php
@@ -18,7 +18,7 @@ interface WatchDogInterface
     /**
      * watchdog sentinel automatic renewal mechanism
      * Return true if the task completed successfully.
-     *
+     * @phpstan-return bool
      * @throws Throwable
      */
     public function sentinel(RedisLockInterface $lock, int $time = 60): bool;

diff --git a/cloud-admin/Log/LoggerFactory.php b/cloud-admin/Log/LoggerFactory.php
@@ -20,6 +20,7 @@
 final class LoggerFactory
 {
     /**
+     * @phpstan-return LoggerInterface|void
      * @return LoggerInterface|void
      * @throws ContainerExceptionInterface
      * @throws NotFoundExceptionInterface

diff --git a/cloud-admin/Log/SwowSocketHandler.php b/cloud-admin/Log/SwowSocketHandler.php
@@ -44,13 +44,23 @@ public function __construct(
         $this->style = new Style();
     }
 
+    /**
+     * @param LogRecord $record
+     * @return void
+     * @phpstan-param LogRecord $record
+     */
     protected function write(LogRecord $record): void
     {
         $this->buffer->append($this->formatStdoutLogText($record));
         $this->output->send($this->buffer->toString());
         $this->buffer->clear();
     }
 
+    /**
+     * @param string $level
+     * @return Color
+     * @phpstan-return Color
+     */
     protected function getColorFromLevel(string $level = LogLevel::DEBUG): Color
     {
         return match ($level) {
@@ -63,6 +73,12 @@ protected function getColorFromLevel(string $level = LogLevel::DEBUG): Color
         };
     }
 
+    /**
+     * @param LogRecord $record
+     * @return string
+     * @phpstan-param LogRecord $record
+     * @phpstan-return string
+     */
     protected function formatStdoutLogText(LogRecord $record): string
     {
         $message = '';
@@ -99,6 +115,9 @@ protected function formatStdoutLogText(LogRecord $record): string
         'datetime' => 'int',
         'extra' => 'int',
     ])]
+    /**
+     * @phpstan-return array<string, int>
+     */
     protected function toPsrLogRecordColor(): array
     {
         return [