Linebreaks.php in Wysiwyg Linebreaks 8

Namespace

Drupal\wysiwyg_linebreaks\Plugin\CKEditorPlugin

File

src/Plugin/CKEditorPlugin/Linebreaks.php

<?php

namespace Drupal\wysiwyg_linebreaks\Plugin\CKEditorPlugin;

use Drupal\Component\Plugin\PluginBase;
use Drupal\ckeditor\CKEditorPluginInterface;
use Drupal\ckeditor\CKEditorPluginContextualInterface;
use Drupal\ckeditor\CKEditorPluginConfigurableInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\editor\Entity\Editor;

/**
 * Defines the "linebreaks" plugin.
 *
 * @CKEditorPlugin(
 *   id = "linebreaks",
 *   label = @Translation("Linebreaks"),
 *   module = "wysiwyg_linebreaks"
 * )
 */
class Linebreaks extends PluginBase implements CKEditorPluginInterface, CKEditorPluginContextualInterface, CKEditorPluginConfigurableInterface {
  use StringTranslationTrait;

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    return drupal_get_path('module', 'wysiwyg_linebreaks') . '/js/plugins/linebreaks/linebreaks.js';
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    $settings = $editor
      ->getSettings();
    return [
      'linebreaks_method' => isset($settings['plugins']['linebreaks']) ? $settings['plugins']['linebreaks']['method'] : 'force',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled(Editor $editor) {

    // If the module is enabled, this plugin should be enabled.
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    $default = $this
      ->getConfig($editor);
    $form['method'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Conversion Method'),
      '#default_value' => $default['linebreaks_method'],
      '#options' => [
        'force' => $this
          ->t('Force linebreaks'),
        'convert' => $this
          ->t('Convert linebreaks'),
      ],
      '#description' => $this
        ->t('Set to Force linebreaks if you never want to see <code>&lt;p&gt;</code> and
        <code>&lt;br /&gt;</code> tags in your content when editing without a Wysiwyg editor. Set to Convert linebreaks
         if you have content without <code>&lt;p&gt;</code> and <code>&lt;br /&gt;</code> tags that needs to be
          converted so it is still formatted correctly in the Wysiwyg editor.'),
    ];
    return $form;
  }

}

Classes

Name	Description
Linebreaks	Defines the "linebreaks" plugin.