mpyw / laravel-file-errors
A tiny extension that reports validation error details about uploaded files
Installs: 3 034
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: ^8.0
- illuminate/http: ^9.0 || ^10.0 || ^11.0
- illuminate/support: ^9.0 || ^10.0 || ^11.0
- illuminate/validation: ^9.0 || ^10.0 || ^11.0
Requires (Dev)
- orchestra/testbench: *
- orchestra/testbench-core: >=7.0
- phpunit/phpunit: >=9.5
This package is auto-updated.
Last update: 2024-10-21 19:48:45 UTC
README
A tiny extension that reports validation error details about uploaded files
Requirements
- PHP:
^8.0
- Laravel:
^9.0 || ^10.0
Installing
1. Install package
composer require mpyw/laravel-file-errors
2. Customize translation
Edit lang/{en,ja,...}/validation.php
in your project.
Feel free to copy from lang.
<?php use Mpyw\LaravelFileErrors\UploadError as Err; return [ /* |-------------------------------------------------------------------------- | Validation Language Lines |-------------------------------------------------------------------------- | | The following language lines contain the default error messages used by | the validator class. Some of these rules have multiple versions such | as the size rules. Feel free to tweak each of these messages here. | */ /* ... */ // 'uploaded' => 'The :attribute failed to upload.', 'uploaded' => [ Err::TITLE_INI_SIZE => 'The :attribute exceeds the maximum filesize defined in the server.', Err::TITLE_FORM_SIZE => 'The :attribute exceeds the maximum filesize defined in the form.', Err::TITLE_PARTIAL => 'The :attribute was only partially uploaded.', Err::TITLE_NO_FILE => 'The :attribute was not uploaded.', Err::TITLE_CANT_WRITE => 'The :attribute could not be written on disk.', Err::TITLE_NO_TMP_DIR => 'The :attribute could not be uploaded; missing temporary directory.', Err::TITLE_EXTENSION => 'The :attribute upload was stopped by a PHP extension.', Err::TITLE_UNKNOWN => 'The :attribute could not be uploaded due to an unknown error.', ], /* ... */ ];
Basic Usage
Important
The default implementation is provided by ValidationServiceProvider
, however, package discovery is not available.
Be careful that you MUST register it in config/app.php
by yourself.
<?php return [ /* ... */ 'providers' => [ /* ... */ Mpyw\LaravelFileErrors\ValidationServiceProvider::class, /* ... */ ], ];
<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Illuminate\Support\Facades\Validator; class UserController extends Controller { public function update(Request $request) { $validator = Validator::make( $request->all(), [ 'name' => 'required|max:20', 'avatar' => 'required|image', ] ); // This may contain... // ['avatar' => ['The avatar exceeds the maximum filesize defined in the server.']] dump($validator->errors()->toArray()); } }
Advanced Usage
Tip
You can extend Validator
with IncludesFileErrorDetails
trait by yourself.
<?php namespace App\Providers; use App\Services\Validation\Validator; use Illuminate\Support\ServiceProvider; use Illuminate\Support\Facades\Validator as Validation; class ValidationServiceProvider extends ServiceProvider { public function boot(): void { Validation::resolver(function (...$parameters) { return new Validator(...$parameters); }); } }
<?php namespace App\Services\Validation; use Illuminate\Validation\Validator as BaseValidator; use Mpyw\LaravelFileErrors\IncludesFileErrorDetails; class Validator extends BaseValidator { use IncludesFileErrorDetails; /* ... */ }