From 826bc139568e0519d48d962187d4081cc42ac123 Mon Sep 17 00:00:00 2001 From: Rev Date: Sun, 10 Oct 2021 13:10:18 +0900 Subject: [PATCH] add php docstrings for methods --- app/Http/Controllers/ItemController.php | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/app/Http/Controllers/ItemController.php b/app/Http/Controllers/ItemController.php index 4a79173..2645956 100644 --- a/app/Http/Controllers/ItemController.php +++ b/app/Http/Controllers/ItemController.php @@ -3,6 +3,7 @@ namespace App\Http\Controllers; use App\Data\ItemsCollection; +use Illuminate\Http\JsonResponse; use Illuminate\Http\Request; class ItemController extends Controller @@ -17,14 +18,22 @@ class ItemController extends Controller $this->itemsCollection = $itemsCollection; } - public function search(Request $request) + /** + * @param Request $request + * @return JsonResponse + */ + public function search(Request $request): JsonResponse { return response()->json([ 'item' => $this->itemsCollection->findItem($request->input('query')), ]); } - public function getItem(string $id) + /** + * @param string $id + * @return JsonResponse + */ + public function getItem(string $id): JsonResponse { return response()->json([ 'item' => $this->itemsCollection->getItemById($id),