Skip to content

Commit 0fd6501

Browse files
committed
clean up response examples
1 parent 1f481e9 commit 0fd6501

12 files changed

+78
-110
lines changed

authentication.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -146,19 +146,21 @@ Alternatively, once a user is authenticated, you may access the authenticated us
146146

147147
namespace App\Http\Controllers;
148148

149+
use Illuminate\Http\RedirectResponse;
149150
use Illuminate\Http\Request;
150-
use Illuminate\Http\Response;
151151

152152
class FlightController extends Controller
153153
{
154154
/**
155155
* Update the flight information for an existing flight.
156156
*/
157-
public function update(Request $request): Response
157+
public function update(Request $request): RedirectResponse
158158
{
159-
// $request->user()
159+
$user = $request->user();
160+
161+
// ...
160162

161-
return response()->noContent();
163+
return redirect('/flights');
162164
}
163165
}
164166

authorization.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -83,24 +83,24 @@ To authorize an action using gates, you should use the `allows` or `denies` meth
8383

8484
use App\Http\Controllers\Controller;
8585
use App\Models\Post;
86+
use Illuminate\Http\RedirectResponse;
8687
use Illuminate\Http\Request;
87-
use Illuminate\Http\Response;
8888
use Illuminate\Support\Facades\Gate;
8989

9090
class PostController extends Controller
9191
{
9292
/**
9393
* Update the given post.
9494
*/
95-
public function update(Request $request, Post $post): Response
95+
public function update(Request $request, Post $post): RedirectResponse
9696
{
9797
if (! Gate::allows('update-post', $post)) {
9898
abort(403);
9999
}
100100

101101
// Update the post...
102102

103-
return response()->noContent();
103+
return redirect('/posts');
104104
}
105105
}
106106

@@ -511,23 +511,23 @@ The `App\Models\User` model that is included with your Laravel application inclu
511511

512512
use App\Http\Controllers\Controller;
513513
use App\Models\Post;
514+
use Illuminate\Http\RedirectResponse;
514515
use Illuminate\Http\Request;
515-
use Illuminate\Http\Response;
516516

517517
class PostController extends Controller
518518
{
519519
/**
520520
* Update the given post.
521521
*/
522-
public function update(Request $request, Post $post): Response
522+
public function update(Request $request, Post $post): RedirectResponse
523523
{
524524
if ($request->user()->cannot('update', $post)) {
525525
abort(403);
526526
}
527527

528528
// Update the post...
529529

530-
return response()->noContent();
530+
return redirect('/posts');
531531
}
532532
}
533533

@@ -544,23 +544,23 @@ Remember, some actions may correspond to policy methods like `create` that do no
544544

545545
use App\Http\Controllers\Controller;
546546
use App\Models\Post;
547+
use Illuminate\Http\RedirectResponse;
547548
use Illuminate\Http\Request;
548-
use Illuminate\Http\Response;
549549

550550
class PostController extends Controller
551551
{
552552
/**
553553
* Create a post.
554554
*/
555-
public function store(Request $request): Response
555+
public function store(Request $request): RedirectResponse
556556
{
557557
if ($request->user()->cannot('create', Post::class)) {
558558
abort(403);
559559
}
560560

561561
// Create the post...
562562

563-
return response()->noContent();
563+
return redirect('/posts');
564564
}
565565
}
566566

@@ -577,8 +577,8 @@ Like the `can` method, this method accepts the name of the action you wish to au
577577

578578
use App\Http\Controllers\Controller;
579579
use App\Models\Post;
580+
use Illuminate\Http\RedirectResponse;
580581
use Illuminate\Http\Request;
581-
use Illuminate\Http\Response;
582582

