class DrupalMedia
Same name in other branches
- 8.9.x core/modules/media/src/Plugin/CKEditorPlugin/DrupalMedia.php \Drupal\media\Plugin\CKEditorPlugin\DrupalMedia
Defines the "drupalmedia" plugin.
@CKEditorPlugin( id = "drupalmedia", label = @Translation("Media Embed"), provider = "media", )
@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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalMedia extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\ckeditor\CKEditorPluginContextualInterface, \Drupal\ckeditor\CKEditorPluginCssInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of DrupalMedia
10 string references to 'DrupalMedia'
- ckeditor5.ckeditor5.yml in core/
modules/ ckeditor5/ ckeditor5.ckeditor5.yml - core/modules/ckeditor5/ckeditor5.ckeditor5.yml
- ckeditor5_test.ckeditor5.yml in core/
modules/ ckeditor5/ tests/ modules/ ckeditor5_test/ ckeditor5_test.ckeditor5.yml - core/modules/ckeditor5/tests/modules/ckeditor5_test/ckeditor5_test.ckeditor5.yml
- Core::mapCKEditor4ToolbarButtonToCKEditor5ToolbarItem in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor4To5Upgrade/ Core.php - Maps a CKEditor 4 button to the CKEditor 5 equivalent, if it exists.
- DrupalMediaLibrary::getDependencies in core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ DrupalMediaLibrary.php - Returns a list of plugins this plugin requires.
- editor.editor.basic_html.yml in core/
profiles/ demo_umami/ config/ install/ editor.editor.basic_html.yml - core/profiles/demo_umami/config/install/editor.editor.basic_html.yml
File
-
core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ DrupalMedia.php, line 27
Namespace
Drupal\ckeditor\Plugin\CKEditorPluginView 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',
// @see Drupal.theme.mediaEmbedPreviewError()
'media/media_embed_ckeditor_theme',
// @see Drupal.theme.mediaEmbedEditButton()
'ckeditor/drupal.ckeditor.plugins.drupalmedia',
];
}
/**
* {@inheritdoc}
*/
public function getFile() {
return $this->moduleExtensionList
->getPath('ckeditor') . '/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('ckeditor') . '/css/plugins/drupalmedia/ckeditor.drupalmedia.css',
$this->moduleExtensionList
->getPath('system') . '/css/components/hidden.module.css',
];
}
}
Members
Title Sort descending | 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.