imnpc / laravel-ueditor
Laravel 的 UEditor 集成。
2.0.3
2022-03-15 06:04 UTC
Requires
- laravel/framework: ~5.5|~6.0|~7.0|~8.0|~9.0
Requires (Dev)
- fabpot/php-cs-fixer: ^1.10
Suggests
- overtrue/laravel-filesystem-qiniu: 如果你想要使用七牛云存储,也许你需要安装它哦~
README
Laravel 5 的 UEditor 集成。
安装
$ composer require "codingyu/laravel-ueditor:~2.0"
配置
-
发布配置文件与资源
$ php artisan vendor:publish --provider='Codingyu\LaravelUEditor\UEditorServiceProvider'
-
模板引入编辑器
这行的作用是引入编辑器需要的 css,js 等文件,因此你不需要手动引入它们。
@include('vendor.ueditor.assets')
-
编辑器的初始化
<!-- 实例化编辑器 --> <script type="text/javascript"> var ue = UE.getEditor('container'); ue.ready(function() { ue.execCommand('serverparam', '_token', '{{ csrf_token() }}'); // 设置 CSRF token. }); </script> <!-- 编辑器容器 --> <script id="container" name="content" type="text/plain"></script>
说明
- 5.4+ 版本请勿忘记执行
php artisan storage:link
- 当
config/ueditor.php
中的disk
配置为'public'
时,上传路径为:public/uploads/
,请确保该目录存在并可写。 - 如果需要修改上传路径,请在
config/ueditor.php
中配置各种类型的上传路径,但都在 public 目录下。 - 请在
.env
文件中正确配置APP_URL
为你的当前域名,否则即使上传成功,也可能无法正确显示。
七牛云存储支持
如果你想使用七牛云存储,需要进行以下简单操作:
1. 安装和配置 laravel-filesystem-qiniu
2. 将 config/ueditor.php
中的 disk
配置为 qiniu
'disk' => 'qiniu'
3. 剩余时间可以玩玩英雄联盟,这样就完成了。
七牛的
access_key
和secret_key
可以在这里找到:https://portal.qiniu.com/user/key。在创建bucket
(空间)时,建议使用公开的空间。
事件
你肯定有一些朋友会遇到一些特殊的场景,那么你可以使用本插件提供的事件来支持:
请按照 Laravel 事件的文档来使用: https://laravel.net.cn/docs/5.4/events#registering-events-and-listeners
上传中事件
Codingyu\LaravelUEditor\Events\Uploading
在保存文件之前,你可以获取以下信息:
$event->file
这是请求的已上传文件对象,Symfony\Component\HttpFoundation\File\UploadedFile
实例。$event->filename
这是即将存储时使用的新文件名$event->config
上传配置,数组。
你可以在本事件监听器返回值,返回值将替换 $filename
作为存储文件名。
上传完成事件
Codingyu\LaravelUEditor\Events\Uploaded
它有两个属性:
-
$event->file
与 Uploading 一样,上传的文件 -
$event->result
上传结果,数组,包含以下信息:'state' => 'SUCCESS', 'url' => 'http://xxxxxx.qiniucdn.com/xxx/xxx.jpg', 'title' => '文件名.jpg', 'original' => '上传时的源文件名.jpg', 'type' => 'jpg', 'size' => 17283,
你可以监听此事件用于一些后续处理任务,比如记录到数据库。
许可协议
MIT