workup/advanced-nova-media-library

Laravel Nova 管理Spatie媒体库的工具。

v4.2.2 2024-05-09 13:07 UTC

README

管理来自 spatie的媒体库包 的图片。可以上传多张图片并通过拖拽排序。

目录

示例

Cropping Single image upload Multiple image upload Custom properties Generic file management

安装

composer require workup/advanced-nova-media-library
php artisan vendor:publish --tag=nova-media-library

模型媒体配置

假设您已经按照以下方式配置了模型以使用媒体库

use Spatie\MediaLibrary\MediaCollections\Models\Media;

public function registerMediaConversions(Media $media = null): void
{
    $this->addMediaConversion('thumb')
        ->width(130)
        ->height(130);
}

public function registerMediaCollections(): void
{
    $this->addMediaCollection('main')->singleFile();
    $this->addMediaCollection('my_multi_collection');
}

通用文件管理

Generic file management

为了能够上传和处理通用文件,只需使用Files字段即可。

use Workup\AdvancedNovaMediaLibrary\Fields\Files;

Files::make('Single file', 'one_file'),
Files::make('Multiple files', 'multiple_files'),

单张图片上传

Single image upload

use Workup\AdvancedNovaMediaLibrary\Fields\Images;

public function fields(Request $request)
{
    return [
        Images::make('Main image', 'main') // second parameter is the media collection name
            ->conversionOnIndexView('thumb') // conversion used to display the image
            ->rules('required'), // validation rules
    ];
}

多张图片上传

如果您启用了多文件上传功能,您可以通过拖拽来排序图片

Multiple image upload

use Workup\AdvancedNovaMediaLibrary\Fields\Images;

public function fields(Request $request)
{
    return [
        Images::make('Images', 'my_multi_collection') // second parameter is the media collection name
            ->conversionOnPreview('medium-size') // conversion used to display the "original" image
            ->conversionOnDetailView('thumb') // conversion used on the model's view
            ->conversionOnIndexView('thumb') // conversion used to display the image on the model's index page
            ->conversionOnForm('thumb') // conversion used to display the image on the model's form
            ->fullSize() // full size column
            ->rules('required', 'size:3') // validation rules for the collection of images
            // validation rules for the collection of images
            ->singleImageRules('dimensions:min_width=100'),
    ];
}

选择现有媒体

Selecting existing media Selecting existing media 2

如果您将相同的媒体文件上传到多个模型,并且不想再次从文件系统中选择它,请使用此功能。选择已存在的媒体将复制它。

注意:此功能会将搜索现有媒体的功能暴露给应用程序的每个用户。如果您的媒体上传或媒体模型上的自定义属性是机密的,请不要启用此功能

  • 如果您尚未发布配置文件,请发布它们
artisan vendor:publish --tag=nova-media-library
  • 在配置文件 config/nova-media-library 中启用此功能
return [
    'enable-existing-media' => true,
];
  • 启用选择现有媒体字段
Images::make('Image')->enableExistingMedia(),

注意:此功能不支持临时URL。

上传图片名称

新上传文件的默认文件名为原始文件名。您可以使用setFileName函数来更改它,该函数接受一个回调函数作为唯一参数。此回调函数有三个参数:$originalFilename(原始文件名,例如Fotolia 4711.jpg)、$extension(文件扩展名,例如jpg)、$model(当前模型)。以下是一些示例

// Set the filename to the MD5 Hash of original filename
Images::make('Image 1', 'img1')
    ->setFileName(function($originalFilename, $extension, $model){
        return md5($originalFilename) . '.' . $extension;
    });

// Set the filename to the model name
Images::make('Image 2', 'img2')
    ->setFileName(function($originalFilename, $extension, $model){
        return str_slug($model->name) . '.' . $extension;
    });

默认情况下,媒体对象上的“名称”字段设置为不带扩展名的原始文件名。要更改此,您可以使用setName函数。与上面的setFileName类似,它接受一个回调函数作为唯一参数。此回调函数有两个参数:$originalFilename$model

Images::make('Image 1', 'img1')
    ->setName(function($originalFilename, $model){
        return md5($originalFilename);
    });

响应式图片

