add php docstrings for methods

This commit is contained in:
Rev 2021-10-10 13:10:18 +09:00
parent 0fdba8c054
commit 826bc13956

View File

@ -3,6 +3,7 @@
namespace App\Http\Controllers; namespace App\Http\Controllers;
use App\Data\ItemsCollection; use App\Data\ItemsCollection;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
class ItemController extends Controller class ItemController extends Controller
@ -17,14 +18,22 @@ class ItemController extends Controller
$this->itemsCollection = $itemsCollection; $this->itemsCollection = $itemsCollection;
} }
public function search(Request $request) /**
* @param Request $request
* @return JsonResponse
*/
public function search(Request $request): JsonResponse
{ {
return response()->json([ return response()->json([
'item' => $this->itemsCollection->findItem($request->input('query')), '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([ return response()->json([
'item' => $this->itemsCollection->getItemById($id), 'item' => $this->itemsCollection->getItemById($id),