tag is always allowed.'); + $this->assertIdentical($expected_config, $this->ckeditor->getJSConfiguration($editor), 'Even when somebody manually deleted the key-value pair in State with the pre-calculated format_tags setting, it returns "p" — because the
tag is always allowed.'); } /** @@ -386,7 +386,7 @@ function testJSTranslation() { $this->installSchema('locale', 'locales_location'); $this->installSchema('locale', 'locales_target'); $editor = Editor::load('filtered_html'); - $this->ckeditor->getJSSettings($editor); + $this->ckeditor->getJSConfiguration($editor); $localeStorage = $this->container->get('locale.storage'); $string = $localeStorage->findString(array('source' => 'Edit Link', 'context' => '')); $this->assertTrue(!empty($string), 'String from JavaScript file saved.'); @@ -414,7 +414,7 @@ protected function assertCKEditorLanguage($langcode = 'fr') { // Test that we now get the expected language. $editor = Editor::load('filtered_html'); - $settings = $this->ckeditor->getJSSettings($editor); + $settings = $this->ckeditor->getJSConfiguration($editor); $this->assertEqual($settings['language'], $langcode); } diff --git a/core/modules/editor/editor.module b/core/modules/editor/editor.module index b7ec8b5..afb27d8 100644 --- a/core/modules/editor/editor.module +++ b/core/modules/editor/editor.module @@ -153,12 +153,13 @@ function editor_form_filter_format_form_alter(&$form, FormStateInterface $form_s // Add editor-specific validation and submit handlers. if ($editor) { + /** @var $plugin \Drupal\editor\Plugin\EditorPluginInterface */ $plugin = $manager->createInstance($editor->getEditor()); $settings_form = array(); - $settings_form['#element_validate'][] = array($plugin, 'settingsFormValidate'); - $form['editor']['settings']['subform'] = $plugin->settingsForm($settings_form, $form_state, $editor); + $settings_form['#element_validate'][] = array($plugin, 'validateConfigurationForm'); + $form['editor']['settings']['subform'] = $plugin->buildConfigurationForm($settings_form, $form_state, $editor); $form['editor']['settings']['subform']['#parents'] = array('editor', 'settings'); - $form['actions']['submit']['#submit'][] = array($plugin, 'settingsFormSubmit'); + $form['actions']['submit']['#submit'][] = array($plugin, 'submitConfigurationForm'); } $form['#validate'][] = 'editor_form_filter_admin_format_validate'; diff --git a/core/modules/editor/src/Entity/Editor.php b/core/modules/editor/src/Entity/Editor.php index 60cdf5a..9ddc0cb 100644 --- a/core/modules/editor/src/Entity/Editor.php +++ b/core/modules/editor/src/Entity/Editor.php @@ -80,7 +80,9 @@ public function __construct(array $values, $entity_type) { parent::__construct($values, $entity_type); $plugin = $this->editorPluginManager()->createInstance($this->editor); - $this->settings += $plugin->getDefaultSettings(); + + /* @var \Drupal\editor\Plugin\EditorPluginInterface $plugin */ + $this->settings = array_merge($this->settings, $plugin->getDefaultConfiguration()); } /** diff --git a/core/modules/editor/src/Plugin/EditorBase.php b/core/modules/editor/src/Plugin/EditorBase.php index eafe673..84f7511 100644 --- a/core/modules/editor/src/Plugin/EditorBase.php +++ b/core/modules/editor/src/Plugin/EditorBase.php @@ -53,27 +53,27 @@ /** * {@inheritdoc} */ - public function getDefaultSettings() { + public function getDefaultConfiguration() { return array(); } /** * {@inheritdoc} */ - public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) { + public function buildConfigurationForm(array $form, FormStateInterface $form_state, Editor $editor = NULL) { return $form; } /** * {@inheritdoc} */ - public function settingsFormValidate(array $form, FormStateInterface $form_state) { + public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { } /** * {@inheritdoc} */ - public function settingsFormSubmit(array $form, FormStateInterface $form_state) { + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { } } diff --git a/core/modules/editor/src/Plugin/EditorManager.php b/core/modules/editor/src/Plugin/EditorManager.php index 6fc04d0..286fb39 100644 --- a/core/modules/editor/src/Plugin/EditorManager.php +++ b/core/modules/editor/src/Plugin/EditorManager.php @@ -83,7 +83,7 @@ public function getAttachments(array $format_ids) { $settings['editor']['formats'][$format_id] = array( 'format' => $format_id, 'editor' => $editor->getEditor(), - 'editorSettings' => $plugin->getJSSettings($editor), + 'editorSettings' => $plugin->getJSConfiguration($editor), 'editorSupportsContentFiltering' => $plugin_definition['supports_content_filtering'], 'isXssSafe' => $plugin_definition['is_xss_safe'], ); diff --git a/core/modules/editor/src/Plugin/EditorPluginInterface.php b/core/modules/editor/src/Plugin/EditorPluginInterface.php index f5177f5..430c7ab 100644 --- a/core/modules/editor/src/Plugin/EditorPluginInterface.php +++ b/core/modules/editor/src/Plugin/EditorPluginInterface.php @@ -8,6 +8,7 @@ namespace Drupal\editor\Plugin; use Drupal\Component\Plugin\PluginInspectionInterface; +use Drupal\Core\Plugin\PluginFormInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\editor\Entity\Editor; @@ -22,7 +23,7 @@ * @see \Drupal\editor\Plugin\EditorManager * @see plugin_api */ -interface EditorPluginInterface extends PluginInspectionInterface { +interface EditorPluginInterface extends PluginInspectionInterface, PluginFormInterface { /** * Returns the default settings for this configurable text editor. @@ -31,27 +32,7 @@ * An array of settings as they would be stored by a configured text editor * entity (\Drupal\editor\Entity\Editor). */ - public function getDefaultSettings(); - - /** - * Returns a settings form to configure this text editor. - * - * If the editor's behavior depends on extensive options and/or external data, - * then the implementing module can choose to provide a separate, global - * configuration page rather than per-text-format settings. In that case, this - * form should provide a link to the separate settings page. - * - * @param array $form - * An empty form array to be populated with a configuration form, if any. - * @param \Drupal\Core\Form\FormStateInterface $form_state - * The state of the entire filter administration form. - * @param \Drupal\editor\Entity\Editor $editor - * A configured text editor object. - * - * @return array - * A render array for the settings form. - */ - public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor); + public function getDefaultConfiguration(); /** * Validates the settings form for an editor. @@ -65,7 +46,7 @@ public function settingsForm(array $form, FormStateInterface $form_state, Editor * @param \Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. */ - public function settingsFormValidate(array $form, FormStateInterface $form_state); + public function validateConfigurationForm(array &$form, FormStateInterface $form_state); /** * Modifies any values in the form state to prepare them for saving. @@ -78,7 +59,7 @@ public function settingsFormValidate(array $form, FormStateInterface $form_state * @param \Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. */ - public function settingsFormSubmit(array $form, FormStateInterface $form_state); + public function submitConfigurationForm(array &$form, FormStateInterface $form_state); /** * Returns JavaScript settings to be attached. @@ -98,7 +79,7 @@ public function settingsFormSubmit(array $form, FormStateInterface $form_state); * @see drupal_process_attached() * @see EditorManager::getAttachments() */ - public function getJSSettings(Editor $editor); + public function getJSConfiguration(Editor $editor); /** * Returns libraries to be attached. @@ -119,4 +100,13 @@ public function getJSSettings(Editor $editor); */ public function getLibraries(Editor $editor); + /** + * {@inheritdoc} + * + * If the editor's behavior depends on extensive options and/or external data, + * then the implementing module can choose to provide a separate, global + * configuration page rather than per-text-format configuration. In that case, + * this form should provide a link to the separate configuration page. + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state); } diff --git a/core/modules/editor/src/Tests/EditorManagerTest.php b/core/modules/editor/src/Tests/EditorManagerTest.php index c28d99d..717bd5a 100644 --- a/core/modules/editor/src/Tests/EditorManagerTest.php +++ b/core/modules/editor/src/Tests/EditorManagerTest.php @@ -96,7 +96,7 @@ public function testManager() { 'full_html' => [ 'format' => 'full_html', 'editor' => 'unicorn', - 'editorSettings' => $unicorn_plugin->getJSSettings($editor), + 'editorSettings' => $unicorn_plugin->getJSConfiguration($editor), 'editorSupportsContentFiltering' => TRUE, 'isXssSafe' => FALSE, ], diff --git a/core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php b/core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php index 5539c16..919238e 100644 --- a/core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php +++ b/core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php @@ -30,14 +30,14 @@ class TRexEditor extends EditorBase { /** * {@inheritdoc} */ - public function getDefaultSettings() { + public function getDefaultConfiguration() { return array('stumpy_arms' => TRUE); } /** * {@inheritdoc} */ - public function settingsForm(array $form, FormStateInterface $form_state, EditorEntity $editor) { + public function buildConfigurationForm(array $form, FormStateInterface $form_state, EditorEntity $editor = NULL) { $form['stumpy_arms'] = array( '#title' => t('Stumpy arms'), '#type' => 'checkbox', @@ -49,7 +49,7 @@ public function settingsForm(array $form, FormStateInterface $form_state, Editor /** * {@inheritdoc} */ - public function getJSSettings(EditorEntity $editor) { + public function getJSConfiguration(EditorEntity $editor) { $js_settings = array(); $settings = $editor->getSettings(); if ($settings['stumpy_arms']) { diff --git a/core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php b/core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php index e859732..9d914c2 100644 --- a/core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php +++ b/core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php @@ -31,14 +31,14 @@ class UnicornEditor extends EditorBase { /** * {@inheritdoc} */ - function getDefaultSettings() { + public function getDefaultConfiguration() { return array('ponies_too' => TRUE); } /** * {@inheritdoc} */ - function settingsForm(array $form, FormStateInterface $form_state, EditorEntity $editor) { + public function buildConfigurationForm(array $form, FormStateInterface $form_state, EditorEntity $editor = NULL) { $form['ponies_too'] = array( '#title' => t('Pony mode'), '#type' => 'checkbox', @@ -50,7 +50,7 @@ function settingsForm(array $form, FormStateInterface $form_state, EditorEntity /** * {@inheritdoc} */ - function getJSSettings(EditorEntity $editor) { + public function getJSConfiguration(EditorEntity $editor) { $js_settings = array(); $settings = $editor->getSettings(); if ($settings['ponies_too']) { diff --git a/core/modules/editor/tests/src/Unit/EditorConfigEntityUnitTest.php b/core/modules/editor/tests/src/Unit/EditorConfigEntityUnitTest.php index c5a676b..77ea892 100644 --- a/core/modules/editor/tests/src/Unit/EditorConfigEntityUnitTest.php +++ b/core/modules/editor/tests/src/Unit/EditorConfigEntityUnitTest.php @@ -103,8 +103,8 @@ public function testCalculateDependencies() { $plugin->expects($this->once()) ->method('getPluginDefinition') ->will($this->returnValue(array('provider' => 'test_module'))); - $plugin->expects($this->once()) - ->method('getDefaultSettings') + $plugin->expects($this->any()) + ->method('getDefaultConfiguration') ->will($this->returnValue(array())); $this->editorPluginManager->expects($this->any())