You are here

Home » API reference » CKEditor Media Embed Plugin 8 » AutoEmbed.php

class AutoEmbed in CKEditor Media Embed Plugin 8

Defines the "Auto Embed" plugin.

Plugin annotation


@CKEditorPlugin(
  id = "autoembed",
  label = @Translation("Auto Embed"),
  module = "ckeditor_media_embed"
)

Hierarchy

Expanded class hierarchy of AutoEmbed

File

src/Plugin/CKEditorPlugin/AutoEmbed.php, line 22

Namespace

Drupal\ckeditor_media_embed\Plugin\CKEditorPlugin
View source 
class AutoEmbed extends CKEditorVersionAwarePluginBase implements CKEditorPluginConfigurableInterface, CKEditorPluginContextualInterface {

  /**
   * {@inheritdoc}
   */
  public function getDependencies(Editor $editor) {
    $settings = $editor
      ->getSettings();
    $dependencies = [
      'autolink',
      'embedbase',
      'notificationaggregator',
      'notification',
    ];
    if ($this
      ->needsTextMatchDependency()) {
      $dependencies[] = 'textmatch';
    }
    if ($embed_plugin = $settings['plugins']['autoembed']['status']) {
      $dependencies[] = $embed_plugin;
    }
    return $dependencies;
  }

  /**
   * Determine if the textmatch plugin is needed as a dependency.
   *
   * @return bool
   *   Returns TRUE if the textmatch plugin is necessary.
   */
  public function needsTextMatchDependency() {
    return $this
      ->versionCompare('4.11') >= 0;
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isInternal() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    return AssetManager::getCKEditorLibraryPluginPath() . $this
      ->getPluginId() . '/plugin.js';
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled(Editor $editor) {
    $settings = $editor
      ->getSettings();
    return isset($settings['plugins']['autoembed']['status']) && (bool) $settings['plugins']['autoembed']['status'];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    $settings = $editor
      ->getSettings();
    $form['status'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Enable auto embed'),
      '#options' => [
        '' => $this
          ->t('Disabled'),
        'embed' => $this
          ->t('Media Embed'),
        'embedsemantic' => $this
          ->t('Semantic Media Embed'),
      ],
      '#default_value' => !empty($settings['plugins']['autoembed']['status']) ? $settings['plugins']['autoembed']['status'] : '',
      '#description' => $this
        ->t('When enabled to a Media embed plugin, media resource URLs pasted into the editing area are turned into an embed resource using the selected plugin.'),
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutoEmbed::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
AutoEmbed::getDependencies public function Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
AutoEmbed::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
AutoEmbed::getLibraries public function Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries
AutoEmbed::isEnabled public function Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
AutoEmbed::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal
AutoEmbed::needsTextMatchDependency public function Determine if the textmatch plugin is needed as a dependency.
AutoEmbed::settingsForm public function Returns a settings form to configure this CKEditor plugin. Overrides CKEditorPluginConfigurableInterface::settingsForm
CKEditorVersionAwarePluginBase::$configFactory protected property The config factory service.
CKEditorVersionAwarePluginBase::$libraryDiscovery protected property The library discovery service.
CKEditorVersionAwarePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CKEditorVersionAwarePluginBase::versionCompare protected function Compares the specified version against the currently installed version.
CKEditorVersionAwarePluginBase::__construct public function Constructs a \Drupal\ckeditor\Plugin\CKEditorPlugin\AutoEmbed object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.