Sonata Extra Bundle : médiathèque pour CKEditor

Introduction

Une configuration appropriée de CKEditor est essentielle pour son fonctionnement optimal. Ce guide fournit les étapes pour installer une version valide de CKEditor et la configurer pour utiliser la bibliothèque Média dans un projet Sonata.

Installation

Résolution de l'erreur de clé de licence LTS invalide

Si vous rencontrez l'erreur suivante :

[CKEDITOR] For more information about this error go to https://ckeditor.com/docs/ckeditor4/latest/guide/dev_errors.html#invalid-lts-license-key

Installez la version spécifiée de CKEditor :

php php php bin/console ckeditor:install --tag=4.19.0
php bin/console assets:install

Configuration pour la bibliothèque multimédia

Pour intégrer la bibliothèque multimédia avec CKEditor, vous devez spécifier filebrowserBrowseRoute et filebrowserImageBrowseRoute. Utilisez la route sonata_extra_ckeditor_media_browser à cet effet.

Voici un exemple de configuration :

fos_ck_editor:
    default_config: default
    base_path: "build/ckeditor"
    js_path:   "build/ckeditor/ckeditor.js"
    configs:
        default:
            language: fr
            # default toolbar plus Format button
            toolbar:
                - [Bold, Italic, Underline, -, Cut, Copy, Paste,
                   PasteText, PasteFromWord, -, Undo, Redo, -,
                   NumberedList, BulletedList, -, Outdent, Indent, -,
                   Blockquote, -, Image, Link, Unlink, Table]
                - [Format, Maximize, Source]

            enterMode: CKEDITOR.ENTER_BR
            filebrowserBrowseRoute: sonata_extra_ckeditor_media_browser
            filebrowserImageBrowseRoute: sonata_extra_ckeditor_media_browser

Adapter l’exemple à la version installée

Les exemples Symfony et Sonata restent attachés aux versions indiquées dans l’article. Symfony 4.x et Symfony 6.2 ne sont plus maintenus : pour un projet actuel, utilisez une branche maintenue et la documentation correspondant exactement à vos dépendances.

php bin/console about
composer show symfony/framework-bundle sonata-project/admin-bundle

Avant de reprendre le code, contrôlez les signatures, les services, les routes et les templates concernés. Ajoutez ensuite un test fonctionnel couvrant les autorisations, le code HTTP et le résultat visible.

Référence : versions Symfony maintenues.