heavy chore

app/Http/Controllers/CommentController.php

@@ -16,7 +16,6 @@ class CommentController extends Controller
 {
     public function addComment(Request $request)
     {
-        /** @phpstan-ignore-next-line  */
         if ($user = JWTAuth::parseToken()->user()) {
             $payload = $request->only([
                 'resource-type', 'resource-id', 'comment'
@@ -49,7 +48,6 @@ public function addComment(Request $request)
 
     public function destroyComment(Request $request)
     {
-        /** @phpstan-ignore-next-line  */
         if ($user = JWTAuth::parseToken()->user()) {
             $payload = $request->only(['comment-id']);
             $comment = Comment::findOrFail($request->only(['comment-id']))->first();

app/Http/Controllers/RecipeController.php

@@ -67,7 +67,6 @@ public function addClap(Request $request): JsonResponse
         );
 
         return ($recipe = $this->service->addClap($request->get('recipe_id'))) ?
-            /** @phpstan-ignore-next-line  */
             $this->successResponse(['updated' => true, 'claps' => $recipe->claps]) :
             $this->errorResponse(['error' => 'There was an error processing this request. Please try again.']);
     }

app/Http/Controllers/UserController.php

@@ -80,7 +80,6 @@ public function update($username, UserUpdateRequest $request)
 
     public function followUser(Request $request)
     {
-        /** @phpstan-ignore-next-line */
         if ($user = JWTAuth::parseToken()->user()) {
             if ($toFollow = $request->get('toFollow')) {
                 $userToFollow = $this->service->findWhere($toFollow)->first();
@@ -146,7 +145,6 @@ private function getWhoToFollowData(User $user)
 
     public function addFeedback(Request $request)
     {
-        /** @phpstan-ignore-next-line */
         if ($user = JWTAuth::parseToken()->user()) {
             $hasRespondedAlready = UserFeedback::where(['user_id' => $user->getKey(), 'type' => 'feedback']);
 
@@ -172,7 +170,6 @@ public function addFeedback(Request $request)
 
     public function listVideos(HttpRequestRunner $requestRunner)
     {
-        /** @phpstan-ignore-next-line */
         if ($user = JWTAuth::parseToken()->user()) {
             $tikTokUser = $user->getTikTokUser();
             $errors = [

app/Http/Middleware/JWTAuthGuard.php

@@ -17,10 +17,8 @@ class JWTAuthGuard
     public function handle(Request $request, Closure $next)
     {
         try {
-            /** @phpstan-ignore-next-line  */
             if (JWTAuth::parseToken()->authenticate()) {
 
-                /** @phpstan-ignore-next-line  */
                 $request->merge(["user_id" => JWTAuth::parseToken()->user()->getKey()]);
 
                 return $next($request);

app/Interfaces/serviceInterface.php

@@ -8,13 +8,33 @@
 
 interface serviceInterface
 {
+    /**
+     * @return mixed
+     */
     public function index();
 
-    public function show($option);
+    /**
+     * @param string|int $option
+     * @return mixed
+     */
+    public function show(string|int $option);
 
+    /**
+     * @param Request $request
+     * @return mixed
+     */
     public function store(Request $request);
 
+    /**
+     * @param Request $request
+     * @param string $option
+     * @return mixed
+     */
     public function update(Request $request, string $option);
 
-    public function findWhere($q);
+    /**
+     * @param string|int $q
+     * @return mixed
+     */
+    public function findWhere(string|int $q);
 }

app/Services/CookbookService.php

@@ -71,15 +71,12 @@ public function store(Request $request): bool
             }
         }
 
-        /** @phpstan-ignore-next-line  */
         $cookbook->slug = DbHelper::generateUniqueSlug($request->name, 'cookbooks', 'slug');
 
         if ($cookbook->save()) {
-            /** @phpstan-ignore-next-line  */
             $cookbook->users()->attach($cookbook->user_id);
 
             foreach ($categories as $category) {
-                /** @phpstan-ignore-next-line  */
                 $cookbook->categories()->attach($category);
             }
 

app/Services/SearchService.php

@@ -66,7 +66,6 @@ public function getAllCookbooksByTag(array $tags): Collection
                 }
             }
 
-            /** @phpstan-ignore-next-line */
             $result->metaData = [
                 'contains' => $contains,
                 'missing' => $missing
@@ -166,7 +165,6 @@ public function getAllCookbooksByCategoryName($category_names)
                     }
                 }
 
-                /** @phpstan-ignore-next-line */
                 $result->metaData = [
                     'contains' => $contains,
                     'missing' => $missing
@@ -244,7 +242,6 @@ public function getAllRecipesByIngredientName($ingredients)
      */
     public function getAllCookbooksByMe($cookbookName = "")
     {
-        /** @phpstan-ignore-next-line */
         if ($user = JWTAuth::parseToken()->user()) {
             $me = $user->getKey();
 
@@ -269,7 +266,6 @@ public function getAllCookbooksByMe($cookbookName = "")
      */
     public function getAllRecipesByMe($recipeName = "")
     {
-        /** @phpstan-ignore-next-line */
         if ($user = JWTAuth::parseToken()->user()) {
             $me = $user->getKey();
 
@@ -285,7 +281,6 @@ public function getAllRecipesByMe($recipeName = "")
 
     public function getFollowing()
     {
-        /** @phpstan-ignore-next-line */
         if ($me = JWTAuth::parseToken()->user()) {
             $recipes = [];
             $following = Following::where(['follower_id' => $me->getKey()])->pluck('following')->toArray();

app/Services/TikTok/AccessToken.php

@@ -7,9 +7,7 @@
 
 class AccessToken extends Request
 {
-//    private $endpoint = 'access-token';
-
-    public function handle()
+    public function handle(): void
     {
         $firstRequest = $this->httpClient->post('https://open.tiktokapis.com/v2/oauth/token/', [
             'headers' => [
@@ -27,7 +25,9 @@ public function handle()
         $decoded = json_decode($firstRequest->getBody()->getContents(), true);
 
         if ($decoded["error"]) {
-            throw new InvalidArgumentException(json_encode($decoded));
+            if ($exception = json_encode($decoded)) {
+                throw new InvalidArgumentException($exception);
+            }
         }
 
         Config::set('tiktok', ['access_token' => $decoded['access_token']]);

app/Services/TikTok/HttpRequestRunner.php

@@ -2,11 +2,19 @@
 
 namespace App\Services\TikTok;
 
+use Exception;
 use Illuminate\Support\Facades\Config;
 
 class HttpRequestRunner
 {
-    public function __invoke(array $config, bool $async = false, Request...$requests)
+    /**
+     * @param array<string> $config
+     * @param bool $async
+     * @param Request ...$requests
+     * @return $this
+     * @throws Exception
+     */
+    public function __invoke(array $config, bool $async = false, Request...$requests): self
     {
         $this->validateConfig($config);
 
@@ -22,23 +30,28 @@ public function __invoke(array $config, bool $async = false, Request...$requests
     }
 
     //todo
-    public function handleSync() {}
+    public function handleSync(): void {}
 
-    public function getContents()
+    public function getContents(): array
     {
         return Config::get('tiktok');
     }
 
-    private function setCode(string $code)
+    private function setCode(string $code): void
     {
         Config::set('tiktok', ['code' => $code]);
     }
 
-    private function validateConfig(array $options = [])
+    /**
+     * @param array<string> $options
+     * @return void
+     * @throws Exception
+     */
+    private function validateConfig(array $options = []): void
     {
         foreach ($options as $i => $j) {
             if (is_numeric($i)) {
-                throw new \Exception('Invalid type. Must be a key/value pair.');
+                throw new Exception('Invalid type. Must be a key/value pair.');
             }
         }
 

app/Services/TikTok/Request.php

@@ -6,17 +6,17 @@
 
 abstract class Request
 {
-    protected $httpClient;
-    private $endpoint = '';
+    protected Client $httpClient;
+    private string $endpoint = '';
 
     public function __construct()
     {
         $this->httpClient = new Client();
     }
 
-    public abstract function handle();
+    public abstract function handle(): void;
 
-    public function getEndpoint()
+    public function getEndpoint(): string
     {
         return $this->endpoint;
     }

app/Services/TikTok/UserInfo.php

@@ -4,6 +4,5 @@
 
 class UserInfo extends Request
 {
-//    private $endpoint = 'user-info';
-    public function handle() {}
+    public function handle(): void {}
 }

app/Services/TikTok/Videos.php

@@ -7,9 +7,7 @@
 
 class Videos extends Request
 {
-//    private $endpoint = 'video-links';
-
-    public function handle()
+    public function handle(): void
     {
         $nextRequest = $this->httpClient->request('POST',
             'https://open.tiktokapis.com/v2/video/list/',
@@ -40,7 +38,9 @@ public function handle()
 
         if ($decoded["error"]) {
             $stage = '/video/list/';
-            throw new InvalidArgumentException(json_encode($decoded));
+            if ($exception = json_encode($decoded)) {
+                throw new InvalidArgumentException($exception);
+            }
         }
     }
 }

app/Services/UserContactDetailsService.php

@@ -4,7 +4,6 @@
 
 namespace App\Services;
 
-use App\Models\Cookbook;
 use App\Models\User;
 use App\Models\UserContactDetail;
 use Illuminate\Http\Request;
@@ -18,14 +17,13 @@ public function __construct()
         $this->serviceModel = new UserContactDetail();
     }
 
-    protected $contact_detail;
-
     /**
      * Creates new user contact detail
      *
      * @param  Request  $request
+     * @return void
      */
-    public function store(Request $request)
+    public function store(Request $request): void
     {
         $detail = new UserContactDetail($request->only([
             'user_id',

app/Services/UserService.php

@@ -8,8 +8,11 @@
 use App\Models\User;
 use App\Models\UserContactDetail;
 use App\Utils\DbHelper;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Hashing\BcryptHasher;
 use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
 
 /**
  * Class UserService
@@ -24,15 +27,15 @@ public function __construct()
     /**
      * Get all users from the database
      */
-    public function index()
+    public function index(): LengthAwarePaginator
     {
         return User::paginate(15);
     }
 
     /**
      * Create a new user resource
      */
-    public function store(Request $request)
+    public function store(Request $request): bool
     {
         $user = new User([
             'name' => $request->name,
@@ -61,7 +64,7 @@ public function store(Request $request)
         return false;
     }
 
-    public function show($q)
+    public function show(string|int $q): Collection
     {
         return $this->findWhere($q)->get()->append(['tiktok_videos']);
     }
@@ -103,10 +106,10 @@ public function update(Request $request, string $option)
     }
 
     /**
-     * @param $q
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @param string|int $q
+     * @return Builder
      */
-    public function findWhere($q)
+    public function findWhere(string|int $q): Builder
     {
         return User::with(['cookbooks', 'recipes'])
             ->where('id', '=', $q)

app/Traits/EncryptsPayload.php

@@ -11,7 +11,7 @@ trait EncryptsPayload
     /**
      * Encrypts the given payload using Crypt
      *
-     * @param  array  $payload
+     * @param array<string> $payload
      * @return string
      */
     public function encryptPayload(array $payload): string

app/Utils/UriHelper.php

@@ -6,6 +6,9 @@
 
 class UriHelper
 {
+    /**
+     * @param array<string> $parameters
+     */
     public static function buildHttpQuery(string $redirectToPage, array $parameters): string
     {
         $redirectToPage = $redirectToPage . '.beta-version-1-staging';

composer.json

@@ -44,7 +44,8 @@
         "ext-json": "*",
         "fakerphp/faker": "1.19.0",
         "laravel/sail": "^1.15",
-        "nunomaduro/larastan": "^2.0"
+        "nunomaduro/larastan": "^2.6",
+        "phpstan/phpstan": "^1.10"
     },
     "autoload": {
         "psr-4": {