You are here

Home » API reference » TinyMCE 1.x » TinyMCE.php

class TinyMCE in TinyMCE 1.x

Defines a TinyMCE-based text editor for Drupal.

Plugin annotation


@Editor(
  id = "tinymce",
  label = @Translation("TinyMCE"),
  supports_content_filtering = TRUE,
  supports_inline_editing = TRUE,
  is_xss_safe = FALSE,
  supported_element_types = {
    "textarea"
  }
)

Hierarchy

Expanded class hierarchy of TinyMCE

1 string reference to 'TinyMCE'
tinymce.info.yml in ./tinymce.info.yml
tinymce.info.yml

File

src/Plugin/Editor/TinyMCE.php, line 27

Namespace

Drupal\tinymce\Plugin\Editor
View source 
class TinyMCE extends EditorBase implements ContainerFactoryPluginInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a \Drupal\tinymce\Plugin\Editor\TinyMCE 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 mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function getJSSettings(Editor $editor) {
    $default_Settings = $this
      ->getDefaults();
    $customSettings = ($settings = $editor
      ->getSettings()) && !empty($settings['tinymce_editor_settings']) ? $settings['tinymce_editor_settings'] : Json::encode($default_Settings);
    return [
      'json' => Json::decode($customSettings),
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $editor = $form_state
      ->get('editor');
    $settings = $editor
      ->getSettings();
    $default_Settings = $this
      ->getDefaults();
    $form['tinymce_editor_settings'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Editor settings'),
      '#default_value' => $settings['tinymce_editor_settings'] ?? Json::encode($default_Settings),
      '#description' => $this
        ->t('Custom settings for the editor. Please see <a href=":example" target="_blank">this page for additional documentation</a>.<br/>Note that you need to register your domain (have an API key) to remove the notice, <a href=":api-key" target="_blank">see more details here</a>.', [
        ':example' => 'https://www.tiny.cloud/docs/demo/full-featured/',
        ':api-key' => 'https://www.tiny.cloud/docs/quick-start/#step3addyourapikey',
      ]),
      '#rows' => 20,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaults() {
    return [
      'plugins' => 'print preview importcss searchreplace autolink autosave save directionality visualblocks visualchars fullscreen image link media template codesample table charmap hr pagebreak nonbreaking anchor toc insertdatetime advlist lists wordcount imagetools textpattern noneditable help charmap quickbars emoticons',
      'mobile' => [
        'plugins' => 'print preview importcss tinydrive searchreplace autolink autosave save directionality visualblocks visualchars fullscreen image link media template codesample table charmap hr pagebreak nonbreaking anchor toc insertdatetime advlist lists wordcount textpattern noneditable help charmap quickbars emoticons',
      ],
      'menubar' => 'file edit view insert format tools table tc help',
      'toolbar' => 'undo redo | bold italic underline strikethrough | fontselect fontsizeselect formatselect | alignleft aligncenter alignright alignjustify | outdent indent |  numlist bullist | forecolor backcolor removeformat | pagebreak | charmap emoticons | fullscreen preview save print | image media link anchor codesample | ltr rtl',
      'autosave_ask_before_unload' => TRUE,
      'autosave_interval' => '30s',
      'autosave_prefix' => '{path}{query}-{id}-',
      'autosave_restore_when_empty' => FALSE,
      'autosave_retention' => '2m',
      'importcss_append' => TRUE,
      'image_advtab' => TRUE,
      'image_caption' => TRUE,
      'image_title' => TRUE,
      'automatic_uploads' => TRUE,
      'images_upload_url' => '/tinymce/upload',
      'quickbars_selection_toolbar' => 'bold italic | quicklink h2 h3 blockquote quickimage quicktable',
      'noneditable_noneditable_class' => 'mceNonEditable',
      'toolbar_mode' => 'sliding',
      'contextmenu' => 'link image imagetools table',
      'skin' => 'oxide',
      'content_css' => 'default',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EditorBase::getDefaultSettings public function Returns the default settings for this configurable text editor. Overrides EditorPluginInterface::getDefaultSettings 3
EditorBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
EditorBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.
TinyMCE::$configFactory protected property The configuration factory.
TinyMCE::buildConfigurationForm public function Form constructor. Overrides EditorBase::buildConfigurationForm
TinyMCE::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TinyMCE::getDefaults public function
TinyMCE::getJSSettings public function Returns JavaScript settings to be attached. Overrides EditorPluginInterface::getJSSettings
TinyMCE::getLibraries public function Returns libraries to be attached. Overrides EditorPluginInterface::getLibraries
TinyMCE::__construct public function Constructs a \Drupal\tinymce\Plugin\Editor\TinyMCE object. Overrides PluginBase::__construct