class DrupalMedia

Same name in other branches
  1. 9 core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalMedia.php \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalMedia

Defines the "drupalmedia" plugin.

@CKEditorPlugin( id = "drupalmedia", label = @Translation("Media Embed"), )

@internal This is an internal part of the media system in Drupal core and may be subject to change in minor releases. This class should not be instantiated or extended by external code.

Hierarchy

Expanded class hierarchy of DrupalMedia

1 string reference to 'DrupalMedia'
DrupalMediaLibrary::getDependencies in core/modules/media_library/src/Plugin/CKEditorPlugin/DrupalMediaLibrary.php
Returns a list of plugins this plugin requires.

File

core/modules/media/src/Plugin/CKEditorPlugin/DrupalMedia.php, line 26

Namespace

Drupal\media\Plugin\CKEditorPlugin
View source 
class DrupalMedia extends PluginBase implements ContainerFactoryPluginInterface, CKEditorPluginContextualInterface, CKEditorPluginCssInterface {
    
    /**
     * The module extension list.
     *
     * @var \Drupal\Core\Extension\ModuleExtensionList
     */
    protected $moduleExtensionList;
    
    /**
     * Constructs a new DrupalMedia 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.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleExtensionList $extension_list_module) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->moduleExtensionList = $extension_list_module;
    }
    
    /**
     * {@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'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function isInternal() {
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDependencies(Editor $editor) {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLibraries(Editor $editor) {
        return [
            'core/jquery',
            'core/drupal',
            'core/drupal.ajax',
            'media/media_embed_ckeditor_theme',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFile() {
        return $this->moduleExtensionList
            ->getPath('media') . '/js/plugins/drupalmedia/plugin.js';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfig(Editor $editor) {
        return [
            'drupalMedia_previewCsrfToken' => \Drupal::csrfToken()->get('X-Drupal-MediaPreview-CSRF-Token'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function isEnabled(Editor $editor) {
        if (!$editor->hasAssociatedFilterFormat()) {
            return FALSE;
        }
        // Automatically enable this plugin if the text format associated with this
        // text editor uses the media_embed filter.
        $filters = $editor->getFilterFormat()
            ->filters();
        return $filters->has('media_embed') && $filters->get('media_embed')->status;
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo Improve this in https://www.drupal.org/project/drupal/issues/3072063
     */
    public function getCssFiles(Editor $editor) {
        return [
            $this->moduleExtensionList
                ->getPath('media') . '/css/plugins/drupalmedia/ckeditor.drupalmedia.css',
            $this->moduleExtensionList
                ->getPath('system') . '/css/components/hidden.module.css',
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DrupalMedia::$moduleExtensionList protected property The module extension list.
DrupalMedia::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DrupalMedia::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
DrupalMedia::getCssFiles public function @todo Improve this in https://www.drupal.org/project/drupal/issues/3072063 Overrides CKEditorPluginCssInterface::getCssFiles
DrupalMedia::getDependencies public function Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
DrupalMedia::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
DrupalMedia::getLibraries public function Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries
DrupalMedia::isEnabled public function Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
DrupalMedia::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal
DrupalMedia::__construct public function Constructs a new DrupalMedia 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.