README

Laravel 5.5 / 5.7的CKFinder 3包

此仓库包含Laravel 5.5+的CKFinder 3包。

安装

添加Composer依赖并安装包。

composer require ckfinder/ckfinder-laravel-package

运行命令下载CKFinder代码。

安装Laravel包后，您需要下载CKFinder代码。由于许可证条款不同，它不包含在包中。要安装它，请运行以下artisan命令
```
php artisan ckfinder:download
```
它将下载所需的代码并将其放置在包的适当目录中（vendor/ckfinder/ckfinder-laravel-package/）。
发布CKFinder连接器配置和资源。
```
php artisan vendor:publish --tag=ckfinder-assets --tag=ckfinder-config
```
这将把CKFinder资源发布到public/js/ckfinder，并将CKFinder连接器配置发布到config/ckfinder.php。

如果您需要自定义路由名称、不同的资源位置、文件浏览器定制等，您还可以发布此包使用的视图。
```
php artisan vendor:publish --tag=ckfinder-views
```
最后，您可以使用一个命令仅发布包的配置、资源和视图。
```
php artisan vendor:publish --tag=ckfinder
```
为CKFinder文件创建一个目录并允许对其写入访问。默认情况下，CKFinder期望文件位于public/userfiles（此可以在配置中更改）。
```
mkdir -m 777 public/userfiles
```
注意：由于通常将权限设置为0777是不安全的，建议将目录的组所有权更改为与Apache相同的用户，并添加组写入权限。如果有任何疑问，请联系您的系统管理员。

CKFinder默认使用基于双重提交cookie的CSRF保护机制。在某些配置中可能需要配置Laravel不加密CKFinder设置的cookie。

为此，请将cookie名称ckCsrfToken添加到EncryptCookies中间件的$except属性中

// app/Http/Middleware/EncryptCookies.php

namespace App\Http\Middleware;

use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;

class EncryptCookies extends Middleware
{
    /**
     * The names of the cookies that should not be encrypted.
     *
     * @var array
     */
    protected $except = [
        'ckCsrfToken',
        // ...
    ];
}

您还应禁用Laravel的CSRF保护以CKFinder的路径，因为CKFinder使用其自己的CSRF保护机制。这可以通过将ckfinder/*模式添加到VerifyCsrfToken中间件的$except属性中完成：（app/Http/Middleware/VerifyCsrfToken.php）

// app/Http/Middleware/VerifyCsrfToken.php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

class VerifyCsrfToken extends Middleware
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array
     */
    protected $except = [
        'ckfinder/*',
        // ...
    ];
}

此时，您应该在导航到<APP BASE URL>/ckfinder/connector?command=Init地址后看到连接器JSON响应。CKFinder的认证尚未配置，因此您将看到错误响应，表明CKFinder未启用。

配置认证

CKFinder连接器认证由中间件类或别名处理。要创建自定义中间件类，请使用Artisan命令

php artisan make:middleware CustomCKFinderAuth

新的中间件类将出现在app/Http/Middleware/CustomCKFinderAuth.php中。在config/ckfinder.php中更改authentication选项

$config['authentication'] = '\App\Http\Middleware\CustomCKFinderAuth';

CustomCKFinderAuth类中的handle方法允许认证CKFinder用户。一个基本实现，从authentication可调用返回true（显然是不安全的），可以如下所示

public function handle($request, Closure $next)
{
    config(['ckfinder.authentication' => function() {
        return true;
    }]);
    return $next($request);
}

请参阅CKFinder for PHP 连接器文档以了解更多关于此选项的信息。

注意：另外，您可以在config/ckfinder.php中设置配置选项$config['loadRoutes'] = false;。然后，将路由从vendor/ckfinder/ckfinder-laravel-package/src/routes.php复制到您的应用程序路由，例如routes/web.php，以使用Laravel身份验证中间件来保护它们。

Route::any('/ckfinder/connector', '\CKSource\CKFinderBridge\Controller\CKFinderController@requestAction')
    ->name('ckfinder_connector');

Route::any('/ckfinder/browser', '\CKSource\CKFinderBridge\Controller\CKFinderController@browserAction')
    ->name('ckfinder_browser');

配置选项

CKFinder 连接器配置来自config/ckfinder.php文件。

要了解有关可能的连接器配置选项的更多信息，请参阅CKFinder for PHP 连接器文档。

使用方法

该包代码包含了一些可能有用的使用示例。要启用它们，取消注释vendor/ckfinder/ckfinder-laravel-package/src/routes.php中的ckfinder_examples路由。

// vendor/ckfinder/ckfinder-laravel-package/src/routes.php

Route::any('/ckfinder/examples/{example?}', 'CKSource\CKFinderBridge\Controller\CKFinderController@examplesAction')
    ->name('ckfinder_examples');

之后，您可以通过访问<APP BASE URL>/ckfinder/examples路径来查看可用示例列表。要了解其背后的代码，请检查包中的views/samples目录（vendor/ckfinder/ckfinder-laravel-package/views/samples/）。

在模板中包含主 CKFinder JavaScript 文件

要能够在网页上使用 CKFinder，您必须包含主 CKFinder JavaScript 文件。首选的方式是包含如以下所示的 CKFinder 设置模板：

@include('ckfinder::setup')

包含的模板渲染所需的script标签并配置一个有效的连接器路径。

<script type="text/javascript" src="/js/ckfinder/ckfinder.js"></script>
<script>CKFinder.config( { connectorPath: '/ckfinder/connector' } );</script>

theupriser / ckfinder-laravel-package

维护者

详细信息