adityawiguna12 / laravel-medialibrary
将文件与 Eloquent 模型关联
Requires
- php: ^7.2
- ext-fileinfo: *
- ext-json: *
- illuminate/bus: ~5.8.35|^6.0|^7.0
- illuminate/console: ~5.8.35|^6.0|^7.0
- illuminate/database: ~5.8.35|^6.0|^7.0
- illuminate/pipeline: ~5.8.35|^6.0|^7.0
- illuminate/support: ~5.8.35|^6.0|^7.0
- league/flysystem: ^1.0.8
- maennchen/zipstream-php: ^1.0
- spatie/image: ^1.4.0
- spatie/pdf-to-image: ^2.0
- spatie/temporary-directory: ^1.1
- symfony/console: ^4.4|^5.0
Requires (Dev)
- ext-pdo_sqlite: *
- doctrine/dbal: ^2.5.2
- guzzlehttp/guzzle: ^6.3
- league/flysystem-aws-s3-v3: ^1.0.13
- mockery/mockery: ^1.0
- orchestra/testbench: ^3.8|^4.0|^5.0
- phpunit/phpunit: ^8.0
- spatie/phpunit-snapshot-assertions: ^2.0
Suggests
- league/flysystem-aws-s3-v3: Required to use AWS S3 file storage
- php-ffmpeg/php-ffmpeg: Required for generating video thumbnails
Conflicts
- php-ffmpeg/php-ffmpeg: <0.6.1
This package is auto-updated.
Last update: 2024-09-29 05:42:48 UTC
README
此包可以将各种类型的文件与 Eloquent 模型关联。它提供了一个简单的 API 来进行操作。要了解所有相关信息,请前往详尽的文档。
以下是一些简短示例,展示了您可以做什么
$newsItem = News::find(1); $newsItem->addMedia($pathToFile)->toMediaCollection('images');
它可以直接处理您的上传
$newsItem->addMedia($request->file('image'))->toMediaCollection('images');
想要在另一个文件系统上存储一些大文件?没问题
$newsItem->addMedia($smallFile)->toMediaCollection('downloads', 'local'); $newsItem->addMedia($bigFile)->toMediaCollection('downloads', 's3');
文件的存储由 Laravel 的文件系统 处理,因此您可以使用您喜欢的任何文件系统。此外,该包可以在媒体库中添加的图片和 PDF 上创建图像处理。
Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述在这里。
支持我们
我们投入了大量资源来创建一流的开放式源代码包。您可以通过购买我们的付费产品之一来支持我们。
我们非常感谢您从您的家乡寄给我们明信片,注明您正在使用我们的哪个包。您可以在我们的联系页面上找到我们的地址。我们将发布所有收到的明信片在我们的虚拟明信片墙上。
文档
您可以在https://docs.spatie.be/laravel-medialibrary/v7 上找到文档。
如果您在使用此包时遇到困难?发现了错误?您是否有关于改进媒体库的一般问题或建议?请随时在 GitHub 上创建一个问题,我们将尽快处理。
如果您发现了关于安全的错误,请通过freek@spatie.be 发送电子邮件,而不是使用问题跟踪器。
要求
安装
您可以使用以下命令通过 composer 安装此包
composer require "spatie/laravel-medialibrary:^7.0.0"
该包将自动注册自己。
您可以使用以下命令发布迁移
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="migrations"
在迁移发布后,您可以通过运行迁移来创建媒体表
php artisan migrate
您可以使用以下命令发布配置文件
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="config"
这是已发布配置文件的内容
return [ /* * The filesystems on which to store added files and derived images by default. Choose * one or more of the filesystems you've configured in config/filesystems.php. */ 'disk_name' => 'public', /* * The maximum file size of an item in bytes. * Adding a larger file will result in an exception. */ 'max_file_size' => 1024 * 1024 * 10, /* * This queue will be used to generate derived images. * Leave empty to use the default queue. */ 'queue_name' => '', /* * The class name of the media model that should be used. */ 'media_model' => Spatie\MediaLibrary\Models\Media::class, /* * The engine that should perform the image conversions. * Should be either `gd` or `imagick`. */ 'image_driver' => 'gd', /* * When urls to files get generated, this class will be called. Leave empty * if your files are stored locally above the site root or on s3. */ 'url_generator' => null, /* * The class that contains the strategy for determining a media file's path. */ 'path_generator' => null, 's3' => [ /* * The domain that should be prepended when generating urls. */ 'domain' => 'https://xxxxxxx.s3.amazonaws.com', ], 'remote' => [ /* * Any extra headers that should be included when uploading media to * a remote disk. Even though supported headers may vary between * different drivers, a sensible default has been provided. * * Supported by S3: CacheControl, Expires, StorageClass, * ServerSideEncryption, Metadata, ACL, ContentEncoding */ 'extra_headers' => [ 'CacheControl' => 'max-age=604800', ], ], /* * These generators will be used to create an image of media files. */ 'image_generators' => [ Spatie\MediaLibrary\ImageGenerators\FileTypes\Image::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Webp::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Pdf::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Svg::class, Spatie\MediaLibrary\ImageGenerators\FileTypes\Video::class, ], /* * Medialibrary will try to optimize all converted images by removing * metadata and applying a little bit of compression. These are * the optimizers that will be used by default. */ 'image_optimizers' => [ Spatie\ImageOptimizer\Optimizers\Jpegoptim::class => [ '--strip-all', // this strips out all text information such as comments and EXIF data '--all-progressive', // this will make sure the resulting image is a progressive one ], Spatie\ImageOptimizer\Optimizers\Pngquant::class => [ '--force', // required parameter for this package ], Spatie\ImageOptimizer\Optimizers\Optipng::class => [ '-i0', // this will result in a non-interlaced, progressive scanned image '-o2', // this set the optimization level to two (multiple IDAT compression trials) '-quiet', // required parameter for this package ], Spatie\ImageOptimizer\Optimizers\Svgo::class => [ '--disable=cleanupIDs', // disabling because it is known to cause troubles ], Spatie\ImageOptimizer\Optimizers\Gifsicle::class => [ '-b', // required parameter for this package '-O3', // this produces the slowest but best results ], ], /* * The path where to store temporary files while performing image conversions. * If set to null, storage_path('medialibrary/temp') will be used. */ 'temporary_directory_path' => null, /* * FFMPEG & FFProbe binaries path, only used if you try to generate video * thumbnails and have installed the php-ffmpeg/php-ffmpeg composer * dependency. */ 'ffmpeg_binaries' => '/usr/bin/ffmpeg', 'ffprobe_binaries' => '/usr/bin/ffprobe', ];
默认情况下,媒体库将文件存储在 Laravel 的 public
磁盘上。如果您想要一个专用磁盘,您应该在 app/config/filesystems.php
中添加一个磁盘。这将是典型的配置
... 'disks' => [ ... 'media' => [ 'driver' => 'local', 'root' => public_path().'/media', 'url' => env('APP_URL') . '/media', 'visibility' => 'public', ], ...
媒体库的所有文件都将存储在该磁盘上。如果您计划使用图像处理,您应该在服务中配置一个名为配置文件中指定的名称的队列。
Lumen 支持
Lumen 配置稍微复杂一些,但功能和 API 与 Laravel 相同。
使用以下命令安装
composer require spatie/laravel-medialibrary
在引导文件中取消以下行的注释
// bootstrap/app.php: $app->withFacades(); $app->withEloquent();
配置 laravel-medialibrary 服务提供程序(以及 AppServiceProvider
,如果尚未启用)
// bootstrap/app.php: $app->register(App\Providers\AppServiceProvider::class); $app->register(Spatie\MediaLibrary\MediaLibraryServiceProvider::class);
更新 AppServiceProvider
的 register 方法,将文件系统管理器绑定到 IOC 容器
// app/Providers/AppServiceProvider.php public function register() { $this->app->singleton('filesystem', function ($app) { return $app->loadComponent('filesystems', 'Illuminate\Filesystem\FilesystemServiceProvider', 'filesystem'); }); $this->app->bind('Illuminate\Contracts\Filesystem\Factory', function($app) { return new \Illuminate\Filesystem\FilesystemManager($app); }); }
手动将包配置文件复制到 app\config\laravel-medialibrary.php
(如果该目录不存在,则需要创建)。
将 Laravel 文件系统配置文件 复制到 app\config\filesystem.php
。您应该在文件系统配置中添加一个磁盘配置,以匹配 laravel-medialibrary 配置文件中指定的 default_filesystem
。
最后,更新 bootstrap/app.php
以加载这两个配置文件。
// bootstrap/app.php $app->configure('medialibrary'); $app->configure('filesystems');
测试
您可以使用以下命令运行测试:
vendor/bin/phpunit
升级
有关详细信息,请参阅 UPGRADING。
变更日志
有关最近更改的更多信息,请参阅 CHANGELOG。
贡献
有关详细信息,请参阅 CONTRIBUTING。
安全
如果您发现任何与安全相关的问题,请通过电子邮件 freek@spatie.be 反馈,而不是使用问题跟踪器。
鸣谢
感谢 Nicolas Beauvais 帮助处理这个存储库中的问题。
替代方案
支持我们
Spatie 是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述 在这里。
您的业务依赖于我们的贡献吗?请联系我们,在 Patreon 上支持我们。所有承诺都将用于分配人力以维护和开发新功能。
许可证
MIT 许可证(MIT)。有关更多信息,请参阅 许可证文件。