README

此仓库包含 CKFinder 3 包用于 Symfony 6+。如果您正在寻找旧版 Symfony 的包，请使用版本 3。

安装

添加 Composer 依赖并安装包。

composer require ckfinder/ckfinder-symfony-bundle

运行以下命令下载 CKFinder 发行包。

安装包后，您需要下载 CKFinder 发行包。由于不同的许可条款，它不包括在包中。要安装它，请运行以下 Symfony 命令
```
php bin/console ckfinder:download
```
它将下载代码并将其放置在包的 Resource/public 目录中。之后，您还可以安装资产，这样公共目录将更新为 CKFinder 代码。
```
php bin/console assets:install
```

启用包路由。

创建 config/routes/ckfinder.yaml，内容如下

# config/routes/ckfinder.yaml

ckfinder_connector:
    resource: "@CKSourceCKFinderBundle/Resources/config/routing.yml"
    prefix:   /

为 CKFinder 文件创建一个目录并允许写入访问。默认情况下，CKFinder 期望它位于 <public folder>/userfiles（可以在配置中更改此位置）。
```
mkdir -m 777 public/userfiles
```
注意：由于通常设置权限为 0777 是不安全的，建议将目录的所有权更改为与 Apache 相同的用户，并添加组写权限。如有任何疑问，请联系系统管理员。

此时，您应该在导航到 /ckfinder/connector?command=Init 路由后看到连接器 JSON 响应。CKFinder 的身份验证尚未配置，因此您将看到一个错误响应，表明 CKFinder 未启用。

配置身份验证

CKFinder 连接器身份验证由 ckfinder.connector.auth 服务管理，默认情况下在 CKSourceCKFinderBundle\Authentication\Authentication 类中定义。它包含一个 authenticate 方法，该方法应返回一个布尔值以决定用户是否应访问 CKFinder。如您所见，默认服务实现并不完整，在 authenticate 方法中简单地返回 false，但您可以将它作为一个有用的起始代码。

要为 CKFinder 连接器配置身份验证，您需要创建一个实现 CKSource\Bundle\CKFinderBundle\Authentication\AuthenticationInterface 的类，并将 CKFinder 连接器指向它。

一个基本实现，从 authenticate 方法返回 true（显然不安全）可以看起来如下

// src/CustomCKFinderAuth/CustomCKFinderAuth.php

namespace App\CustomCKFinderAuth;

use CKSource\Bundle\CKFinderBundle\Authentication\Authentication as AuthenticationBase;

class CustomCKFinderAuth extends AuthenticationBase
{
    public function authenticate(): bool
    {
        return true;
    }
}

您可能已经注意到 AuthenticationInterface 扩展了 ContainerAwareInterface，因此您可以从身份验证类的作用域访问服务容器。

当您的自定义身份验证准备就绪时，您需要告诉 CKFinder 连接器开始使用它。为此，请向配置中添加以下选项

创建 config/packages/ckfinder.yaml 文件

# config/packages/ckfinder.yaml

ckfinder:
    connector:
        authenticationClass: App\CustomCKFinderAuth\CustomCKFinderAuth

配置选项

默认的 CKFinder 连接器配置来自 @CKSourceCKFinder/Resources/config/ckfinder_config.php 文件。多亏了 Symfony 配置合并机制，您有多种方法可以覆盖它。默认配置以常规 PHP 文件的形式提供，但您可以使用您喜欢的格式（YAML、XML），只要结构有效即可。

覆盖默认配置的最简单方法是，将ckfinder_config.php文件复制到您的应用程序配置目录中，然后在主配置文件中导入它。

# config/packages/ckfinder.yaml

imports:
    - { resource: ckfinder_config.php }
    
...

从现在开始，所有连接器配置选项都将从复制的ckfinder_config.php中获取。

配置CKFinder的另一种方法是，在配置文件中的ckfinder节点下直接包含所需选项。

# config/packages/ckfinder.yaml

ckfinder:
    connector:
        licenseName: LICENSE-NAME
        licenseKey: LICENSE-KEY
        authenticationClass: AppBundle\CustomCKFinderAuth\CustomCKFinderAuth

        resourceTypes:
            MyResource:
                name: MyResource
                backend: default
                directory: myResource

注意：所有未定义的选项将从默认配置文件中获取。

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

CKFinder捆绑包提供了两个额外选项

authenticationClass – CKFinder身份验证服务类名（默认为CKSource\Bundle\CKFinderBundle\Authentication\Authentication）
connectorClass – CKFinder连接器服务类名（默认为CKSource\CKFinder\CKFinder）

使用方法

捆绑包代码包含一些使用示例，您可能觉得它们很有用。要启用它们，请在@CKSourceCKFinder/Resources/config/routing.yml中取消注释ckfinder_examples路由。

ckfinder_examples:
    pattern:     /ckfinder/examples/{example}
    defaults: { _controller: CKSource\Bundle\CKFinderBundle\Controller::examplesAction, example: null }

之后，您可以通过/ckfinder/examples路径导航并查看可用示例列表。要了解其背后的代码，请查看CKFinderController类（CKSourceCKFinderBundle::Controller/CKFinderController.php）。

在模板中包含主CKFinder JavaScript文件

在模板中包含ckfinder.js的首选方法是在其中包含CKFinder设置模板，如下所示

{% include "@CKSourceCKFinder/setup.html.twig" %}

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

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

CKFinder文件选择器

捆绑包注册了一个表单字段类型——CKFinderFileChooserType——它允许将CKFinder轻松集成到您的表单中作为文件选择器。在CKFinder中选择文件后，相应的输入字段将自动填充文件URL。您可以在/ckfinder/examples/filechooser路径下查看一个工作示例。

文件选择器字段基于常规的text类型，因此它继承了所有配置选项。它还提供了一些自定义选项

一个简单的使用示例可能如下所示

$form = $this->createFormBuilder()
             ->add('file_chooser1', CKFinderFileChooserType::class, [
                 'label' => 'Photo',
                 'button_text' => 'Browse photos',
                 'button_attr' => [
                     'class' => 'my-fancy-class'
                 ]
             ])
             ->getForm();

注意：要在您的表单中使用CKFinder文件选择器，您仍然需要在模板中包含主CKFinder JavaScript文件（见在模板中包含主CKFinder JavaScript文件）。

ckfinder / ckfinder-symfony-bundle

维护者

详细信息