-
-
' filter_html_help: true filter_html_nofollow: false diff --git a/config/install/filter.format.help_plain.yml b/config/install/filter.format.help_plain.yml deleted file mode 100644 index c0f6b5f..0000000 --- a/config/install/filter.format.help_plain.yml +++ /dev/null @@ -1,16 +0,0 @@ -langcode: en -status: true -dependencies: - enforced: - module: - - config_help -name: 'Help - plain text' -format: help_plain -weight: 0 -filters: - filter_html_escape: - id: filter_html_escape - provider: filter - status: true - weight: -10 - settings: { } diff --git a/config/optional/editor.editor.help.yml b/config/optional/editor.editor.help.yml new file mode 100644 index 0000000..66c2f58 --- /dev/null +++ b/config/optional/editor.editor.help.yml @@ -0,0 +1,52 @@ +langcode: en +status: true +dependencies: + config: + - filter.format.help + module: + - ckeditor +format: help +editor: ckeditor +settings: + toolbar: + rows: + - + - + name: Formatting + items: + - Bold + - Italic + - + name: Links + items: + - DrupalLink + - DrupalUnlink + - + name: Lists + items: + - BulletedList + - NumberedList + - Indent + - Outdent + - Table + - + name: Media + items: + - DrupalImage + - + name: Tools + items: + - Source + plugins: + stylescombo: + styles: '' + language: + language_list: un +image_upload: + status: false + scheme: public + directory: inline-images + max_size: '' + max_dimensions: + width: null + height: null diff --git a/config/schema/config_help.schema.yml b/config/schema/config_help.schema.yml index c8df7e7..576ca10 100644 --- a/config/schema/config_help.schema.yml +++ b/config/schema/config_help.schema.yml @@ -29,13 +29,19 @@ config_help.topic.*: label: 'Body' sequence: type: config_help_text + body_format: + type: string + label: 'Body format' config_help_text: type: mapping mapping: - id: - label: 'Type' + prefix_tags: type: string + label: 'Prefix tags' text: + type: text label: 'Text' - type: text_format + suffix_tags: + type: string + label: 'Suffix tags' diff --git a/config_help.api.php b/config_help.api.php deleted file mode 100644 index 80056bb..0000000 --- a/config_help.api.php +++ /dev/null @@ -1,35 +0,0 @@ -getEditable('filter.format.help'); + $filters = $config->get('filters'); + foreach ($filters as $index => $filter) { + if ($filter['id'] == 'filter_html') { + $filter['settings']['allowed_html'] .= ' -
-
'; + $filters[$index] = $filter; + } + } + $config->set('filters', $filters); + $config->save(TRUE); + + // Find the list of all existing help topics. + $sandbox['topics'] = $config_factory->listAll('config_help.topic.'); + $sandbox['start_with'] = 0; + $sandbox['num'] = count($sandbox['topics']); + } + + // Update up to 20 topics in a batch. + $topics = array_slice($sandbox['topics'], $sandbox['start_with'], 20); + if (!$topics) { + $sandbox['#finished'] = 1; + return; + } + $sandbox['#finished'] = ($sandbox['start_with'] + 20) / $sandbox['num']; + $sandbox['start_with'] += 20; + + foreach ($topics as $topic) { + $config = $config_factory->getEditable($topic); + $config->set('body_format', 'help'); + + $old_body = $config->get('body'); + $new_body = []; + $previous_list = ''; + $previous_index = 0; + foreach ($old_body as $index => $old_chunk) { + $new_chunk = ['text' => $old_chunk['text']['value']]; + switch ($old_chunk['id']) { + case 'paragraph': + $new_list = ''; + $new_chunk['prefix_tags'] = ' '; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'heading': + $new_list = ''; + $new_chunk['prefix_tags'] = ''; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'subheading': + $new_list = ''; + $new_chunk['prefix_tags'] = ''; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'code': + $new_list = ''; + $new_chunk['prefix_tags'] = '
'; + break; + + case 'bullet': + $new_list = 'ul'; + $new_chunk['prefix_tags'] = ''; + $new_chunk['suffix_tags'] = '- '; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'numbered': + $new_list = 'ol'; + $new_chunk['prefix_tags'] = '- '; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'description_name': + $new_list = 'dl'; + $new_chunk['prefix_tags'] = '- '; + $new_chunk['suffix_tags'] = '
'; + break; + + case 'description_value': + $new_list = 'dl'; + $new_chunk['prefix_tags'] = '- '; + $new_chunk['suffix_tags'] = '
'; + break; + + default: + $new_list = ''; + $new_chunk['prefix_tags'] = ''; + $new_chunk['suffix_tags'] = ''; + break; + } + + // Close previous list if this isn't part of it. + if ($previous_list && ($new_list != $previous_list)) { + $new_body[$previous_index]['suffix_tags'] .= ''; + } + // Open new list if it wasn't already open. + if ($new_list && ($new_list != $previous_list)) { + $new_chunk['prefix_tags'] = '<' . $new_list . '>' . $new_chunk['prefix_tags']; + } + // Save this chunk and update previous variables. + $new_body[$index] = $new_chunk; + $previous_index = $index; + $previous_list = $new_list; + } + + // Close out the last list if necessary. + if ($previous_list) { + $new_body[$previous_index]['suffix_tags'] .= ''; + } + + // Save the configuration. + $config->set('body', $new_body); + $config->save(TRUE); + } +} diff --git a/config_help.module b/config_help.module index 1bb36df..b7e2319 100644 --- a/config_help.module +++ b/config_help.module @@ -14,51 +14,22 @@ use Drupal\Core\Url; function config_help_help($route_name, RouteMatchInterface $route_match) { switch ($route_name) { case 'help.page.config_help': - $sections = []; - $sections[] = [ - '#section_type' => 'heading', - '#text' => t('About'), - ]; - $sections[] = [ - '#section_type' => 'paragraph', - '#text' => t('The Configurable Help module adds configurable help topics to the module-provided help from the core Help module. For more information, see the online documentation for the Configurable Help module.', [':online' => 'https://www.drupal.org/modules/config_help']), - ]; - $sections[] = [ - '#section_type' => 'heading', - '#text' => ['#markup' => t('Uses')], - ]; - $sections[] = [ - '#section_type' => 'description_name', - '#text' => t('Configuring help topics'), - ]; - $sections[] = [ - '#section_type' => 'description_value', - '#text' => t('You can add, edit, delete, and translate configure help topics on the Help topics administration page. The help topics that are listed in the Module help section of the main Help page cannot be edited or deleted. See the Building a help system topic for more information on configuring help topics.', [ - ':topic_admin' => Url::fromRoute('entity.help_topic.collection')->toString(), - ':main_topic' => Url::fromRoute('entity.help_topic.canonical', ['help_topic' => 'config_help'])->toString(), - ]), - ]; - $sections[] = [ - '#section_type' => 'description_name', - '#text' => t('Viewing configurable help topics'), - ]; - $sections[] = [ - '#section_type' => 'description_value', - '#text' => t('The top-level configured help topics are listed on the main Help page.', [':help_page' => Url::fromRoute('help.main')->toString()]), - ]; - $sections[] = [ - '#section_type' => 'description_name', - '#text' => t('Updating help topics'), - ]; - $sections[] = [ - '#section_type' => 'description_value', - '#text' => t('Help topics provided by modules and themes may be updated when a module or theme is updated, or new topics may be added. However, help topics are only imported into your site configuration when you first install the module or theme. The contributed Configuration Update Manager module can be used to check for updates, see differences, and import or update topics that have been added or have changed. It is advisable not to edit module- or theme-provided topics, to make updates easier.', [':config_update' => 'https://www.drupal.org/project/config_update']), - ]; - - return [ - '#type' => 'text_sections', - '#sections' => $sections, - ]; + $output = ''; + $output .= '' . t('About') . '
'; + $output .= '' . t('The Configurable Help module adds configurable help topics to the module-provided help from the core Help module. For more information, see the online documentation for the Configurable Help module.', [':online' => 'https://www.drupal.org/modules/config_help']) . '
'; + $output .= '' . t('Uses') . '
'; + $output .= '- ';
+ $output .= '
- ' . t('Configuring help topics') . ' '; + $output .= '
- ' . t('You can add, edit, delete, and translate configure help topics on the Help topics administration page. The help topics that are listed in the Module help section of the main Help page cannot be edited or deleted. See the Building a help system topic for more information on configuring help topics.', [ + ':topic_admin' => Url::fromRoute('entity.help_topic.collection')->toString(), + ':main_topic' => Url::fromRoute('entity.help_topic.canonical', ['help_topic' => 'config_help'])->toString(), + ]) . ' '; + $output .= '
- ' . t('Viewing configurable help topics') . ' '; + $output .= '
- ' . t('The top-level configured help topics are listed on the main Help page.', [':help_page' => Url::fromRoute('help.main')->toString()]) . ' '; + $output .= '
- ' . t('Updating help topics') . ' '; + $output .= '
- ' . t('Help topics provided by modules and themes may be updated when a module or theme is updated, or new topics may be added. However, help topics are only imported into your site configuration when you first install the module or theme. The contributed Configuration Update Manager module can be used to check for updates, see differences, and import or update topics that have been added or have changed. It is advisable not to edit module- or theme-provided topics, to make updates easier.', [':config_update' => 'https://www.drupal.org/project/config_update']) . ' '; + $output .= '
', - '#suffix' => '', + $form['body'] = [ + '#type' => 'text_format', + '#title' => $this->t('Body'), + '#default_value' => $entity->getBody(), + '#format' => $entity->getBodyFormat(), + '#description' => $this->t('You can use tokens like [route:url:ROUTE_NAME] and [help_topic:url:MACHINE_NAME] to insert URLs to administrative page routes and to other help topics into the text.'), ]; - - // Add edit elements for each body component. - for ($delta = 0; $delta < $max; $delta++) { - if (!isset($body[$delta])) { - $body[$delta] = [ - 'id' => '', - 'text' => [ - 'value' => '', - 'format' => 'help', - ], - ]; - } - - $element = [ - '#delta' => $delta, - '#weight' => $delta, - '#required' => FALSE, - ]; - $element['id'] = [ - '#type' => 'select', - '#options' => $this->sectionManager->getOptionsList(), - '#default_value' => $body[$delta]['id'], - ]; - $element['text'] = [ - '#type' => 'text_format', - '#default_value' => $body[$delta]['text']['value'], - '#format' => $body[$delta]['text']['format'], - '#description' => $this->t('You can use tokens like [route:url:ROUTE_NAME] and [help_topic:url:MACHINE_NAME] to insert URLs to administrative page routes and to other help topics into the text.'), - ]; - $element['_weight'] = [ - '#type' => 'weight', - '#title' => $this->t('Weight for row @number', ['@number' => $delta + 1]), - '#title_display' => 'invisible', - '#delta' => $max, - '#default_value' => $delta, - '#weight' => 100, - ]; - - $form[$field_name][$delta] = $element; + // The filter module will deny access if the format is set to '', so unset + // to instead use the first format that the user can access as the default. + if (!$form['body']['#format']) { + unset($form['body']['#format']); } - // Include the add more button. - $form[$field_name]['add_more'] = [ - '#type' => 'submit', - '#name' => strtr($id_prefix, '-', '_') . '_add_more', - '#value' => $this->t('Add another item'), - '#attributes' => ['class' => ['field-add-more-submit']], - '#submit' => ['::addMoreSubmit'], - '#ajax' => [ - 'callback' => '::addMoreAjax', - 'wrapper' => $wrapper_id, - 'effect' => 'fade', - ], - ]; - $form['relationships'] = [ '#type' => 'details', '#open' => TRUE, @@ -227,7 +137,6 @@ class HelpTopicForm extends EntityForm { '#description' => $this->t('Check box if this topic should be displayed on the Help page topics list'), ]; - $form['relationships']['related'] = [ '#title' => $this->t('Topics to list here'), '#description' => $this->t("Topics to list in this topic's Related topics section. Comma-separated list of machine names."), @@ -279,35 +188,6 @@ class HelpTopicForm extends EntityForm { } /** - * Handles the Ajax submit for the add more button. - * - * Modified from \Drupal\Core\Field\WidgetBase::addMoreSubmit(). - */ - public static function addMoreSubmit(array $form, FormStateInterface $form_state) { - $form_state->setRebuild(); - } - - /** - * Handles the Ajax response for the add more button. - * - * Modified from \Drupal\Core\Field\WidgetBase::addMoreAjax(). - */ - public static function addMoreAjax(array $form, FormStateInterface $form_state) { - // Go one level up from the Add More button, so we're looking at the list. - $button = $form_state->getTriggeringElement(); - $element = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -1)); - - // Add a DIV around the delta receiving the Ajax effect. - $latest = $element['#max_delta']; - if (isset($element[$latest])) { - $element[$latest]['#prefix'] = '' . (isset($element[$latest]['#prefix']) ? $element[$latest]['#prefix'] : ''); - $element[$latest]['#suffix'] = (isset($element[$latest]['#suffix']) ? $element[$latest]['#suffix'] : '') . ''; - } - - return $element; - } - - /** * Copies the topics and dependencies field values to the entity properties. * * This is added to $form['#entity_builders'] in the form builder method. @@ -322,6 +202,7 @@ class HelpTopicForm extends EntityForm { * Form state. */ protected function copyTopicFieldsToEntity($type, EntityInterface $entity, array &$form, FormStateInterface &$form_state) { + $body = $form_state->getValue('body'); $entity ->setRelated(Tags::explode($form_state->getValue('related'))) ->setListOn(Tags::explode($form_state->getValue('list_on'))) @@ -329,7 +210,8 @@ class HelpTopicForm extends EntityForm { 'module' => Tags::explode($form_state->getValue('modules')), 'theme' => Tags::explode($form_state->getValue('themes')), ]) - ->setBody($this->cleanBody($form_state->getValue('body'))); + ->setBody($body['value']) + ->setBodyFormat($body['format']); } /** @@ -338,6 +220,11 @@ class HelpTopicForm extends EntityForm { public function validateForm(array &$form, FormStateInterface $form_state) { parent::validateForm($form, $form_state); + // Make sure that the HTML in the body can at least be loaded/parsed. + if (!Html::load($form_state->getValue('body')['value'])) { + $form_state->setErrorByName('body', $this->t('Body HTML is malformed')); + } + // Make sure that the two reference fields only contain machine names of // actual help topics. foreach (['related', 'list_on'] as $field) { @@ -389,36 +276,4 @@ class HelpTopicForm extends EntityForm { } } - /** - * Cleans an unprocessed body field value. - * - * @param array $body - * Array of body text pieces. - * - * @return array - * List of non-empty body text pieces, in order by weight. - */ - protected function cleanBody(array $body) { - if (!$body || !is_array($body)) { - return []; - } - - $cleaned = []; - foreach ($body as $piece) { - if (is_array($piece) && isset($piece['id']) && isset($piece['text']['value']) && isset($piece['text']['format'])) { - // Make sure there is actually something relevant in the text. - $text = trim($piece['text']['value']); - if ($text) { - $piece['text']['value'] = $text; - $weight = $piece['_weight']; - unset($piece['_weight']); - $cleaned[$weight] = $piece; - } - } - } - - ksort($cleaned); - return array_values($cleaned); - } - } diff --git a/src/HelpTopicInterface.php b/src/HelpTopicInterface.php index e742357..80b669d 100644 --- a/src/HelpTopicInterface.php +++ b/src/HelpTopicInterface.php @@ -12,34 +12,38 @@ use Drupal\Core\Config\Entity\ConfigEntityInterface; interface HelpTopicInterface extends ConfigEntityInterface { /** - * Returns the unprocessed body of the topic. + * Returns body of the topic. * - * @return array - * A number-indexed array of pieces of body text. Each piece is an array - * with two elements: - * - id: The machine name of a text section type plugin. - * - text: The text, which in turn is an array with two elements: - * - value: Unformatted, unfiltered text. - * - format: ID of the text format to use to filter/format the text. - * - * @see \Drupal\Core\Render\Annotation\TextSection + * @return string + * The HTML-formatted body of the topic. */ public function getBody(); /** - * Sets the unprocessed body value for the topic. + * Sets the body value for the topic. + * + * @param string $body + * The HTML-formatted body to save in the topic. * - * @param array $body - * A number-indexed array of pieces of body text. Each piece is an array - * with two elements: - * - id: The machine name of a text section type plugin. - * - text: The text, which in turn is an array with two elements: - * - value: Unformatted, unfiltered text. - * - format: ID of the text format to use to filter/format the text. + * @throws \Drupal\Core\Config\ConfigValueException if the HTML is malformed. + */ + public function setBody($body); + + /** + * Returns text format for the body of the topic. + * + * @return string + * The machine name of the text format for the topic body. + */ + public function getBodyFormat(); + + /** + * Sets the text format for the body of the topic. * - * @see \Drupal\Core\Render\Annotation\TextSection + * @param string $format + * The machine name of the text format to use for the topic body. */ - public function setBody(array $body); + public function setBodyFormat($format); /** * Returns whether this is a top-level topic or not. diff --git a/src/HelpViewBuilder.php b/src/HelpViewBuilder.php index 17ffb65..c7a928a 100644 --- a/src/HelpViewBuilder.php +++ b/src/HelpViewBuilder.php @@ -80,11 +80,14 @@ class HelpViewBuilder extends EntityViewBuilder { $build['#langcode'] = $langcode; $build['#title'] = $help_topic->label(); - // Add in the body. - $collections = $help_topic->getPluginCollections(); - /** @var \Drupal\config_help\TextSectionPluginCollection $body_collection */ - $body_collection = $collections['body']; - $build['#body'] = $body_collection->buildRenderArray([$this, 'processBodyItem']); + // Add in the body, with token replacement. + $bubbleable_metadata = new BubbleableMetadata(); + $build['#body'] = [ + '#type' => 'processed_text', + '#text' => $this->token->replace($help_topic->getBody(), [], [], $bubbleable_metadata), + '#format' => $help_topic->getBodyFormat(), + ]; + $bubbleable_metadata->applyTo($build['#body']); // Figure out which topics to list as related, including topics this // entity lists as related, plus topics that have said "Add me to this @@ -126,25 +129,4 @@ class HelpViewBuilder extends EntityViewBuilder { return $output; } - /** - * Processes a piece of text from the body. - * - * @param array $item - * Array containing the 'value' and 'format' elements from a single - * paragraph-sized piece of the body. - * - * @return array - * Render array section for this piece of the body, with tokens replaced. - */ - public function processBodyItem(array $item) { - $bubbleable_metadata = new BubbleableMetadata(); - $section = [ - '#type' => 'processed_text', - '#text' => $this->token->replace($item['value'], [], [], $bubbleable_metadata), - '#format' => $item['format'], - ]; - $bubbleable_metadata->applyTo($section); - return $section; - } - } diff --git a/src/Plugin/TextSection/BulletItem.php b/src/Plugin/TextSection/BulletItem.php deleted file mode 100644 index 035d310..0000000 --- a/src/Plugin/TextSection/BulletItem.php +++ /dev/null @@ -1,39 +0,0 @@ - 'item_list', - '#list_type' => 'ul', - '#items' => [], - ]; - - $group['#items'][] = $this->getInnerBuild(); - - return $group; - } - -} diff --git a/src/Plugin/TextSection/Code.php b/src/Plugin/TextSection/Code.php deleted file mode 100644 index d77d32d..0000000 --- a/src/Plugin/TextSection/Code.php +++ /dev/null @@ -1,26 +0,0 @@ - '
', - ] + parent::getInnerBuild(); - } - -} diff --git a/src/Plugin/TextSection/DescriptionName.php b/src/Plugin/TextSection/DescriptionName.php deleted file mode 100644 index 70e8362..0000000 --- a/src/Plugin/TextSection/DescriptionName.php +++ /dev/null @@ -1,53 +0,0 @@ - '', - '#suffix' => '- ', - '#suffix' => '
', - ] + parent::getInnerBuild(); - } - - /** - * {@inheritdoc} - */ - public function groupWith() { - return ['description_name', 'description_value']; - } - - /** - * {@inheritdoc} - */ - public function addToGroup(array $group) { - // Initialize the group, in case this is the first item. - $group += [ - '#prefix' => '- ',
- '#suffix' => '
- ', - '#suffix' => '
', - ] + parent::getInnerBuild(); - } - - /** - * {@inheritdoc} - */ - public function groupWith() { - return ['description_name', 'description_value']; - } - - /** - * {@inheritdoc} - */ - public function addToGroup(array $group) { - // Initialize the group, in case this is the first item. - $group += [ - '#prefix' => '- ',
- '#suffix' => '
', - '#suffix' => '
', - ] + parent::getInnerBuild(); - } - -} diff --git a/src/Plugin/TextSection/NumberedItem.php b/src/Plugin/TextSection/NumberedItem.php deleted file mode 100644 index 518a052..0000000 --- a/src/Plugin/TextSection/NumberedItem.php +++ /dev/null @@ -1,39 +0,0 @@ - 'item_list', - '#list_type' => 'ol', - '#items' => [], - ]; - - $group['#items'][] = $this->getInnerBuild(); - - return $group; - } - -} diff --git a/src/Plugin/TextSection/Paragraph.php b/src/Plugin/TextSection/Paragraph.php deleted file mode 100644 index 33752cc..0000000 --- a/src/Plugin/TextSection/Paragraph.php +++ /dev/null @@ -1,26 +0,0 @@ - '', - '#suffix' => '
', - ] + parent::getInnerBuild(); - } - -} diff --git a/src/Plugin/TextSection/SubHeading.php b/src/Plugin/TextSection/SubHeading.php deleted file mode 100644 index 95aa972..0000000 --- a/src/Plugin/TextSection/SubHeading.php +++ /dev/null @@ -1,26 +0,0 @@ - '', - '#suffix' => '
', - ] + parent::getInnerBuild(); - } - -} diff --git a/src/Plugin/TextSection/TextSectionBase.php b/src/Plugin/TextSection/TextSectionBase.php deleted file mode 100644 index 03270f5..0000000 --- a/src/Plugin/TextSection/TextSectionBase.php +++ /dev/null @@ -1,55 +0,0 @@ - $text]; - } - $this->text = $text; - } - - /** - * {@inheritdoc} - */ - public function getInnerBuild() { - return $this->text; - } - - /** - * {@inheritdoc} - */ - public function groupWith() { - return []; - } - - /** - * {@inheritdoc} - */ - public function addToGroup(array $group) { - return []; - } - -} diff --git a/src/TextSectionManager.php b/src/TextSectionManager.php deleted file mode 100644 index bbda01a..0000000 --- a/src/TextSectionManager.php +++ /dev/null @@ -1,96 +0,0 @@ -alterInfo('text_section_info'); - $this->setCacheBackend($cache_backend, 'text_section_plugins'); - } - - /** - * {@inheritdoc} - */ - public function findDefinitions() { - $definitions = parent::findDefinitions(); - uasort($definitions, [$this, 'sortPlugins']); - return $definitions; - } - - /** - * Makes an options array for a select list of text section plugins. - * - * @return array - * Array whose keys are machine names of text section plugins, and whose - * values are the translated labels for the plugins, suitable for use as - * options for radios or select lists. - */ - public function getOptionsList() { - $plugins = $this->getDefinitions(); - $options = []; - foreach ($plugins as $plugin_id => $plugin_definition) { - $options[$plugin_id] = $plugin_definition['label']; - } - - return $options; - } - - /** - * Provides a uasort() callback for sorting plugin definitions. - * - * Sorts by weight first, and within the same weight, alphabetically by - * label. - * - * @param array $definition1 - * First plugin definition to compare. - * @param array $definition2 - * Second plugin definition to compare. - * - * @return int - * A number <1 if the first plugin should come first, >1 if the second - * should, and 0 if this cannot be determined. - */ - protected function sortPlugins(array $definition1, array $definition2) { - if ($definition1['weight'] < $definition2['weight']) { - return -1; - } - if ($definition2['weight'] < $definition1['weight']) { - return 1; - } - if ($definition1['label'] < $definition2['label']) { - return -1; - } - if ($definition2['label'] < $definition1['label']) { - return 1; - } - return 0; - } - -} diff --git a/src/TextSectionPluginCollection.php b/src/TextSectionPluginCollection.php deleted file mode 100644 index 4ad83a0..0000000 --- a/src/TextSectionPluginCollection.php +++ /dev/null @@ -1,130 +0,0 @@ - 'text_sections', - '#sections' => [], - ]; - - $configuration = $this->getConfiguration(); - if (!$configuration) { - return $build; - } - - foreach ($configuration as $key => $item) { - $section = [ - '#section_type' => $item['id'], - '#text' => $item['text'], - ]; - if ($callback) { - $section['#text'] = call_user_func($callback, $section['#text']); - } - $build['#sections'][] = $section; - } - - return $build; - } - - /** - * Adds plugins to the collection from a text_sections render array. - * - * @param array $element - * Render array element of #type 'text_sections' to add plugins from. - * - * @return $this - * - * @see \Drupal\config_help\TextSectionPluginCollection::buildRenderArray() - */ - public function addFromRenderArray(array $element) { - $sections = $element['#sections']; - foreach ($sections as $index => $section) { - $this->addInstanceId($index, [ - 'id' => $section['#section_type'], - 'text' => $section['#text'], - ]); - } - - return $this; - } - - /** - * Pre-renders the current collection. - * - * @param \Drupal\Core\Render\Renderer $renderer - * The renderer service to use. - * @param array $element - * The render array to add information to. - * - * @return array - * Render array: starts with $element, and adds the formatted text from the - * plugins. - */ - public function preRenderCollection(Renderer $renderer, array $element) { - $previous_type = ''; - $group_build = []; - $element['text_sections'] = []; - - $all_configuration = $this->getConfiguration(); - foreach ($all_configuration as $id => $config) { - /** @var \Drupal\config_help\TextSectionPluginInterface $plugin */ - $plugin = $this->get($id); - $plugin->setText($config['text']); - $renderer->addCacheableDependency($element, $plugin); - - // Check for grouping. - $this_group_with = $plugin->groupWith(); - - if (!in_array($previous_type, $this_group_with) && !empty($group_build)) { - // This section should not be grouped with the previous one, so add the - // previous grouping to the element and reset the in-progress group. - $element['text_sections'][] = $group_build; - $group_build = []; - } - - if (!empty($this_group_with)) { - // This is a grouped section, either for a new group or a compatible - // group. Add this to the group, or initialize a new group. - $group_build = $plugin->addToGroup($group_build); - } - else { - // It is not grouped, so just add it to the element. - $element['text_sections'][] = $plugin->getInnerBuild(); - } - - // Save this type for the next grouping decision. - $previous_type = $plugin->getPluginId(); - } - - // Add the last in-progress group to the element if there is one. - if (!empty($group_build)) { - $element['text_sections'][] = $group_build; - } - - return $element; - } - -} diff --git a/src/TextSectionPluginInterface.php b/src/TextSectionPluginInterface.php deleted file mode 100644 index d69507b..0000000 --- a/src/TextSectionPluginInterface.php +++ /dev/null @@ -1,77 +0,0 @@ -link to the Help module topic, and it should link to the help admin page. Also there should be a related topic link below to the Help module topic page and the linked topic.' - format: help + text: 'This is a test. It should link to the Help module topic, and it should link to the help admin page. Also there should be a related topic link below to the Help module topic page and the linked topic.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml index 8ce3949..6bc550a 100644 --- a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml +++ b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_additional.yml @@ -14,7 +14,7 @@ list_on: - help_test body: - - id: paragraph - text: - value: 'This topic should get listed automatically on the Help test topic.' - format: help_plain + text: 'This topic should get listed automatically on the Help test topic.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml index 1f7f422..43ba6ee 100644 --- a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml +++ b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_linked.yml @@ -13,7 +13,7 @@ related: { } list_on: { } body: - - id: paragraph - text: - value: 'This topic is not supposed to be top-level.' - format: help + text: 'This topic is not supposed to be top-level.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml index 23a3101..2a608fb 100644 --- a/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml +++ b/tests/modules/config_help_test/config/optional/config_help.topic.help_test_locked.yml @@ -13,7 +13,7 @@ related: { } list_on: { } body: - - id: paragraph - text: - value: 'This topic is supposed to be locked to editing.' - format: help + text: 'This topic is supposed to be locked to editing.' + prefix_tags: '' + suffix_tags: '
' +body_format: help diff --git a/tests/src/Functional/HelpTopicAdminTest.php b/tests/src/Functional/HelpTopicAdminTest.php index ad84a8f..1f5fa9e 100644 --- a/tests/src/Functional/HelpTopicAdminTest.php +++ b/tests/src/Functional/HelpTopicAdminTest.php @@ -239,7 +239,7 @@ class HelpTopicAdminTest extends BrowserTestBase { 'label' => $title, 'id' => $id, 'top_level' => TRUE, - 'body[0][text][value]' => $body, + 'body[value]' => $body, ], 'Save'); $session = $this->assertSession(); $session->pageTextContains('Help topic added'); @@ -319,7 +319,7 @@ class HelpTopicAdminTest extends BrowserTestBase { 'label' => $title, 'id' => 'foobar', 'top_level' => TRUE, - 'body[0][text][value]' => $body, + 'body[value]' => $body, 'related' => 'invalid.text', ], 'Save'); $session = $this->assertSession(); diff --git a/tests/src/Functional/HelpTopicTest.php b/tests/src/Functional/HelpTopicTest.php index 1276884..b690837 100644 --- a/tests/src/Functional/HelpTopicTest.php +++ b/tests/src/Functional/HelpTopicTest.php @@ -116,7 +116,7 @@ class HelpTopicTest extends BrowserTestBase { $session->linkNotExists('ABC Help Test'); } - /** + /** * Tests export and import of help topics, and topic create from array. */ public function testTopicExportImport() { @@ -126,12 +126,14 @@ class HelpTopicTest extends BrowserTestBase { 'label' => 'Foo', 'body' => [ [ - 'type' => 'heading', 'text' => 'Greetings', + 'prefix_tags' => '', + 'suffix_tags' => '
', ], [ - 'type' => 'paragraph', 'text' => 'Hello, world!', + 'prefix_tags' => '', + 'suffix_tags' => '
', ], ], 'top_level' => TRUE, @@ -157,10 +159,10 @@ class HelpTopicTest extends BrowserTestBase { // Verify that everything is OK. $to_check = [ // This is an array of method name => component in $values, except - // dependencies, which are checked separately. + // dependencies and body, which are checked separately. 'id' => 'id', 'label' => 'label', - 'getBody' => 'body', + 'getBody' => FALSE, 'isTopLevel' => 'top_level', 'isLocked' => 'locked', 'getRelated' => 'related', @@ -176,11 +178,46 @@ class HelpTopicTest extends BrowserTestBase { } $this->assertEqual(call_user_func([$foo, $method]), call_user_func([$bar, $method]), 'Method ' . $method . ' is the same before and after export/import'); } + + // Check that the getEnforcedDepenencies() method works correctly. The + // getBody() and setBody() methods are checked in a different test method. $this->assertEqual($foo->getEnforcedDependencies(), $dependencies, 'Data for dependencies is the same as method getEnforcedDependencies'); } /** + * Tests the help topic body get and set functions. + */ + public function testTopicBodyGetSet() { + $topic = HelpTopic::create(); + + $body = '' . + 'A paragraph with attributes
' . + 'A heading
' . + 'A sub-heading
' . + '- Bullet 1
- Bullet 2
- Number 1
- Number 2
' . + 'Col 1 Col 2 Data 1 Data 2 - Item 1
- Definition 1
- Item 2
- Definition 2
', - '#suffix' => '
', - '#markup' => 'First H2 header', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'Second H2 header', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'First H3 sub-header', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'Second H3 sub-header', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'First paragraph', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'Second paragraph', - ], - [ - '#prefix' => '
', - '#markup' => 'Some code', - ], - [ - '#prefix' => '', - '#suffix' => '
', - '#markup' => 'More code', - ], - [ - '#theme' => 'item_list', - '#list_type' => 'ul', - '#items' => [ - ['#markup' => 'First list, first bullet'], - ['#markup' => 'First list, second bullet'], - ], - ], - [ - '#theme' => 'item_list', - '#list_type' => 'ol', - '#items' => [ - ['#markup' => 'Numbered list, first item'], - ['#markup' => 'Numbered list, second item'], - ], - ], - [ - '#prefix' => '', - '#suffix' => '- ',
- '#suffix' => '
- ', - '#suffix' => '
', - '#markup' => 'DL list, first name', - ], - [ - '#prefix' => '- ', - '#suffix' => '
', - '#markup' => 'DL list, first value', - ], - [ - '#prefix' => '- ', - '#suffix' => '
', - '#markup' => 'DL list, second name', - ], - [ - '#prefix' => '- ', - '#suffix' => '
', - '#markup' => 'DL list, second value', - ], - ], - ], - ]; - - $this->assertTrue($result['text_sections'] == $expected, 'Pre-processing behaved as expected'); - } - - /** - * Tests the options list for text sections. - */ - public function testOptionsList() { - /** @var \Drupal\config_help\TextSectionManager $manager */ - $manager = \Drupal::service('plugin.manager.text_section'); - $options = $manager->getOptionsList(); - - // The sorting of the list should be by weight first, then alphabetically - // by label. - $expected = [ - // Weight is -100. - 'paragraph' => 'Paragraph', - // Weight is -20. - 'heading' => 'Heading', - // Weight is -19. - 'subheading' => 'Sub-heading', - // Weight is -10. - 'bullet' => 'Bullet list item', - 'numbered' => 'Numbered list item', - // Weight is 10. - 'description_name' => 'Description list name item', - // Weight is 11. - 'description_value' => 'Description list value item', - // Weight is 100. - 'code' => 'Code', - ]; - - $this->assertTrue($options == $expected, 'Options list was as expected'); - } - -}
-