* merge all phpdoc with only one-line into single-line style

* narrow the template of `EloquentBuilder<>` from `Model` to `Post` @ `App\Http\PostsQuery\IndexQuery->query()` @ be
n0099 · Sep 16, 2024 · b2efba2 · b2efba2
1 parent 2e6af85
commit b2efba2
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 78 deletions.
diff --git a/be/app/Eloquent/Model/Post/Content/PostContent.php b/be/app/Eloquent/Model/Post/Content/PostContent.php
@@ -7,9 +7,7 @@
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use TbClient\Wrapper\PostContentWrapper;
 
-/**
- * @property string $protoBufBytes
- */
+/** @property string $protoBufBytes */
 abstract class PostContent extends Post
 {
     protected function protoBufBytes(): Attribute

diff --git a/be/app/Eloquent/Model/Post/Reply.php b/be/app/Eloquent/Model/Post/Reply.php
@@ -47,17 +47,13 @@ protected function geolocation(): Attribute
         return ModelAttributeMaker::makeProtoBufAttribute(Lbs::class);
     }
 
-    /**
-     * @psalm-return BelongsTo<Thread>
-     */
+    /** @psalm-return BelongsTo<Thread> */
     public function thread(): BelongsTo
     {
         return $this->belongsTo(Thread::class, 'tid', 'tid');
     }
 
-    /**
-     * @psalm-return HasMany<SubReply>
-     */
+    /** @psalm-return HasMany<SubReply> */
     public function subReplies(): HasMany
     {
         return $this->hasMany(SubReply::class, 'pid', 'pid');

diff --git a/be/app/Eloquent/Model/Post/SubReply.php b/be/app/Eloquent/Model/Post/SubReply.php
@@ -32,17 +32,13 @@ public function __construct(array $attributes = [])
         ];
     }
 
-    /**
-     * @psalm-return BelongsTo<Thread>
-     */
+    /** @psalm-return BelongsTo<Thread> */
     public function thread(): BelongsTo
     {
         return $this->belongsTo(Thread::class, 'tid', 'tid');
     }
 
-    /**
-     * @psalm-return BelongsTo<Reply>
-     */
+    /** @psalm-return BelongsTo<Reply> */
     public function reply(): BelongsTo
     {
         return $this->belongsTo(Reply::class, 'pid', 'pid');

diff --git a/be/app/Eloquent/Model/Post/Thread.php b/be/app/Eloquent/Model/Post/Thread.php
@@ -62,9 +62,7 @@ protected function geolocation(): Attribute
         return ModelAttributeMaker::makeProtoBufAttribute(Lbs::class);
     }
 
