在 Laravel 程序中上传文件时,请求验证能够很好验证上传的文件。你能够要求上传文件必须为 图片 , 也能够限制文件字节 大小 , 也能够根据 mime types 或者 文件扩展名 过滤文件。php
若是咱们但愿用户上载 ZIP 文件,咱们能够结合规则并像以下所示的内容使用:css
return [ 'file' => 'required|file|mimes:zip|size:3072' ];
可是与图片、文本或 pdf 文件不一样,ZIP 是一个压缩文件,能够在其中保存多个不一样的文件。 假设咱们但愿用户上传一个 ZIP 文件,但带有特定的必需文件和文件夹结构。 举一个真实的例子,若是您曾经使用过 Wordpress 并使用 ZIP 文件为其安装了主题,则 Wordpress 要求主题 ZIP 文件具备某些特定的文件,例如 style.css 或 post.php。 在 Laravel 中咱们如何验证上传的 ZIP 文件以查看其是否包含全部必需文件?node
libzip
扩展这里会须要 php 的 libzip 扩展的支持,该扩展的启用以及具体用法请看文档 official documentation page.laravel
第一步,实例化 ZipArchive
类。闭包
$zip = new \ZipArchive();
而后咱们就能够经过 open()
方法来解压 ZIP 文档了。架构
$zip->open('/absolute/path/to/file.zip');
方法的官方文档 指出,若是成功打开 ZIP 文件,它将返回 “true”,不然返回整数错误代码。 咱们能够像这样检查全部内容:ide
$zipStatus = $zip->open('/absolute/path/to/file.zip'); if (zipStatus !== true) { threw new \Exception('Could not open ZIP file. Error code: ' . zipStatus); } // 没问题,继续操做…
ZipArchive
类提供了多种方法来帮助咱们读取 ZIP 文件的内容,其中一些方法是post
count()
- 返回 ZIP 文件中的文件数getFromIndex()
- 返回指定索引对应的文件getNameIndex()
- 返回指定索引的文件名statIndex()
- 返回指定索引对应文件的详细信息(文件名、大小等)有了这些方法,若是咱们想得到 ZIP 文件中的可用文件列表。 咱们能够这样作:学习
$filesInside = []; for ($i = 0; $i < $zip->count(); $i++) { array_push($filesInside, $zip->getNameIndex($i)); } $zip->close();
因为一个 ZipArchive 实例能够同时处理一个 ZIP 文件,所以在处理完该文件后,咱们须要使用 close()方法。 当您循环浏览多个 ZIP 文件或使用此类建立新的 ZIP 文件时,这一点尤为重要。ui
当你使用 ZipArchive 时有一点须要注意一下, “entity” 的概念,这里的 “entity” 并不仅仅是文件,他还包含全部文件夹以及子文件夹。这句话怎么理解呢?假设咱们有个目录结构以下的文档:
- invoice.pdf - profile_picture.jpg - documents/ - homework.doc - bills/ - january/ - payment.pdf
咱们对当前文档执行 count() 操做能够获得当前文件数量,虽然咱们只有 4 个文件,但 count() 方法返回的是 7 ,这是为何呢?让咱们打印一下 $filesInside 看它里面到底包含了什么吧。
$files = [ 'invoice.pdf', 'profile_picture.jpg', 'documents/', 'documents/homework.doc', 'bills/', 'bills/january/', 'bills/january/payment.pdf' ];
能够看到,打印结果中并不单单有你的文件还有相应的文件夹。 这里你还能够经过 getNameIndex()
方法来获取完整的文件路径。
如今,咱们知道了如何使用 PHP 获取 ZIP 的文件列表,让咱们将全部内容集成到 Laravel 中并验证上传的 ZIP 文件是否包含必需的文件。
假设咱们须要用户上传一个 ZIP 文件,而且文件的 assets
目录中必须包含 thumbnail.jpg
和 style.css
文件。
- thumbnail.jpg - assets/ - style.css
这是咱们的控制器,该控制器处理带有名为 zip_file 的文件上传:
namespace App\Controllers; use Illuminate\Http\Request; class UploadController { const REQUIRED_FILES = [ 'thumbnail.jpg', 'assets/style.css', ]; public function upload(Request $request) { $zip = new \ZipArchive(); $file = $request->file('zip_file'); } }
对咱们从 Illuminate\Http\Request 中检索数据时,每一个文件都返回一个 Illuminate\Http\UploadedFile 实例。咱们能够在实例上使用 path() 方法返回上传的临时文件的绝对路径。
这是咱们打开 ZIP 文件并使用 ZipArchive
类列出全部文件的方法。
public function upload(Request $request) { $zip = new \ZipArchive(); $file = $request->file('zip_file'); $zip->open($file->path()); $filesInside = []; for ($i = 0; $i < $zip->count(); $i++) { array_push($filesInside, $zip->getNameIndex($i)); } }
如今咱们能够使用诸如 array_intersect() 之类的方法将 REQUIRED_FILES 与 $filesInside 进行比对。若是交集元素数量不等于 REQUIRED_FILES 的元素数量,则意味着上传的 ZIP 文件中并不存在全部必需的文件,所以咱们能够停止请求执行或返回验证错误。
$intersection = array_intersect(self::REQUIRED_FILES, $filesInside); if (count($intersection) !== count(self::REQUIRED_FILES)) { abort(422); }
这是咱们的控制器,一切就绪:
namespace App\Controllers; use Illuminate\Http\Request; class UploadController { const REQUIRED_FILES = [ 'thumbnail.jpg', 'assets/style.css', ]; public function upload(Request $request) { $zip = new \ZipArchive(); $file = $request->file('zip_file'); $zip->open($file->path()); $filesInside = []; for ($i = 0; $i < $zip->count(); $i++) { array_push($filesInside, $zip->getNameIndex($i)); } $intersection = array_intersect(self::REQUIRED_FILES, $filesInside); if (count($intersection) !== count(self:: REQUIRED_FILES)) { abort(422); } // ZIP contains all required files, continue } }
在 Laravel 应用程序中,最佳实践是将与验证相关的内容移出控制器。 常见选项有:
出于 ZIP 内容验证的须要,我建立了一个专用的 Laravel 软件包,该软件包几乎完成了本博客文章中所述的全部操做,并提供了更多选项和功能。 您能够在 GitHub 页面查看 orkhanahmadov/laravel-zip-validator 以获取更多信息以及如何使用它。
更多学习内容请访问: