dees040/laravel-medialibrary

将文件与Eloquent模型关联

6.0.0 2017-08-16 09:22 UTC

README

Latest Version Build Status Quality Score StyleCI Total Downloads

此Laravel >=5.4包可以将各种文件与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的Filesystem处理,所以你可以使用任何你喜欢的文件系统。此外,该包可以在媒体库中添加的图像和PDF上创建图像处理。

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

文档

你可以在https://docs.spatie.be/laravel-medialibrary/v5上找到文档。

在使用包时遇到困难?发现了一个错误?你有关于改进媒体库的一般性问题或建议?请随时在GitHub上创建一个问题,我们将尽快解决。

如果你发现了一个关于安全性的错误,请通过freek@spatie.be发送邮件,而不是使用问题跟踪器。

要求

为了创建派生图像,您的服务器上应该安装GD。为了创建svg或pdf的缩略图,你还应该安装Imagick

明信片软件

你可以自由使用这个包(它是MIT许可),但如果它进入了你的生产环境,你必须向我们寄一张来自你家乡的明信片,说明你使用了我们哪个包。

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

最好的明信片将被发布在我们的网站上开源页面。

安装

你可以使用以下命令通过Composer安装此包

composer require spatie/laravel-medialibrary:^5.0.0

接下来,你必须安装服务提供者

// config/app.php
'providers' => [
    ...
    Spatie\MediaLibrary\MediaLibraryServiceProvider::class,
];

你可以使用以下命令发布迁移

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="migrations"

迁移发布后,你可以通过运行迁移来创建media-table

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 configured in app/config/filesystems.php
     */
    'defaultFilesystem' => 'media',

    /*
     * The maximum file size of an item in bytes. Adding a file
     * that is larger 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 to be used.
     */
    'media_model' => Spatie\MediaLibrary\Media::class,

    /*
     * 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.
     */
    'custom_url_generator_class' => null,

    /*
     * The class that contains the strategy for determining a media file's path.
     */
    'custom_path_generator_class' => 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',
        ],
    ],

    /*
     * 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',
];

最后,你应该在app/config/filesystems.php中添加一个磁盘。这是一个典型的配置

    ...
    'disks' => [
        ...

        'media' => [
            'driver' => 'local',
            'root'   => public_path().'/media',
        ],
    ...

媒体库中的所有文件都将存储在该磁盘上。如果你打算处理图像处理,你应该在你的服务中配置一个队列,其名称在配置文件中指定。

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配置文件中指定的defaultFilesystem匹配的磁盘配置。

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

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

测试

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

vendor/bin/phpunit

升级

有关详细信息,请参阅 UPGRADING

贡献

有关详细信息,请参阅 CONTRIBUTING

安全

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

致谢

感谢 Nicolas Beauvais 为此仓库的问题提供帮助。

替代方案

关于 Spatie

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

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件