Yii2 Redactor 教程：安装与配置

Yii2 Redactor 教程：安装与配置

1. 项目目录结构及介绍

Yii2 Redactor 扩展的目录结构如下：

yii2-redactor/
|-- assets/                # 存放相关的静态资源文件
|   |-- ...
|-- CHANGELOG.md          # 更新日志
|-- composer.json         # Composer 配置文件
|-- README.md             # 项目说明文档
|-- src/                   # 主要代码库
|   |-- widgets/           # 包含 Redactor 组件
|       |-- Redactor.php    # Redactor 组件类
|-- tests/                 # 测试相关文件
|   |-- ...

• assets/: 存放 Redactor 的前端资源。
• src/widgets/Redactor.php: Redactor 组件的 PHP 类，用于在视图中集成 Redactor。
• composer.json: 描述项目的元数据以及依赖关系。
• README.md: 提供了项目的基本信息和使用指南。

2. 项目的启动文件介绍

在 Yii2 中，通常我们不会直接修改或交互于扩展的启动文件，因为它们是作为库使用的。然而，当你在应用中引入 Redactor 扩展时，你需要在你的配置文件(config/web.php)中注册 AssetBundle 来加载 Redactor 的前端资源。

例如，添加以下代码到你的视图布局文件（如 views/layouts/main.php）:

use yii\web\JqueryAsset;
use yii\redactor\widgets\Redactor;

// ...

/**
* 在 body 标签之前加载 Redactor 的 HTML 编辑器
*/
echo Redactor::widget([
    'name' => 'body',
    'options' => [
        'lang' => 'zh', // 设置语言，这里假设为简体中文
        'plugins' => ['clips', 'fontcolor'], // 激活插件
    ],
    'settings' => [], // 可选的额外设置，如上传路径等
]);

这段代码会在页面中创建一个基于 Redactor 的文本编辑器实例。

3. 项目的配置文件介绍

在 Yii2 中，Redactor 的配置主要通过在应用配置中定义 components 和 params 来完成。具体配置项可能包括数据库连接、上传路径、客户端选项等。以下是一个示例配置：

// config/web.php 或其他配置文件
return [
    // ...
    'components' => [
        'assetManager' => [
            'appendTimestamp' => true, // 添加时间戳以防止缓存
        ],
        'redactorConfig' => [ // 定义 Redactor 的全局配置
            'uploadPath' => '@webroot/uploads/redactor', // 上传文件的相对路径
            'uploadUrl' => '@web/uploads/redactor', // 上传文件的 URL
            'imageManagerJson' => '/redactor/upload/image-json', // 图片管理器的 JSON 路径
            'imageUpload' => '/redactor/upload/image', // 图片上传的 URL
            'fileUpload' => '/redactor/upload/file', // 文件上传的 URL
            // 更多选项...
        ],
    ],
    'params' => [
        'redactorPlugins' => ['clips', 'fontcolor'], // 要启用的 Redactor 插件
    ],
];

然后，在视图中的 Redactor 组件配置中，你可以引用这些全局设置：

// 视图文件
echo Redactor::widget([
    'name' => 'body',
    'settings' => Yii::$app->redactorConfig, // 使用全局配置
    'plugins' => Yii::$app->params['redactorPlugins'], // 引用启用的插件列表
]);

这使得你可以在不影响整个应用的情况下，为特定 Redactor 实例定制配置。