Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.57 KB

install.md

File metadata and controls

76 lines (57 loc) · 2.57 KB

Installation

If not already done, install and configure SonataMediaBundle.

Then, use Composer to install CoopTilleulsCKEditorSonataMediaBundle and FOSCKEditorBundle:

composer require tilleuls/ckeditor-sonata-media-bundle friendsofsymfony/ckeditor-bundle

Register the bundle in your bundles.php:

// config/bundles.php

return [
    // ...
    CoopTilleuls\Bundle\CKEditorSonataMediaBundle\CoopTilleulsCKEditorSonataMediaBundle::class => ['all' => true],
    FOS\CKEditorBundle\FOSCKEditorBundle::class => ['all' => true],
    // ...
];

Install bundles:

$ composer update

Add form theme to render the editor:

# config/packages/twig.yaml

twig:
    form_themes:
        - '@FOSCKEditor/Form/ckeditor_widget.html.twig'

Configure FOSCKEditorBundle to use the bundle as file browser:

# config/packages/fos_ck_editor.yaml

fos_ck_editor:
    default_config: default
    configs:
        default:
            filebrowserBrowseRoute: admin_sonata_media_media_browser
            filebrowserImageBrowseRoute: admin_sonata_media_media_browser
            # Display images by default when clicking the image dialog browse button
            filebrowserImageBrowseRouteParameters:
                provider: sonata.media.provider.image
            filebrowserUploadRoute: admin_sonata_media_media_upload
            filebrowserUploadRouteParameters:
                provider: sonata.media.provider.file
            # Upload file as image when sending a file from the image dialog
            filebrowserImageUploadRoute: admin_sonata_media_media_upload
            filebrowserImageUploadRouteParameters:
                provider: sonata.media.provider.image
                context: my-context # Optional, to upload in a custom context

Extending SonataMedia

# Symfony 3
php app/console sonata:easy-extends:generate --dest=src SonataMediaBundle
# Symfony 4
php bin/console sonata:easy-extends:generate --dest=src SonataMediaBundle

If you want to customize MediaAdminController you must extend CoopTilleuls\Bundle\CKEditorSonataMediaBundle\Controller\MediaAdminController in your bundle, and set parameter sonata.media.admin.media.controller to match your controller.

Usage without FOSCKEditorBundle

This bundle can be used with a custom installation of CKEditor. Read the file browser (uploader) doc of CKEditor and the architecture of this bundle.