besnovatyj/yii2-cms-ckeditor5

Кастомный редактор CKEditor 5 для Yii2 (ядро + базовый редактор + виджет). Плагины подключаются отдельными пакетами.

v1.0.0 2026-07-06 19:29 UTC

Requires

• php: >=8.4
• besnovatyj/yii2-cms-helpers: ^1.0
• yiisoft/yii2: ~2.0.0
• yiisoft/yii2-bootstrap5: ~2.0.0

MIT

• Besnovatyj

• cms
• editor
• widget
• yii2
• ckeditor5

Published on Packagist.org on 2026-07-06 19:30 UTC

README

Кастомный редактор CKEditor 5 для Yii2: ядро + базовый редактор + PHP-виджет. Плагины (filemanager, codemirror и др.) — отдельные composer-пакеты, подключаются в рантайме.

Что внутри

assets/ckeditor5.ts       # слой 1: export * from 'ckeditor5' (+css) → dist/ckeditor5.js + ckeditor5.css
assets/ckeditor-base.ts   # слой 2: BaseEditor + официальные плагины → dist/ckeditor-base.js
esbuild-ckeditor5.js      # сборка ядра (редко)
esbuild.js                # сборка base (без copy-шага и плагинов)
build-all.js              # ядро + base параллельно
src/                      # PHP (psr-4 Besnovatyj\Ckeditor5\)
  CkeditorCustomWidget.php           # виджет: import map + мульти-бандл-склейка
  CkeditorCoreAsset.php              # публикует ckeditor5.js/.css, ckeditor-base.js
  contracts/CkeditorPluginAssetInterface.php  # контракт дескриптора плагина
dist/                     # собранные ядро+base (КОММИТИТСЯ — потребляется без Node)

Сборка TS (нужен Node/Docker)

npm install
npm run build-ckeditor5   # ядро (редко — при смене версии ckeditor5)
npm run build-base        # базовый редактор
npm run build-all         # оба

dist/ коммитится в git. Потребляющий проект Node не использует.

Как подключаются плагины

Каждый плагин = отдельный composer-пакет со своим AssetBundle, реализующим CkeditorPluginAssetInterface (см. besnovatyj/ckeditor5-filemanager, besnovatyj/ckeditor5-codemirror). Список плагинов передаётся виджету через свойство $plugins (массив Asset-классов). Сам пакет редактора о плагинах не знает — их подключает потребитель (обычно модуль yii2-cms-file через DIC).

echo CkeditorCustomWidget::widget([
    'model' => $model,
    'attribute' => 'content',
    'plugins' => [
        \Besnovatyj\CkeditorFileManager\FileManagerCkeditorAsset::class,
        \Besnovatyj\CkeditorCodeMirror\CodeMirrorCkeditorAsset::class,
    ],
]);

В браузере виджет:

1. Выводит import map {"ckeditor5": "<baseUrl>/ckeditor5.js"} (один раз на страницу) — единственный экземпляр классов CKEditor (рабочий instanceof Plugin).
2. Динамически грузит ckeditor-base.js и модули всех плагинов (каждый из своего baseUrl).
3. Склеивает CustomEditor.builtinPlugins = [...base, ...плагины] и создаёт редактор.

Обновление плагина = bump его composer-пакета. Редактор пересобирать не нужно.