583583
class PostController extends Controller
584584
{
@@ -587,13 +587,13 @@ Like the `can` method, this method accepts the name of the action you wish to au
587587
*
588588
* @throws \Illuminate\Auth\Access\AuthorizationException
589589
*/
590-
public function update(Request $request, Post $post): Response
590+
public function update(Request $request, Post $post): RedirectResponse
591591
{
592592
$this->authorize('update', $post);
593593

594594
// The current user can update the blog post...
595595

596-
return response()->noContent();
596+
return redirect('/posts');
597597
}
598598
}
599599

@@ -603,21 +603,21 @@ Like the `can` method, this method accepts the name of the action you wish to au
603603
As previously discussed, some policy methods like `create` do not require a model instance. In these situations, you should pass a class name to the `authorize` method. The class name will be used to determine which policy to use when authorizing the action:
604604

605605
use App\Models\Post;
606+
use Illuminate\Http\RedirectResponse;
606607
use Illuminate\Http\Request;
607-
use Illuminate\Http\Response;
608608

609609
/**
610610
* Create a new blog post.
611611
*
612612
* @throws \Illuminate\Auth\Access\AuthorizationException
613613
*/
614-
public function create(Request $request): Response
614+
public function create(Request $request): RedirectResponse
615615
{
616616
$this->authorize('create', Post::class);
617617

618618
// The current user can create blog posts...
619619

620-
return response()->noContent();
620+
return redirect('/posts');
621621
}
622622

623623
<a name="authorizing-resource-controllers"></a>
@@ -782,11 +782,11 @@ When attempting to determine if the authenticated user can update a given post,
782782
*
783783
* @throws \Illuminate\Auth\Access\AuthorizationException
784784
*/
785-
public function update(Request $request, Post $post): Response
785+
public function update(Request $request, Post $post): RedirectResponse
786786
{
787787
$this->authorize('update', [$post, $request->category]);
788788

789789
// The current user can update the blog post...
790790

791-
return response()->noContent();
791+
return redirect('/posts');
792792
}

controllers.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,9 @@ If a controller action is particularly complex, you might find it convenient to
7777
/**
7878
* Provision a new web server.
7979
*/
80-
public function __invoke(): Response
80+
public function __invoke()
8181
{
8282
// ...
83-
84-
return response()->noContent();
8583
}
8684
}
8785

@@ -482,21 +480,21 @@ In addition to constructor injection, you may also type-hint dependencies on you
482480

483481
namespace App\Http\Controllers;
484482

483+
use Illuminate\Http\RedirectResponse;
485484
use Illuminate\Http\Request;
486-
use Illuminate\Http\Response;
487485

488486
class UserController extends Controller
489487
{
490488
/**
491489
* Store a new user.
492490
*/
493-
public function store(Request $request): Response
491+
public function store(Request $request): RedirectResponse
494492
{
495493
$name = $request->name;
496494

497-
// ...
495+
// Store the user...
498496

499-
return response()->noContent();
497+
return redirect('/users');
500498
}
501499
}
502500

@@ -512,17 +510,18 @@ You may still type-hint the `Illuminate\Http\Request` and access your `id` param
512510

513511
namespace App\Http\Controllers;
514512

513+
use Illuminate\Http\RedirectResponse;
515514
use Illuminate\Http\Request;
516515

517516
class UserController extends Controller
518517
{
519518
/**
520519
* Update the given user.
521520
*/
522-
public function update(Request $request, string $id): Response
521+
public function update(Request $request, string $id): RedirectResponse
523522
{
524-
// ...
523+
// Update the user...
525524

526-
return response()->noContent();
525+
return redirect('/users');
527526
}
528527
}

eloquent.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -682,15 +682,15 @@ Of course, when using Eloquent, we don't only need to retrieve models from the d
682682

683683
use App\Http\Controllers\Controller;
684684
use App\Models\Flight;
685+
use Illuminate\Http\RedirectResponse;
685686
use Illuminate\Http\Request;
686-
use Illuminate\Http\Response;
687687