如果您想使用来自Spatie MediaLibrary的响应式图片功能,您可以在模型上使用withResponsiveImages()函数。

Images::make('Image 1', 'img1')
    ->withResponsiveImages();

图片裁剪

Cropping

默认情况下,您可以通过在编辑视图的左下角点击剪刀来裁剪/旋转图片。为此目的使用了vue-js-clipper。裁剪功能仅限于image/jpgimage/jpegimage/png的MIME类型。

重要:通过裁剪现有图片,原始媒体模型将被删除并替换为裁剪后的图片。所有自定义属性将从旧模型复制到新模型。

要禁用此功能,请使用croppable方法

Images::make('Gallery')->croppable(false);

您可以将所有配置设置如下,例如比率等

Images::make('Gallery')->croppingConfigs(['aspectRatio' => 4/3]);

可用的裁剪配置,请参阅https://github.com/timtnleeProject/vuejs-clipper#clipper-basic

可以在上传时强制执行裁剪,例如确保图片具有设置的宽高比

Images::make('Gallery')->mustCrop();

默认禁用裁剪

默认情况下,裁剪功能是启用的。要默认禁用所有图片的裁剪,请将config/nova-media-library.php中的default-croppable设置为false

return [
    'default-croppable' => false,
];

自定义属性

Custom properties

Images::make('Gallery')
    ->customPropertiesFields([
        Boolean::make('Active'),
        Markdown::make('Description'),
    ]);
    
Files::make('Multiple files', 'multiple_files')
    ->customPropertiesFields([
        Boolean::make('Active'),
        Markdown::make('Description'),
    ]);
    
// custom properties without user input
Files::make('Multiple files', 'multiple_files')
    ->customProperties([
        'foo' => auth()->user()->foo,
        'bar' => $api->getNeededData(),
    ]);

显示图像统计数据(大小、尺寸、类型)

Image statistics

Images::make('Gallery')
    ->showStatistics();

自定义头信息

Images::make('Gallery')
    ->customHeaders([
        'header-name' => 'header-value', 
    ]);

媒体字段(视频)

为了处理带有缩略图的视频,您需要使用Media字段而不是Images。这样,您就可以上传视频。

use Workup\AdvancedNovaMediaLibrary\Fields\Media;

class Category extends Resource
{
    public function fields(Request $request)
    {
        Media::make('Gallery') // media handles videos
            ->conversionOnIndexView('thumb')
            ->singleMediaRules('max:5000'); // max 5000kb
    }
}

// ..

class YourModel extends Model implements HasMedia
{
    public function registerMediaConversions(Media $media = null): void
    {
        $this->addMediaConversion('thumb')
            ->width(368)
            ->height(232)
            ->extractVideoFrameAtSecond(1);
    }
}

临时URL

如果您使用Amazon S3存储媒体,您需要使用字段的temporary函数来生成临时签名URL。此函数期望一个有效的Carbon实例,该实例将指定URL何时过期。

Images::make('Image 1', 'img1')
    ->temporary(now()->addMinutes(5))

Files::make('Multiple files', 'multiple_files')
    ->temporary(now()->addMinutes(10),

注意:此功能与现有媒体功能不兼容。

鸣谢

替代方案

变更日志

v4.0.2 - 2022-04-26

  • 修复Nova 4中的裁剪比例。现在从Images::( ... )>croppingConfigs()传递到裁剪器的stencil-props属性。有关可用的属性更多详细信息,请参阅裁剪器文档

v4.0.1 - 2022-04-20

  • 修复详情组件
  • 修复布局不一致性

v4.0.0 - 2022-04-18

  • 升级以支持Laravel Nova 4
  • 与Laravel Nova 1、2和3不兼容。对于这些nova版本,请使用v3.*
  • vuejs-clipper替换为vue-advanced-cropper以支持vue3

完整变更日志请参阅PR #317

如何贡献

  • 当然,您需要在Laravel应用程序中安装Nova
  • 直接在vendor目录中的包中工作(webpack需要安装Nova)
  • 然后从vendor/xxx/advanced-nova-media-library文件夹开始
    • 至少使用nvm use 14
    • 运行yarn install
    • 运行yarn run watch
    • 努力工作 🤘
    • 当工作完成后,运行yarn npm production
    • 提交PR