dilneiss/laravel-elfinder

Laravel 包,用于集成 elFinder 2

v0.4.11 2022-02-09 01:26 UTC

README

对于 Laravel 4,请使用 0.2 分支

Packagist License Latest Stable Version Total Downloads

此包通过 Composer (+自动加载) 提供了 php 文件和通过发布命令提供资源,集成了 elFinder 2.1。它还提供了一些示例视图,包括独立、tinymce 和 ckeditor。文件从单独的 构建仓库 更新

注意:请使用 php artisan elfinder:publish 而不是旧发布命令,以进行未来的更改!

安装

使用 Composer 安装此包

composer require barryvdh/laravel-elfinder

将 ServiceProvider 添加到 app/config/app.php 中的 providers 数组

Barryvdh\Elfinder\ElfinderServiceProvider::class

您需要使用以下 artisan 命令将资源复制到 public 文件夹

php artisan elfinder:publish

请记住,每次更新后(或将命令添加到 composer.json 中的 post-update-cmd)发布资源

路由已添加到 ElfinderServiceProvider。您可以在配置中设置路由的分组参数。您可以更改路由的前缀或过滤器/中间件。如果您想进行完全自定义,可以扩展 ServiceProvider 并覆盖 map() 函数。

配置

默认配置要求在 public 文件夹中有一个名为 'files' 的目录。您可以通过发布配置文件来更改此设置。

php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=config

在您的 config/elfinder.php 中,您可以更改默认文件夹、访问回调或定义自己的根目录。

视图

您可以通过复制 resources/views 文件夹来覆盖默认视图。您也可以使用 vendor:publish 命令这样做

php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=views

使用文件系统磁盘

Laravel 5 具有使用 Flysystem 适配器作为本地/云磁盘的能力。您可以使用 disks 配置将这些磁盘添加到 elFinder。

此示例添加了 local 磁盘和 my-disk

'disks' => [
    'local',
    'my-disk' => [
        'URL' => url('to/disk'),
        'alias' => 'Local storage',
    ]
],

您可以添加一个数组来提供额外的选项,例如 URL、别名等。 查看这里 以获取所有选项。

使用 Glide 进行图片处理

请参阅 elfinder-flysystem-driver 了解 Glide 的用法。使用自定义 Laravel 磁盘和 Glide 的基本示例如下

  1. 将磁盘添加到您的 apps config/filesystems disks

    'public' => [
        'driver' => 'local',
        'root'   => base_path().'/public',
    ],

    提示:如果您想使用非默认的 Flysystem 磁盘,可以使用 extend 方法注册自己的驱动程序

  2. glide/<path> 路由上为您的磁盘创建一个 Glide 服务器,例如,使用缓存路径

    Route::get('glide/{path}', function($path){
        $server = \League\Glide\ServerFactory::create([
            'source' => app('filesystem')->disk('public')->getDriver(),
        'cache' => storage_path('glide'),
        ]);
        return $server->getImageResponse($path, Input::query());
    })->where('path', '.+');
  3. 将磁盘添加到您的 elfinder 配置中

    'disks' => [
        'public' => [
            'glideURL' => '/glide',
        ],
    ],
  4. (可选)将 glideKey 也添加到配置中,并使用 Glide HttpSignature 验证您的 glide 路由中的密钥

现在,您应该在 elFinder 中看到一个根 'public',其中包含您 public 文件夹中的文件,这些文件由 Glide 生成的缩略图。URL 也将指向 Glide 服务器,用于图像。

TinyMCE 5.x

您可以使用以下路由进行 tinyMCE 5 集成 /elfinder/tinymce5

route('elfinder.tinymce5');

在 TinyMCE 初始化代码中,添加以下行

file_picker_callback : elFinderBrowser

然后添加以下函数(将 elfinder_url 更改为您系统上的正确路径)

