barryvdh/laravel-elfinder

一个用于集成elFinder 2的Laravel包

v0.5.3 2024-03-09 08:05 UTC

README

对于Laravel 8.x及更早版本,请使用最新0.4版本。

Packagist License Latest Stable Version Total Downloads

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

注意:为了未来的更改,请使用php artisan elfinder:publish代替旧的发布命令!

image

安装

使用Composer要求此包

composer require barryvdh/laravel-elfinder

您需要使用以下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中,您可以更改默认文件夹、访问回调或定义自己的根目录。

视图

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

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

使用文件系统磁盘

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

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

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

您可以为提供额外选项的数组,例如URL、别名等。请查看这里以获取所有选项。如果您不提供URL,则URL将由磁盘本身生成。

使用Glide处理图像

有关Glide的使用,请参阅elfinder-flysystem-driver。以下是一个使用自定义Laravel磁盘和Glide的基本示例

  1. 将磁盘添加到您的应用程序配置/filesystems disks

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

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

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

    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 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 属性。