04. Editing Chirps
- Introduction
- Routing
- Updating our partial
- Showing the edit Chirp form
- Authorization
- Updating Chirps
- Testing it out
Introduction
Let's add a feature that's missing from other popular bird-themed microblogging platforms — the ability to edit Chirps!
Routing
First we will update our routes file to enable the chirps.edit
and chirps.update
routes for our resource controller:
<?php
use App\Http\Controllers\ChirpController;use App\Http\Controllers\ProfileController;use Illuminate\Support\Facades\Route; /*|--------------------------------------------------------------------------| Web Routes|--------------------------------------------------------------------------|| Here is where you can register web routes for your application. These| routes are loaded by the RouteServiceProvider within a group which| contains the "web" middleware group. Now create something great!|*/ Route::get('/', function () { return view('welcome');}); Route::get('/dashboard', function () { return view('dashboard');})->middleware(['auth', 'verified'])->name('dashboard'); Route::resource('chirps', ChirpController::class) ->only(['index', 'create', 'store']) ->only(['index', 'create', 'store', 'edit', 'update']) ->middleware(['auth', 'verified']);
Route::middleware('auth')->group(function () { Route::prefix('profile')->as('profile.')->group(function () { Route::singleton('password', ProfilePasswordController::class)->only(['edit', 'update']); }); Route::get('/delete', [ProfileController::class, 'delete'])->name('profile.delete'); Route::singleton('profile', ProfileController::class)->destroyable();}); require __DIR__.'/auth.php';
Our route table for this controller now looks like this:
Verb | URI | Action | Route Name |
---|---|---|---|
GET | /chirps |
index | chirps.index |
GET | /chirps/create |
create | chirps.create |
POST | /chirps |
store | chirps.store |
GET | /chirps/{chirp}/edit |
edit | chirps.edit |
PUT/PATCH | /chirps/{chirp} |
update | chirps.update |
Updating our partial
Next, let's update our chirps.partials.chirp
Blade partial to have an edit form for existing Chirps.
We're going to use the <x-dropdown>
component that comes with Turbo Breeze, which we'll only display to the Chirp author. We'll also display an indication if a Chirp has been edited by comparing the Chirp's created_at
date with its updated_at
date:
<div class="p-6 flex space-x-2"> <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6 text-gray-600 -scale-x-100" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"> <path stroke-linecap="round" stroke-linejoin="round" d="M8 12h.01M12 12h.01M16 12h.01M21 12c0 4.418-4.03 8-9 8a9.863 9.863 0 01-4.255-.949L3 20l1.395-3.72C3.512 15.042 3 13.574 3 12c0-4.418 4.03-8 9-8s9 3.582 9 8z" /> </svg> <div class="flex-1"> <div class="flex justify-between items-center"> <div> <span class="text-gray-800">{{ $chirp->user->name }}</span> <small class="ml-2 text-sm text-gray-600"><x-relative-time :date="$chirp->created_at" /></small> @unless ($chirp->created_at->eq($chirp->updated_at)) <small class="text-sm text-gray-600 dark:text-gray-500"> · edited</small> @endunless </div> @if (Auth::id() === $chirp->user->id) <x-dropdown align="right" width="48"> <x-slot name="trigger"> <button> <svg xmlns="http://www.w3.org/2000/svg" class="h-4 w-4 text-gray-400" viewBox="0 0 20 20" fill="currentColor"> <path d="M6 10a2 2 0 11-4 0 2 2 0 014 0zM12 10a2 2 0 11-4 0 2 2 0 014 0zM16 12a2 2 0 100-4 2 2 0 000 4z" /> </svg> </button> </x-slot> <x-slot name="content"> <x-dropdown-link href="{{ route('chirps.edit', $chirp) }}">{{ __('Edit') }}</x-dropdown-link> </x-slot> </x-dropdown> @endif </div> <p class="mt-4 text-lg text-gray-900">{{ $chirp->message }}</p> </div></div>
Showing the edit Chirp form
We can now update the edit
action on our ChirpController
class to show the form to edit Chirps. Even though we're only displaying the edit button to the author of the Chirp, we also need to authorize the request to make sure it's actually the author that is updating it:
<?php namespace App\Http\Controllers; use App\Models\Chirp;use Illuminate\Foundation\Auth\Access\AuthorizesRequests; use Illuminate\Http\Request; class ChirpController extends Controller{ use AuthorizesRequests;
/** * Display a listing of the resource. * * @return \Illuminate\Http\Response */ public function index() { return view('chirps.index', [ 'chirps' => Chirp::with('user:id,name')->latest()->get(), ]); } /** * Show the form for creating a new resource. * * @return \Illuminate\Http\Response */ public function create() { return view('chirps.create'); } /** * Store a newly created resource in storage. * * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\Response */ public function store(Request $request) { $validated = $request->validate([ 'message' => ['required', 'string', 'max:255'], ]); $request->user()->chirps()->create($validated); return redirect() ->route('chirps.index') ->with('status', __('Chirp created.')); } /** * Display the specified resource. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function show(Chirp $chirp) { // } /** * Show the form for editing the specified resource. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\ResponseApp\ */ public function edit(Chirp $chirp) { // $this->authorize('update', $chirp); return view('chirps.edit', [ 'chirp' => $chirp, ]); }
/** * Update the specified resource in storage. * * @param \Illuminate\Http\Request $request * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function update(Request $request, Chirp $chirp) { // } /** * Remove the specified resource from storage. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function destroy(Chirp $chirp) { // } }
Now, we need to create our chirps.edit
view:
<x-app-layout :title="__('Edit Chirp')"> <x-slot name="header"> <h2 class="flex items-center space-x-1 font-semibold text-xl text-gray-800 dark:text-gray-200 leading-tight"> <x-breadcrumbs :links="[route('chirps.index') => __('Chirps'), __('Edit Chirp')]" /> </h2> </x-slot> <div class="py-12"> <div class="max-w-2xl mx-auto sm:px-6 lg:px-8 space-y-6"> <div class="p-4 sm:p-8 bg-white dark:bg-gray-800 shadow sm:rounded-lg"> <div class="max-w-xl mx-auto"> @include('chirps.partials.form', ['chirp' => $chirp]) </div> </div> </div> </div></x-app-layout>
We're using the same form
partial the create chirps view uses. However, in this case we're passing down a Chirp model to the form so it can pre-fill the message field. Since we're passing a Chirp model, we can make the form submit to the chirps.update
endpoint instead of the default chirps.store
one when no Chirp is passed. Let's make the changes to the chirps.partials.form
partial, replace the existing form with this one:
<form action="{{ ($chirp ?? false) ? route('chirps.update', $chirp) : route('chirps.store') }}" method="POST" class="w-full"> @csrf @if ($chirp ?? false) @method('PUT') @endif <div> <x-input-label for="message" :value="__('Message')" class="sr-only" /> <x-textarea-input id="message" name="message" autofocus placeholder="{{ __('What\'s on your mind?') }}" class="block w-full" :value="old('message', $chirp?->message ?? '')" /> <x-input-error :messages="$errors->get('message')" class="mt-2" /> </div> <div class="mt-6 flex items-center space-x-4"> <x-primary-button> {{ __('Chirp') }} </x-primary-button> @if ($chirp ?? false) <a href="{{ route('chirps.index') }}" class="dark:text-gray-400">{{ __('Cancel') }}</a> @endif </div></form>
Authorization
By default, the authorize
method will prevent everyone from being able to update the Chirp. We can specify who is allowed to update it by creating a Model Policy with the following command:
php artisan make:policy ChirpPolicy --model=Chirp
This will create a policy class at app/Policies/ChirpPolicy.php
which we can update to specify that only the author is authorized to update a Chirp:
<?php
namespace App\Policies; use App\Models\Chirp;App\use App\Models\User;use Illuminate\Auth\Access\HandlesAuthorization; class ChirpPolicy{
use HandlesAuthorization; /** * Determine whether the user can view any models. * * @param \App\Models\User $user * @return \Illuminate\Auth\Access\Response|bool */ public function viewAny(User $user) { // } /** * Determine whether the user can view the model. * * @param \App\Models\User $user * @param \App\Models\Chirp $chirp * @return \Illuminate\Auth\Access\Response|bool */ public function view(User $user, Chirp $chirp) { // } /**App\ * Determine whether the user can create models. * * @param \App\Models\User $user * @return \Illuminate\Auth\Access\Response|bool */ public function create(User $user) { // } /** * Determine whether the user can update the model. * * @param \App\Models\User $user * @param \App\Models\Chirp $chirp * @return \Illuminate\Auth\Access\Response|bool */ public function update(User $user, Chirp $chirp) { // return $user->is($chirp->user); }
/** * Determine whether the user can delete the model. * * @param \App\Models\User $user * @param \App\Models\Chirp $chirp * @return \Illuminate\Auth\Access\Response|bool */ public function delete(User $user, Chirp $chirp) { // } /** * Determine whether the user can restore the model. * * @param \App\Models\User $user * @param \App\Models\Chirp $chirp * @return \Illuminate\Auth\Access\Response|bool */ public function restore(User $user, Chirp $chirp) { // } /** * Determine whether the user can permanently delete the model. * * @param \App\Models\User $user * @param \App\Models\Chirp $chirp * @return \Illuminate\Auth\Access\Response|bool */ public function forceDelete(User $user, Chirp $chirp) { // } }
You should be able to use the dropdown, click on the Edit link and view the edit Chirp form:
Updating Chirps
We can now change the update
action on our ChirpController
class to validate the request and update the database. Again, we also need to authorize the request here to make sure it's actually the author that is updating it:
<?php
namespace App\Http\Controllers; use App\Models\Chirp;use Illuminate\Foundation\Auth\Access\AuthorizesRequests;use Illuminate\Http\Request; class ChirpController extends Controller{
use AuthorizesRequests; /** * Display a listing of the resource. * * @return \Illuminate\Http\ResponseApp\ */ public function index() { return view('chirps.index', [ 'chirps' => Chirp::with('user:id,name')->latest()->get(), ]); } /** * Show the form for creating a new resource. * * @return \Illuminate\Http\Response */ public function create() { return view('chirps.create'); } /** * Store a newly created resource in storage. * * @param \Illuminate\Http\Request $request * @return \Illuminate\Http\Response */ public function store(Request $request) { $validated = $request->validate([ 'message' => ['required', 'string', 'max:255'], ]); $request->user()->chirps()->create($validated); return redirect() ->route('chirps.index') ->with('status', __('Chirp created.')); } /** * Display the specified resource. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function show(Chirp $chirp) { // } /** * Show the form for editing the specified resource. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function edit(Chirp $chirp) { // $this->authorize('update', $chirp); return view('chirps.edit', [ 'chirp' => $chirp, ]); } /** * Update the specified resource in storage. * * @param \Illuminate\Http\Request $request * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function update(Request $request, Chirp $chirp) { // $this->authorize('update', $chirp); $validated = $request->validate([ 'message' => ['required', 'string', 'max:255'], ]); $chirp->update($validated); return redirect()->route('chirps.index')->with('notice', __('Chirp updated.')); }
/** * Remove the specified resource from storage. * * @param \App\Models\Chirp $chirp * @return \Illuminate\Http\Response */ public function destroy(Chirp $chirp) { // } }
You may have noticed the validation rules are duplicated with the store
action. You might consider extracting them using Laravel's Form Request Validation, which makes it easy to re-use validation rules and to keep your controllers light.
Testing it out
Time to test it out! Go ahead and edit a few Chirps using the dropdown menu. If you register another user account, you'll see that only the author of a Chirp can edit it.