Skip to content

Commit 21b0a6f

Browse files
committed
stubs document changed
1 parent 855a81b commit 21b0a6f

File tree

4 files changed

+25
-15
lines changed

4 files changed

+25
-15
lines changed

src/LaravelApiGenerator.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ public function directoryCreate()
3333

3434
public function generateController()
3535
{
36+
$this->result = false;
3637
if (! file_exists(base_path('app/Http/Controllers/Api/'.$this->model.'Controller.php'))) {
3738
$template = self::getStubContents('controller.stub');
3839
$template = str_replace('{{modelName}}', $this->model, $template);
@@ -47,6 +48,7 @@ public function generateController()
4748

4849
public function generateResource()
4950
{
51+
$this->result = false;
5052
if (! file_exists(base_path('app/Http/Resources/'.$this->model.'Resource.php'))) {
5153
$template = self::getStubContents('resource.stub');
5254
$template = str_replace('{{modelName}}', $this->model, $template);
@@ -59,6 +61,7 @@ public function generateResource()
5961

6062
public function generateCollection()
6163
{
64+
$this->result = false;
6265
if (! file_exists(base_path('app/Http/Resources/'.$this->model.'Collection.php'))) {
6366
$template = self::getStubContents('collection.stub');
6467
$template = str_replace('{{modelName}}', $this->model, $template);
@@ -71,6 +74,7 @@ public function generateCollection()
7174

7275
public function generateRoute()
7376
{
77+
$this->result = false;
7478
$template = "Route::apiResource('{{modelNameLower}}', 'Api\{{modelName}}Controller');"."\n";
7579
$route = str_replace('{{modelNameLower}}', Str::camel(Str::plural($this->model)), $template);
7680
$route = str_replace('{{modelName}}', $this->model, $route);

src/resources/stubs/collection.stub

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace App\Http\Resources;
44

5+
use Illuminate\Http\Request;
56
use Illuminate\Http\Resources\Json\ResourceCollection;
67

78
class {{modelName}}Collection extends ResourceCollection
@@ -16,7 +17,7 @@ class {{modelName}}Collection extends ResourceCollection
1617
/**
1718
* Transform the resource collection into an array.
1819
*
19-
* @param \Illuminate\Http\Request $request
20+
* @param Request $request
2021
* @return array
2122
*/
2223
public function toArray($request)
@@ -27,7 +28,7 @@ class {{modelName}}Collection extends ResourceCollection
2728
/**
2829
* Get additional data that should be returned with the resource array.
2930
*
30-
* @param \Illuminate\Http\Request $request
31+
* @param Request $request
3132
* @return array
3233
*/
3334
public function with($request)

src/resources/stubs/controller.stub

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
namespace App\Http\Controllers\Api;
44

55
use App\Http\Controllers\Controller;
6+
use Exception;
7+
use Illuminate\Http\JsonResponse;
68
use Illuminate\Http\Request;
79
use App\{{modelName}};
810
use App\Http\Resources\{{modelName}}Resource;
@@ -13,18 +15,19 @@ class {{modelName}}Controller extends Controller
1315
/**
1416
* Display a listing of the resource.
1517
*
16-
* @return \Illuminate\Http\Response
18+
* @param Request $request
19+
* @return {{modelName}}Collection
1720
*/
18-
public function index()
21+
public function index(Request $request)
1922
{
2023
return new {{modelName}}Collection({{modelName}}::all());
2124
}
2225

2326
/**
2427
* Store a newly created resource in storage.
2528
*
26-
* @param \Illuminate\Http\Request $request
27-
* @return \Illuminate\Http\Response
29+
* @param Request $request
30+
* @return {{modelName}}Resource
2831
*/
2932
public function store(Request $request)
3033
{
@@ -36,8 +39,8 @@ class {{modelName}}Controller extends Controller
3639
/**
3740
* Display the specified resource.
3841
*
39-
* @param int $id
40-
* @return \Illuminate\Http\Response
42+
* @param {{modelName}} ${{modelNameCamel}}
43+
* @return {{modelName}}Resource
4144
*/
4245
public function show({{modelName}} ${{modelNameCamel}})
4346
{
@@ -47,9 +50,9 @@ class {{modelName}}Controller extends Controller
4750
/**
4851
* Update the specified resource in storage.
4952
*
50-
* @param \Illuminate\Http\Request $request
51-
* @param int $id
52-
* @return \Illuminate\Http\Response
53+
* @param Request $request
54+
* @param {{modelName}} ${{modelNameCamel}}
55+
* @return {{modelName}}Resource
5356
*/
5457
public function update(Request $request, {{modelName}} ${{modelNameCamel}})
5558
{
@@ -61,8 +64,9 @@ class {{modelName}}Controller extends Controller
6164
/**
6265
* Remove the specified resource from storage.
6366
*
64-
* @param int $id
65-
* @return \Illuminate\Http\Response
67+
* @param {{modelName}} ${{modelNameCamel}}
68+
* @return JsonResponse
69+
* @throws Exception
6670
*/
6771
public function destroy({{modelName}} ${{modelNameCamel}})
6872
{

src/resources/stubs/resource.stub

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace App\Http\Resources;
44

5+
use Illuminate\Http\Request;
56
use Illuminate\Http\Resources\Json\JsonResource;
67

78
class {{modelName}}Resource extends JsonResource
@@ -17,7 +18,7 @@ class {{modelName}}Resource extends JsonResource
1718
/**
1819
* Transform the resource into an array.
1920
*
20-
* @param \Illuminate\Http\Request $request
21+
* @param Request $request
2122
* @return array
2223
*/
2324
public function toArray($request)
@@ -28,7 +29,7 @@ class {{modelName}}Resource extends JsonResource
2829
/**
2930
* Get additional data that should be returned with the resource array.
3031
*
31-
* @param \Illuminate\Http\Request $request
32+
* @param Request $request
3233
* @return array
3334
*/
3435
public function with($request)

0 commit comments

Comments
 (0)