diff --git a/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php b/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php index e1b1c2a8f5..c2df233b9e 100644 --- a/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php +++ b/core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php @@ -239,6 +239,28 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen // title of the 'uri' element. if ($this->getFieldSetting('title') == DRUPAL_DISABLED) { $element['uri']['#title'] = $element['#title']; + // By default the field description is added to the title field. Since + // the title field is disabled, we add the description, if given, to the + // uri element instead. + if (!empty($element['#description'])) { + if (empty($element['uri']['#description'])) { + $element['uri']['#description'] = $element['#description']; + } + else { + // If we have the description of the type of field together with + // the user provided description, we want to make a distinction + // between "core help text" and "user entered help text". To make + // this distinction more clear, we put them in an unordered list. + $element['uri']['#description'] = [ + '#theme' => 'item_list', + '#items' => [ + // User description first to avoid screen reader users to skip. + $element['#description'], + $element['uri']['#description'], + ], + ]; + } + } } // Otherwise wrap everything in a details element. else { diff --git a/core/modules/link/tests/src/Functional/LinkFieldUITest.php b/core/modules/link/tests/src/Functional/LinkFieldUITest.php index c990e6439d..5b35412244 100644 --- a/core/modules/link/tests/src/Functional/LinkFieldUITest.php +++ b/core/modules/link/tests/src/Functional/LinkFieldUITest.php @@ -2,7 +2,11 @@ namespace Drupal\Tests\link\Functional; +use Drupal\Component\Utility\Html; use Drupal\Component\Utility\Unicode; +use Drupal\Core\Entity\Entity\EntityFormDisplay; +use Drupal\field\Entity\FieldConfig; +use Drupal\field\Entity\FieldStorageConfig; use Drupal\field_ui\Tests\FieldUiTestTrait; use Drupal\link\LinkItemInterface; use Drupal\Tests\BrowserTestBase; @@ -48,13 +52,16 @@ function testFieldUI() { // Add a content type. $type = $this->drupalCreateContentType(); $type_path = 'admin/structure/types/manage/' . $type->id(); - $add_path = 'node/add/' . $type->id(); // Add a link field to the newly-created type. It defaults to allowing both // internal and external links. - $label = $this->randomMachineName(); + $label = 'link_field_label'; + $description = 'link field description'; $field_name = Unicode::strtolower($label); - $this->fieldUIAddNewField($type_path, $field_name, $label, 'link'); + $field_edit = [ + 'description' => $description, + ]; + $this->fieldUIAddNewField($type_path, $field_name, $label, 'link', [], $field_edit); // Load the formatter page to check that the settings summary does not // generate warnings. @@ -62,31 +69,152 @@ function testFieldUI() { $this->drupalGet("$type_path/display"); $this->assertText(t('Link text trimmed to @limit characters', ['@limit' => 80])); - // Test the help text displays when the link field allows both internal and - // external links. + // Test the displaying of help texts for the link field. + $test_cases = []; + + // There are many combinations of field settings: where the description + // should show: variation on internal, external, both; cardinality (where + // the fieldset is hidden or used); and link text shown (required or + // optional) or disabled. There are two descriptions: field and URL help + // text. + $cardinalities = [1, 2]; + $title_settings = [ + DRUPAL_DISABLED, + DRUPAL_OPTIONAL, + ]; + $link_types = [ + LinkItemInterface::LINK_EXTERNAL, + LinkItemInterface::LINK_GENERIC, + LinkItemInterface::LINK_INTERNAL, + ]; + + // Test all variations of link types on all cardinalities. + foreach ($cardinalities as $cardinality) { + foreach ($link_types as $link_type) { + // Now, test this with both the title enabled and disabled. + foreach ($title_settings as $title_setting) { + // Test both empty and non-empty labels. + foreach ([TRUE, FALSE] as $label_provided) { + // Generate a unique ID for the field so it can be identified in the + // test. + $id = implode('_', [ + 'link', + $cardinality, + $link_type, + $title_setting, + (int) $label_provided, + ]); + + // Use a unique label that contains some HTML. + $label = '' . $id; + + $test_cases[$id] = [ + 'cardinality' => $cardinality, + 'link_type' => $link_type, + 'title' => $title_setting, + 'label' => $label_provided ? $label : '', + ]; + } + } + } + } + + // Create a new content type and add the test fields to it. + $type = $this->drupalCreateContentType(); + foreach ($test_cases as $field_name => $test_case) { + $storage = FieldStorageConfig::create([ + 'field_name' => $field_name, + 'entity_type' => 'node', + 'type' => 'link', + 'cardinality' => $test_case['cardinality'], + ]); + $storage->save(); + + FieldConfig::create([ + 'field_storage' => $storage, + 'label' => $test_case['label'], + 'bundle' => $type->id(), + 'settings' => [ + 'title' => $test_case['title'], + 'link_type' => $test_case['link_type'], + ], + ])->save(); + } + + // Make the fields visible in the form display. + $form_display_id = implode('.', ['node', $type->id(), 'default']); + $form_display = EntityFormDisplay::load($form_display_id); + foreach ($test_cases as $field_name => $test_case) { + $form_display->setComponent($field_name, ['region' => 'content']); + } + $form_display->save(); + + // Log in a user that is allowed to create this content type, see if + // the user can see the expected help text. $this->drupalLogin($this->drupalCreateUser(['create ' . $type->id() . ' content'])); + + $add_path = 'node/add/' . $type->id(); $this->drupalGet($add_path); - $this->assertRaw('You can also enter an internal path such as /node/add or an external URL such as http://example.com.'); - // Log in an admin to set up the next content type. - $this->drupalLogin($this->adminUser); + $expected_help_texts = [ + LinkItemInterface::LINK_EXTERNAL => 'This must be an external URL such as http://example.com.', + LinkItemInterface::LINK_GENERIC => 'You can also enter an internal path such as /node/add or an external URL such as http://example.com. Enter <front> to link to the front page.', + LinkItemInterface::LINK_INTERNAL => rtrim(\Drupal::url('', [], ['absolute' => TRUE]), '/'), + ]; + + foreach($test_cases as $field_name => $test_case) { + // Check that the help texts we assume should be there, is there. + $this->assertFieldContainsRawText($field_name, $expected_help_texts[$test_case['link_type']]); + if ($test_case['link_type'] === LinkItemInterface::LINK_INTERNAL) { + // Internal links have no "system" description. Test that none + // of the other help texts show here. + $this->assertNoFieldContainsRawText($field_name, $expected_help_texts[LinkItemInterface::LINK_EXTERNAL]); + $this->assertNoFieldContainsRawText($field_name, $expected_help_texts[LinkItemInterface::LINK_GENERIC]); + } + // Also assert that the description we made is here, no matter what the + // cardinality or link setting. + if (!empty($test_case['label'])) { + $this->assertFieldContainsRawText($field_name, $test_case['label']); + } + } + } - // Add a different content type. - $type = $this->drupalCreateContentType(); - $type_path = 'admin/structure/types/manage/' . $type->id(); - $add_path = 'node/add/' . $type->id(); + /** + * Checks that given field contains the given raw text. + * + * @param string $field_name + * The name of the field to check. + * @param string $text + * The text to check. + */ + protected function assertFieldContainsRawText($field_name, $text) { + $this->assertTrue((bool) preg_match('/' . preg_quote($text, '/') . '/ui', $this->getFieldHtml($field_name))); + } - // Add a link field to the newly-created type. Specify it must allow - // external only links. - $label = $this->randomMachineName(); - $field_name = Unicode::strtolower($label); - $field_edit = ['settings[link_type]' => LinkItemInterface::LINK_EXTERNAL]; - $this->fieldUIAddNewField($type_path, $field_name, $label, 'link', [], $field_edit); + /** + * Checks that given field does not contain the given raw text. + * + * @param string $field_name + * The name of the field to check. + * @param string $text + * The text to check. + */ + protected function assertNoFieldContainsRawText($field_name, $text) { + $this->assertFalse((bool) preg_match('/' . preg_quote($text, '/') . '/ui', $this->getFieldHtml($field_name))); + } - // Test the help text displays when link allows only external links. - $this->drupalLogin($this->drupalCreateUser(['create ' . $type->id() . ' content'])); - $this->drupalGet($add_path); - $this->assertRaw('This must be an external URL such as http://example.com.'); + /** + * Returns the raw HTML for the given field. + * + * @param $field_name + * The name of the field for which to return the HTML. + * + * @return string + * The raw HTML. + */ + protected function getFieldHtml($field_name) { + $css_id = Html::cleanCssIdentifier("edit-$field_name-wrapper"); + return $this->xpath("//div[@id='$css_id']")[0]->getHtml(); } } diff --git a/core/modules/menu_link_content/src/Tests/MenuLinkContentFormTest.php b/core/modules/menu_link_content/src/Tests/MenuLinkContentFormTest.php index c8244fe089..ddffa94008 100644 --- a/core/modules/menu_link_content/src/Tests/MenuLinkContentFormTest.php +++ b/core/modules/menu_link_content/src/Tests/MenuLinkContentFormTest.php @@ -37,6 +37,8 @@ public function testMenuLinkContentForm() { $element = $this->xpath('//select[@id = :id]/option[@selected]', [':id' => 'edit-menu-parent']); $this->assertTrue($element, 'A default menu parent was found.'); $this->assertEqual('admin:', $element[0]['value'], ' menu is the parent.'); + // Test that the field description is present. + $this->assertRaw('The location this menu link points to.'); $this->drupalPostForm( NULL, diff --git a/core/modules/shortcut/src/Tests/ShortcutLinksTest.php b/core/modules/shortcut/src/Tests/ShortcutLinksTest.php index cf4ae0fbe5..3406576c59 100644 --- a/core/modules/shortcut/src/Tests/ShortcutLinksTest.php +++ b/core/modules/shortcut/src/Tests/ShortcutLinksTest.php @@ -62,6 +62,11 @@ public function testShortcutLinkAdd() { '/admin/config/system/site-information', ]; + // Test the add shortcut form UI. Test that the base field description is + // there. + $this->drupalGet('admin/config/user-interface/shortcut/manage/' . $set->id() . '/add-link'); + $this->assertRaw('The location this shortcut points to.'); + // Check that each new shortcut links where it should. foreach ($test_cases as $test_path) { $title = $this->randomMachineName();