function elFinderBrowser (callback, value, meta) {
    tinymce.activeEditor.windowManager.openUrl({
        title: 'File Manager',
        url: elfinder_url,
        /**
         * On message will be triggered by the child window
         * 
         * @param dialogApi
         * @param details
         * @see https://www.tiny.cloud/docs/ui-components/urldialog/#configurationoptions
         */
        onMessage: function (dialogApi, details) {
            if (details.mceAction === 'fileSelected') {
                const file = details.data.file;
                
                // Make file info
                const info = file.name;
                
                // Provide file and text for the link dialog
                if (meta.filetype === 'file') {
                    callback(file.url, {text: info, title: info});
                }
                
                // Provide image and alt text for the image dialog
                if (meta.filetype === 'image') {
                    callback(file.url, {alt: info});
                }
                
                // Provide alternative source and posted for the media dialog
                if (meta.filetype === 'media') {
                    callback(file.url);
                }
                
                dialogApi.close();
            }
        }
    });
}

TinyMCE 4.x

您可以使用以下路由进行 tinyMCE 集成,默认为 /elfinder/tinymce4

route('elfinder.tinymce4');

在 TinyMCE 初始化代码中,添加以下行

file_browser_callback : elFinderBrowser

然后添加以下函数(将 elfinder_url 更改为您系统上的正确路径)

function elFinderBrowser (field_name, url, type, win) {
  tinymce.activeEditor.windowManager.open({
    file: '<?= route('elfinder.tinymce4') ?>',// use an absolute path!
    title: 'elFinder 2.0',
    width: 900,
    height: 450,
    resizable: 'yes'
  }, {
    setUrl: function (url) {
      win.document.getElementById(field_name).value = url;
    }
  });
  return false;
}

TinyMCE 3.x

您可以使用以下路由添加 tinyMCE 集成(默认:/elfinder/tinymce

route('elfinder.tinymce');

在 TinyMCE 初始化代码中,添加以下行

file_browser_callback : 'elFinderBrowser'

然后添加以下函数(将 elfinder_url 更改为您系统上的正确路径)

function elFinderBrowser (field_name, url, type, win) {
  var elfinder_url = '/elfinder/tinymce';    // use an absolute path!
  tinyMCE.activeEditor.windowManager.open({
    file: elfinder_url,
    title: 'elFinder 2.0',
    width: 900,
    height: 450,
    resizable: 'yes',
    inline: 'yes',    // This parameter only has an effect if you use the inlinepopups plugin!
    popup_css: false, // Disable TinyMCE's default popup CSS
    close_previous: 'no'
  }, {
    window: win,
    input: field_name
  });
  return false;
}

CKeditor 4.x

您可以使用以下路由添加 CKeditor 集成

'elfinder.ckeditor'

在 CKeditor 配置文件中

config.filebrowserBrowseUrl = '/elfinder/ckeditor';

独立弹出选择器

要使用href、按钮或其他元素触发弹出窗口来使用elFinder,您需要执行以下操作。

添加对弹出窗口的支持,我们使用了Jacklmoore的jQuery colorbox(不包括在内),但您可以使用任何其他库,显然需要相应地调整以下说明。

添加所需的路由

您可以使用以下操作添加弹出窗口

'Barryvdh\Elfinder\ElfinderController@showPopup'

添加所需的资源

请确保您已按照上述说明发布了此包的公共资产。然后,在您页面的 <head> 部分包含所需的colorbox样式(我们建议使用example1样式,但任何样式都可以)

<link href="/assets/css/colorbox.css" rel="stylesheet">

Colorbox依赖于jQuery,因此请确保您已在页面上包含jQuery,然后在您的jQuery文件之后,添加jQuery Colorbox的脚本,例如...

<script type="text/javascript" src="/assets/js/jquery.colorbox-min.js"></script>

现在在您的 <body> 标签关闭之前添加对弹出窗口脚本的链接。还提供了一个非最小化版本,如果您希望修改colorbox配置。只需将其复制到您的资产位置,并按需调整/最小化。

<script type="text/javascript" src="/packages/barryvdh/elfinder/js/standalonepopup.min.js"></script>

用法

为了使用查找器填充输入,只需添加您希望填充的输入,确保使用ID(这将用于在文件/图像被选择后更新值)......

<label for="feature_image">Feature Image</label>
<input type="text" id="feature_image" name="feature_image" value="">

现在只需添加您希望用于触发弹出窗口的元素,确保添加类 popup_selector 和包含与您希望填充的输入ID匹配的值的 data-inputid 属性,如下所示。

<a href="" class="popup_selector" data-inputid="feature_image">Select Image</a>

您可以在页面上放置任意数量的元素,只需确保每个元素都有唯一的ID,并相应地设置选择器的data-updateid属性。