roemerb/laravel-medialibrary

将文件与Eloquent模型关联

7.6.7 2019-07-16 08:46 UTC

This package is auto-updated.

Last update: 2024-09-16 20:42:35 UTC


README

Latest Version Build Status Quality Score StyleCI Total Downloads

此包可以将各种文件与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 是一家位于比利时的安特卫普的网页设计公司。您可以在我们的网站上找到所有开源项目的概述 在这里

使用较旧的Laravel版本?

这个媒体库版本与Laravel 5.5及更高版本兼容。

如果您使用的是较旧的Laravel版本,您可以使用此包的较旧版本。这些不再维护,但它们应该相当稳定。我们仍然接受小型的错误修复。

文档

您可以在 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 匹配的磁盘配置。

最后,更新 boostrap/app.php 以加载这两个配置文件

// bootstrap/app.php
$app->configure('medialibrary');
$app->configure('filesystems');

测试

您可以使用以下命令运行测试

vendor/bin/phpunit

升级

请参阅 UPGRADING 获取详细信息。

变更日志

请参阅 CHANGELOG 了解最近有哪些变更。

贡献

请参阅 CONTRIBUTING 获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件 freek@spatie.be 联系我们,而不是使用问题跟踪器。

明信片软件

您可以使用此软件包,但如果它进入您的生产环境,我们非常欢迎您从您的家乡给我们寄一张明信片,说明您正在使用我们哪个软件包。

我们的地址是:Spatie,Samberstraat 69D,2060 安特卫普,比利时。

我们将所有收到的明信片 发布在我们的公司网站上

致谢

非常感谢 Nicolas Beauvais 在此存储库的问题上提供帮助。

替代方案

支持我们

Spatie 是一家位于比利时安特卫普的网络设计公司。您可以在我们的网站上找到所有开源项目的概述 在这里

您的业务依赖于我们的贡献吗?通过 Patreon 与我们联系并支持我们。所有承诺都将专门用于分配人力以维护和新奇事物。

许可证

MIT 许可证(MIT)。请参阅 许可证文件 获取更多信息。