688688
class FlightController extends Controller
689689
{
690690
/**
691691
* Store a new flight in the database.
692692
*/
693-
public function store(Request $request): Response
693+
public function store(Request $request): RedirectResponse
694694
{
695695
// Validate the request...
696696

@@ -700,7 +700,7 @@ Of course, when using Eloquent, we don't only need to retrieve models from the d
700700

701701
$flight->save();
702702

703-
return response()->noContent();
703+
return redirect('/flights');
704704
}
705705
}
706706

encryption.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ You may encrypt a value using the `encryptString` method provided by the `Crypt`
2828

2929
use App\Http\Controllers\Controller;
3030
use App\Models\User;
31+
use Illuminate\Http\RedirectResponse;
3132
use Illuminate\Http\Request;
32-
use Illuminate\Http\Response;
3333
use Illuminate\Support\Facades\Crypt;
3434

3535
class DigitalOceanTokenController extends Controller
3636
{
3737
/**
3838
* Store a DigitalOcean API token for the user.
3939
*/
40-
public function storeSecret(Request $request): Response
40+
public function store(Request $request): RedirectResponse
4141
{
4242
$request->user()->fill([
4343
'token' => Crypt::encryptString($request->token),
4444
])->save();
4545

46-
return response()->noContent();
46+
return redirect('/secrets');
4747
}
4848
}
4949

events.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -495,23 +495,23 @@ To dispatch an event, you may call the static `dispatch` method on the event. Th
495495
use App\Events\OrderShipped;
496496
use App\Http\Controllers\Controller;
497497
use App\Models\Order;
498+
use Illuminate\Http\RedirectResponse;
498499
use Illuminate\Http\Request;
499-
use Illuminate\Http\Response;
500500

501501
class OrderShipmentController extends Controller
502502
{
503503
/**
504504
* Ship the given order.
505505
*/
506-
public function store(Request $request): Response
506+
public function store(Request $request): RedirectResponse
507507
{
508508
$order = Order::findOrFail($request->order_id);
509509

510510
// Order shipment logic...
511511

512512
OrderShipped::dispatch($order);
513513

514-
return response()->noContent();
514+
return redirect('/orders');
515515
}
516516
}
517517

hashing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,24 @@ You may hash a password by calling the `make` method on the `Hash` facade:
3232
namespace App\Http\Controllers;
3333

3434
use App\Http\Controllers\Controller;
35+
use Illuminate\Http\RedirectResponse;
3536
use Illuminate\Http\Request;
36-
use Illuminate\Http\Response;
3737
use Illuminate\Support\Facades\Hash;
3838

3939
class PasswordController extends Controller
4040
{
4141
/**
4242
* Update the password for the user.
4343
*/
44-
public function update(Request $request): Response
44+
public function update(Request $request): RedirectResponse
4545
{
4646
// Validate the new password length...
4747

4848
$request->user()->fill([
4949
'password' => Hash::make($request->newPassword)
5050
])->save();
5151

52-
return response()->noContent();
52+
return redirect('/profile');
5353
}
5454
}
5555

mail.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -736,24 +736,24 @@ To send a message, use the `to` method on the `Mail` [facade](/docs/{{version}}/
736736
use App\Http\Controllers\Controller;
737737
use App\Mail\OrderShipped;
738738
use App\Models\Order;
739+
use Illuminate\Http\RedirectResponse;
739740
use Illuminate\Http\Request;
740-
use Illuminate\Http\Response;
741741
use Illuminate\Support\Facades\Mail;
742742

743743
class OrderShipmentController extends Controller
744744
{
745745
/**
746746
* Ship the given order.
747747
*/
748-
public function store(Request $request): Response
748+
public function store(Request $request): RedirectResponse
749749
{
750750
$order = Order::findOrFail($request->order_id);
751751

752752
// Ship the order...
753753

754754
Mail::to($request->user())->send(new OrderShipped($order));
755755

756-
return response()->noContent();
756+
return redirect('/orders');
757757
}
758758
}
759759

0 commit comments

Comments
 (0)