-    /**
-     * @psalm-return HasMany<Reply>
-     */
+    /** @psalm-return HasMany<Reply> */
     public function replies(): HasMany
     {
         return $this->hasMany(Reply::class, 'tid', 'tid');

diff --git a/be/app/Eloquent/ModelAttributeMaker.php b/be/app/Eloquent/ModelAttributeMaker.php
@@ -14,9 +14,7 @@ class ModelAttributeMaker
      */
     public static function makeProtoBufAttribute(string $protoBufClass): Attribute
     {
-        return Attribute::make(/**
-             * @param resource|null $value
-             */
+        return Attribute::make(/** @param resource|null $value */
             get: static function ($value) use ($protoBufClass): ?\stdClass {
                 if ($value === null) {
                     return null;
@@ -29,9 +27,7 @@ public static function makeProtoBufAttribute(string $protoBufClass): Attribute
         )->shouldCache();
     }
 
-    /**
-     * @return Attribute<string, void>
-     */
+    /** @return Attribute<string, void> */
     public static function makeResourceAttribute(): Attribute
     {
         return Attribute::make(/**

diff --git a/be/app/Eloquent/ModelHasPublicField.php b/be/app/Eloquent/ModelHasPublicField.php
@@ -4,19 +4,13 @@
 
 use Illuminate\Database\Eloquent\Builder;
 
-/**
- * @template TModel
- */
+/** @template TModel */
 trait ModelHasPublicField
 {
-    /**
-     * @var list<string>
-     */
+    /** @var list<string> */
     protected array $publicFields = [];
 
-    /**
-     * @var list<string>
-     */
+    /** @var list<string> */
     protected array $hiddenFields = [];
 
     /**

diff --git a/be/app/Eloquent/NullableBooleanAttributeCast.php b/be/app/Eloquent/NullableBooleanAttributeCast.php
@@ -11,9 +11,7 @@ public function get($model, string $key, $value, array $attributes): bool
         return $value === 1;
     }
 
-    /**
-     * @psalm-return 0|1
-     */
+    /** @psalm-return 0|1 */
     public function set($model, string $key, $value, array $attributes): int
     {
         \is_bool($value) || $value = (bool) $value;

diff --git a/be/app/Http/Middleware/DumpJsonResponse.php b/be/app/Http/Middleware/DumpJsonResponse.php
@@ -7,9 +7,7 @@
 
 class DumpJsonResponse
 {
-    /**
-     * @param \Closure(Request): (\Symfony\Component\HttpFoundation\Response) $next
-     */
+    /** @param \Closure(Request): (\Symfony\Component\HttpFoundation\Response) $next */
     public function handle(Request $request, \Closure $next): mixed
     {
         $response = $next($request);

diff --git a/be/app/Http/Middleware/ReCAPTCHACheck.php b/be/app/Http/Middleware/ReCAPTCHACheck.php
@@ -9,9 +9,7 @@
 
 class ReCAPTCHACheck
 {
-    /**
-     * @param \Closure(Request): (\Symfony\Component\HttpFoundation\Response) $next
-     */
+    /** @param \Closure(Request): (\Symfony\Component\HttpFoundation\Response) $next */
     public function handle(Request $request, \Closure $next): mixed
     {
         /** @var string $secret */

diff --git a/be/app/Http/PostsQuery/BaseQuery.php b/be/app/Http/PostsQuery/BaseQuery.php
@@ -112,9 +112,7 @@ protected function setResult(
         $this->debugbar->stopMeasure('setResult');
     }
 
-    /**
-     * @param Collection<string, Post> $postsKeyByTypePluralName
-     */
+    /** @param Collection<string, Post> $postsKeyByTypePluralName */
     public function encodeNextCursor(Collection $postsKeyByTypePluralName): string
     {
         $encodedCursorsKeyByPostType = $postsKeyByTypePluralName
@@ -169,9 +167,7 @@ public function encodeNextCursor(Collection $postsKeyByTypePluralName): string
             ->join(',');
     }
 
-    /**
-     * @psalm-return Collection<'reply'|'subReply'|'thread', Cursor>
-     */
+    /** @psalm-return Collection<'reply'|'subReply'|'thread', Cursor> */
     private function decodeCursor(string $encodedCursors): Collection
     {
         return collect(Helper::POST_TYPES)
@@ -398,9 +394,7 @@ public function reOrderNestedPosts(Collection $nestedPosts, bool $shouldRemoveSo
         $sortBySortingKey = fn(Collection $posts): Collection => $posts
             ->sortBy(fn(Collection $i) => $i['sortingKey'], descending: $this->orderByDesc);
         $removeSortingKey = $shouldRemoveSortingKey
-            ? /**
-                 * @psalm-return Collection<array-key, Collection>
-                 */
+            ? /** @psalm-return Collection<array-key, Collection> */
                 static fn(Collection $posts): Collection => $posts
                     ->map(fn(Collection $i) => $i->except('sortingKey'))
             : static fn($i) => $i;

diff --git a/be/app/Http/PostsQuery/IndexQuery.php b/be/app/Http/PostsQuery/IndexQuery.php
@@ -13,9 +13,7 @@
 
 class IndexQuery extends BaseQuery
 {
-    /**
-     * @SuppressWarnings(PHPMD.ElseExpression)
-     */
+    /** @SuppressWarnings(PHPMD.ElseExpression) */
     public function query(QueryParams $params, ?string $cursor): self
     {
         /** @var array<string, mixed> $flatParams key by param name */
@@ -48,9 +46,7 @@ public function query(QueryParams $params, ?string $cursor): self
                     PostFactory::getPostModelsByFid($fid)[Helper::POST_ID_TO_TYPE[$postIDName]]
                         ->selectRaw("{$fid} AS fid, COUNT(*) AS count")
                         ->where($postIDName, $postID))
-                ->reduce(/**
-                 * @return BuilderContract|EloquentBuilder<\Illuminate\Database\Eloquent\Model>|QueryBuilder
-                 */
+                ->reduce(/** @return BuilderContract|EloquentBuilder<Post>|QueryBuilder */
                     static fn(
                         ?BuilderContract $acc,
                         EloquentBuilder|QueryBuilder $cur,

diff --git a/be/app/Http/PostsQuery/ParamsValidator.php b/be/app/Http/PostsQuery/ParamsValidator.php
@@ -14,9 +14,7 @@ class ParamsValidator
 
     protected array $currentPostTypes;
 
-    /**
-     * @param array[] $params
-     */
+    /** @param array[] $params */
     public function __construct(array $params)
     {
         self::validateParamsValue($params);

diff --git a/be/app/Http/PostsQuery/QueryParams.php b/be/app/Http/PostsQuery/QueryParams.php
@@ -6,22 +6,16 @@
 
 class QueryParams
 {
-    /**
-     * @var Param[]
-     */
+    /** @var Param[] */
     protected array $params;
 
-    /**
-     * @param array[] $params
-     */
+    /** @param array[] $params */
     public function __construct(array $params)
     {
         $this->params = array_map(static fn($p) => new Param($p), $params);
     }
 
-    /**
-     * @psalm-return int<0, max>
-     */
+    /** @psalm-return int<0, max> */
     public function count(): int
     {
         return count($this->params);
@@ -62,17 +56,13 @@ public function setUniqueParamValue(string $name, mixed $value): void
         $this->params[$this->getParamsIndexByName($name)[0]]->value = $value;
     }
 
-    /**
-     * @return int[]
-     */
+    /** @return int[] */
     protected function getParamsIndexByName(string $name): array
     {
         return array_keys(array_filter($this->params, static fn($p) => $p->name === $name));
     }
 
-    /**
-     * @SuppressWarnings(PHPMD.ElseExpression)
-     */
+    /** @SuppressWarnings(PHPMD.ElseExpression) */
     public function addDefaultValueOnUniqueParams(): void
     {
         $uniqueParamsDefaultValue = [

diff --git a/be/app/Http/PostsQuery/SearchQuery.php b/be/app/Http/PostsQuery/SearchQuery.php
@@ -134,9 +134,7 @@ static function (BuilderContract $newQueryWhenCacheMiss) use (&$outCachedUserQue
         };
     }
 
-    /**
-     * @psalm-param array<string, mixed> $subParams
-     */
+    /** @psalm-param array<string, mixed> $subParams */
     private static function applyTextMatchParamOnQuery(
         BuilderContract $query,
         string $field,