Use the validated method of FormRequest for store and update #3792
Conversation
|
BOOM! Your first PR with us, thank you so much! Someone will take a look at it shortly. Please keep in mind that:
Thank you! -- |
|
The inspection completed: 2 updated code elements |
|
Hello @rodrigofs ! Sorry for taking so much time to get back to this. I think I've opened this issue like 2 or 3 times already, but I cannot figure out why we should do this. What was your concrete implementation that misses this functionality? If possible I would like you to describe what you are trying to achieve, and where did backpack failed you. Google translate does a pretty good job, I could understand what you wrote, but I could not figure out the scenario where I would be needing it. So feel free to include some code also if you feel that would help me to understand it. Anyway I don't think we can make changes like this in 4.1 so I am postponing it to 4.2 (it's just right about the corner). Let's get to the endpoint here and if we can do something better to help our users we will for sure pay close attention to it. Thanks, |
|
I just thought of a syntax/name for this. What if instead of // instead of defining the stripping in config/backpack/crud.php like this:
// Before saving the entry, how would you like the request to be stripped?
// - false - ONLY save inputs that have fields (safest)
// - [x, y, z] - save ALL inputs, EXCEPT the ones given in this array
'saveAllInputsExcept' => false,
// 'saveAllInputsExcept' => ['_token', '_method', '_http_referrer', '_current_tab', '_save_action'],
// we have a default way of saving (the same as now), so we save:
$request->only(CRUD::getAllFieldNames());
// but we allow the dev to overwrite that using a closure,
// in his setupCreateOperation() or setupUpdateOperation()
// example 1: only save the validated inputs in the FormRequest
CRUD::set('saved_input', function($request) {
return $request->validated();
});
// example 2: strip out all inputs that begin with underscore (equivalent to the comment out line above)
CRUD::set('saved_input', function($request) {
return $request->filter(function ($value, $key) {
return ! Str::of($key)->beginsWith('_');
});
});This would not add another option on how the request is to be processed before saving... it would allow the dev complete customization of that process. Sure they can choose to use the validated request. But they can choose to do something else too, like add another input... or remove a different input... or change one input from something to something else (make it uppercase, turn it into a kebab... whatever). I think I'm onto something here, and I'd love to code it... Basically the only thing that will change is public function getStrippedSaveRequest($request)
{
$requestProcessingClosure = $this->getOperationSetting('saved_input');
if ($requestProcessingClosure && is_callable($requestProcessingClosure)) {
return $requestProcessingClosure($request);
}
return $request->only($this->getAllFieldNames());
}My only question is... what's a good name for that? 😅 CRUD::set('saved_input', function($request) {
return $request->validated();
});
CRUD::set('saved_request', function($request) {
return $request->validated();
});
CRUD::set('stripped_request', function($request) {
return $request->validated();
});
CRUD::set('final_request', function($request) {
return $request->validated();
});
CRUD::set('final_input', function($request) {
return $request->validated();
});
CRUD::set('before_saving', function($request) {
return $request->validated();
});Personally I kind of prefer |
|
@tabacitu I also think you have nailed it here in regards of what inputs to save. I don't have much to say about implementation here, so I will just try to suggest some names: Best, |
…nd Update operations fixes #3792
|
Great to hear that @pxpm 🙏 @rodrigofs , I've just finished the PR that does the above, so after we merge that and #3789 and launch 4.2 you'll be able to do this to achieve the same thing: /**
* Before saving the entry, how would you like the request to be stripped?
* - false - fall back to Backpack's default (ONLY save inputs that have fields)
* - closure - process your own request (example removes all inputs that begin with underscode)
*
* @param \Illuminate\Http\Request $request
* @return array
*/
'strippedRequest' => (function ($request) {
return $request->validated();
}),Or inside your CRUD::set('strippedRequest', (function ($request) {
return $request->validated();
}));🎉🎉🎉 Thanks for the feedback, the PR and for the patience. PS. I'll close this PR because #3987 fixes the same thing in a different way. |
My suggestion would be to use the validated method of the FormRequest class, this method makes it possible to modify the data after validation and before persisting the data in the database, in addition to giving us the possibility to use the prepareForValidation method that is executed before validation, in case need to unmask data before validating.
To make use of this approach, it would be enough to have a data validation in a form request class and use $this->crud->enableApproachFormRequest() in the controller setup.
Sorry for my English from google translator. ^^