a2nt / silverstripe-dropzone
为CMS和前端表单提供的HTML5上传字段。
Requires
README
使用理智上传。
简介
Dropzone模块提供了FileAttachmentField
,为SilverStripe提供了一个强大的HTML5上传界面,允许表单将文件上传保存到DataObject
实例。
功能
- 前端或CMS中,使用一个统一的界面进行上传
- 拖放上传
- 自动客户端缩略图生成
- 网格视图/列表视图
- 上传进度
- 限制文件数量、文件大小、文件类型
- 移除/删除文件的权限
- 跟踪文件(删除未附加到任何内容的上传文件)
- 无jQuery依赖
屏幕截图
网格视图
列表视图
移除/删除文件
优雅的错误处理
您喜欢的任何缩略图大小
使用方法
该字段实例化类似于UploadField
,取文件关系的名称和标签作为前两个参数。一旦实例化,就有许多方法可以配置UI。
FileAttachmentField::create('MyFile', 'Upload a file') ->setView('grid')
如果包含上传字段的表单绑定到一个记录(即使用loadDataFrom()
),那么如果关系是has_many
或many_many
,上传字段将自动允许多个文件。如果表单未绑定到记录,则可以使用setMultiple(true)
。
可以使用imagesOnly()
方法强制只上传图像。如果表单绑定到一个记录,并且关系指向一个Image
类,这将被自动设置。
更高级的选项
FileAttachmentField::create('MyFiles', 'Upload some files') ->setThumbnailHeight(180) ->setThumbnailWidth(180) ->setAutoProcessQueue(false) // do not upload files until user clicks an upload button ->setMaxFilesize(10) // 10 megabytes. Defaults to PHP's upload_max_filesize ini setting ->setAcceptedFiles(array('.pdf','.doc','.docx')) ->setPermissions(array( 'delete' => false, 'detach' => function () { return Member::currentUser() && Member::currentUser()->inGroup('editors'); } ));
图像上传获得一些额外的选项。
FileAttachmentField::create('MyImage','Upload an image') ->imagesOnly() // If bound to a record, with a relation to 'Image', this isn't necessary. ->setMaxResolution(50000000); // Do not accept images over 5 megapixels
默认设置
大多数设置的默认值可以在模块包含的config.yml
文件中找到。
在CMS中使用
FileAttachmentField
可以用作CMS中UploadField
的替代品。
以编程方式与Dropzone界面交互
对于自定义集成,您可能想访问管理上传UI的UploadInterface
对象(请参阅file_attachment_field.js
)。您可以通过以下两种方式之一进行
- 如果您已安装jQuery,只需访问
.dropzone
元素的dropzoneInterface
数据属性
$('#MyFileDropzone').data('dropzoneInterface').clear();
- 如果您没有使用jQuery,则
UploadInterface
对象注入到浏览器全局的window.dropzones
中,按.dropzone
元素的ID索引。
window.dropzones.MyFileDropzone.clear();
注意:默认情况下,实际的.dropzone
元素的ID是表单输入的名称,并在其后附加“Dropzone”,所以FileAttachmentField::create('MyFile')
创建一个ID为'MyFileDropzone'的dropzone
跟踪/删除未使用的文件上传
FileAttachmentField::create('MyImage','Upload an image') ->setTrackFiles(true)
或者
FileAttachmentField: track_files: true
为了防止用户通过前端上传大量文件并填满服务器的硬盘,您可以在记录中跟踪每个文件上传,然后在表单使用Form::saveInto($record)
保存时将其删除。
如果您不使用Form::saveInto
,您将需要手动取消跟踪文件ID
FileAttachmentFieldTrack::untrack($data['MyImageID']);
要执行所有跟踪文件的删除,您可以运行FileAttachmentFieldCleanTask
。
故障排除
- 当使用
FileAttachmentField
与BootstrapForm
时,请确保将其从bootstrap转换中忽略。
呼叫Uncle Cheese。