class DrupalMediaLibrary

Same name in other branches
  1. 8.9.x core/modules/media_library/src/Plugin/CKEditorPlugin/DrupalMediaLibrary.php \Drupal\media_library\Plugin\CKEditorPlugin\DrupalMediaLibrary

Defines the "drupalmedialibrary" plugin.

@CKEditorPlugin( id = "drupalmedialibrary", label = @Translation("Embed media from the Media Library"), provider = "media_library", )

@internal Plugin classes are internal.

Hierarchy

Expanded class hierarchy of DrupalMediaLibrary

5 string references to 'DrupalMediaLibrary'
ckeditor_filter_format_edit_form_validate in core/modules/ckeditor/ckeditor.module
Validate callback to ensure the DrupalMediaLibrary button can work correctly.
Core::mapCKEditor4ToolbarButtonToCKEditor5ToolbarItem in core/modules/ckeditor5/src/Plugin/CKEditor4To5Upgrade/Core.php
Maps a CKEditor 4 button to the CKEditor 5 equivalent, if it exists.
MediaLibraryTest::testAllowedMediaTypes in core/modules/ckeditor/tests/src/FunctionalJavascript/MediaLibraryTest.php
Tests the allowed media types setting on the MediaEmbed filter.
MediaLibraryTest::testButton in core/modules/ckeditor/tests/src/FunctionalJavascript/MediaLibraryTest.php
Tests using DrupalMediaLibrary button to embed media into CKEditor.
SmartDefaultSettingsTest::setUp in core/modules/ckeditor5/tests/src/Kernel/SmartDefaultSettingsTest.php

File

core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalMediaLibrary.php, line 27

Namespace

Drupal\ckeditor\Plugin\CKEditorPlugin
View source
class DrupalMediaLibrary extends CKEditorPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The module extension list.
     *
     * @var \Drupal\Core\Extension\ModuleExtensionList
     */
    protected $moduleExtensionList;
    
    /**
     * The media type entity storage.
     *
     * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
     */
    protected $mediaTypeStorage;
    
    /**
     * Constructs a new DrupalMediaLibrary plugin object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param array $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
     *   The module extension list.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(array $configuration, $plugin_id, array $plugin_definition, ModuleExtensionList $extension_list_module, EntityTypeManagerInterface $entity_type_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->moduleExtensionList = $extension_list_module;
        $this->mediaTypeStorage = $entity_type_manager->getStorage('media_type');
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('extension.list.module'), $container->get('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function isInternal() {
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDependencies(Editor $editor) {
        return [
            'drupalmedia',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLibraries(Editor $editor) {
        return [
            'editor/drupal.editor.dialog',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFile() {
        return $this->moduleExtensionList
            ->getPath('ckeditor') . '/js/plugins/drupalmedialibrary/plugin.js';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfig(Editor $editor) {
        // If the editor has not been saved yet, we may not be able to create a
        // coherent MediaLibraryState object, which is needed in order to generate
        // the required configuration. But, if we're creating a new editor, we don't
        // need to do that anyway, so just return an empty array.
        if ($editor->isNew()) {
            return [];
        }
        $media_type_ids = $this->mediaTypeStorage
            ->getQuery()
            ->execute();
        if ($editor->hasAssociatedFilterFormat()) {
            if ($media_embed_filter = $editor->getFilterFormat()
                ->filters()
                ->get('media_embed')) {
                // Optionally limit the allowed media types based on the MediaEmbed
                // setting. If the setting is empty, do not limit the options.
                if (!empty($media_embed_filter->settings['allowed_media_types'])) {
                    $media_type_ids = array_intersect_key($media_type_ids, $media_embed_filter->settings['allowed_media_types']);
                }
            }
        }
        if (in_array('image', $media_type_ids, TRUE)) {
            // Due to a bug where the active item styling and the focus styling
            // create the visual appearance of two active items, we'll move
            // the 'image' media type to first position, so that the focused item and
            // the active item are the same.
            // This workaround can be removed once this issue is fixed:
            // @see https://www.drupal.org/project/drupal/issues/3073799
            array_unshift($media_type_ids, 'image');
            $media_type_ids = array_unique($media_type_ids);
        }
        $state = MediaLibraryState::create('media_library.opener.editor', $media_type_ids, reset($media_type_ids), 1, [
            'filter_format_id' => $editor->getFilterFormat()
                ->id(),
        ]);
        return [
            'DrupalMediaLibrary_url' => Url::fromRoute('media_library.ui')->setOption('query', $state->all())
                ->toString(TRUE)
                ->getGeneratedUrl(),
            'DrupalMediaLibrary_dialogOptions' => MediaLibraryUiBuilder::dialogOptions(),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getButtons() {
        return [
            'DrupalMediaLibrary' => [
                'label' => $this->t('Insert from Media Library'),
                'image' => $this->moduleExtensionList
                    ->getPath('ckeditor') . '/js/plugins/drupalmedialibrary/icons/drupalmedialibrary.png',
            ],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CKEditorPluginBase::$moduleList protected property The module list service.
CKEditorPluginBase::getModuleList protected function Gets the module list service.
CKEditorPluginBase::getModulePath protected function Gets the Drupal-root relative installation directory of a module.
DrupalMediaLibrary::$mediaTypeStorage protected property The media type entity storage.
DrupalMediaLibrary::$moduleExtensionList protected property The module extension list.
DrupalMediaLibrary::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DrupalMediaLibrary::getButtons public function Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
DrupalMediaLibrary::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
DrupalMediaLibrary::getDependencies public function Returns a list of plugins this plugin requires. Overrides CKEditorPluginBase::getDependencies
DrupalMediaLibrary::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
DrupalMediaLibrary::getLibraries public function Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries
DrupalMediaLibrary::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginBase::isInternal
DrupalMediaLibrary::__construct public function Constructs a new DrupalMediaLibrary plugin object.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.