diff --git a/core/lib/Drupal/Core/Field/WidgetBase.php b/core/lib/Drupal/Core/Field/WidgetBase.php index b1579f2445..bc448ecb55 100644 --- a/core/lib/Drupal/Core/Field/WidgetBase.php +++ b/core/lib/Drupal/Core/Field/WidgetBase.php @@ -241,8 +241,20 @@ protected function formMultipleElements(FieldItemListInterface $items, array &$f ], ]; } - } + // Allow modules to alter the field multiple widget form element. + $context = [ + 'form' => $form, + 'widget' => $this, + 'items' => $items, + 'delta' => $delta, + 'default' => $this->isDefaultValueWidget($form_state), + ]; + \Drupal::moduleHandler()->alter([ + 'field_widget_multiple_form', + 'field_widget_multiple_' . $this->getPluginId() . '_form', + ], $elements, $form_state, $context); + } return $elements; } @@ -311,12 +323,14 @@ public static function addMoreAjax(array $form, FormStateInterface $form_state) * Generates the form element for a single copy of the widget. */ protected function formSingleElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) { + $cardinality = $this->fieldDefinition->getFieldStorageDefinition()->getCardinality(); $element += [ '#field_parents' => $form['#parents'], // Only the first widget should be required. '#required' => $delta == 0 && $this->fieldDefinition->isRequired(), '#delta' => $delta, '#weight' => $delta, + '#cardinality' => $cardinality, ]; $element = $this->formElement($items, $delta, $element, $form, $form_state); diff --git a/core/modules/field/field.api.php b/core/modules/field/field.api.php index 130f923180..1fd8427e8c 100644 --- a/core/modules/field/field.api.php +++ b/core/modules/field/field.api.php @@ -183,6 +183,7 @@ function hook_field_widget_info_alter(array &$info) { * @see \Drupal\Core\Field\WidgetBaseInterface::form() * @see \Drupal\Core\Field\WidgetBase::formSingleElement() * @see hook_field_widget_WIDGET_TYPE_form_alter() + * @see hook_field_widget_multiple_form_alter() */ function hook_field_widget_form_alter(&$element, \Drupal\Core\Form\FormStateInterface $form_state, $context) { // Add a css class to widget form elements for all fields of type mytype. @@ -212,6 +213,7 @@ function hook_field_widget_form_alter(&$element, \Drupal\Core\Form\FormStateInte * @see \Drupal\Core\Field\WidgetBaseInterface::form() * @see \Drupal\Core\Field\WidgetBase::formSingleElement() * @see hook_field_widget_form_alter() + * @see hook_field_widget_multiple_WIDGET_TYPE_form_alter() */ function hook_field_widget_WIDGET_TYPE_form_alter(&$element, \Drupal\Core\Form\FormStateInterface $form_state, $context) { // Code here will only act on widgets of type WIDGET_TYPE. For example, @@ -220,6 +222,77 @@ function hook_field_widget_WIDGET_TYPE_form_alter(&$element, \Drupal\Core\Form\F $element['#autocomplete_route_name'] = 'mymodule.autocomplete_route'; } +/** + * Alter forms for multivalue field widgets provided by other modules. + * + * To adjust the individual widgets for the values themselves, use + * hook_field_widget_form_alter() instead. + * + * @param array $elements + * The field widget form elements as constructed by + * \Drupal\Core\Field\WidgetBaseInterface::formMultipleElements(). + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * @param array $context + * An associative array containing the following key-value pairs: + * - form: The form structure to which widgets are being attached. This may be + * a full form structure, or a sub-element of a larger form. + * - widget: The widget plugin instance. + * - items: The field values, as a + * \Drupal\Core\Field\FieldItemListInterface object. + * - delta: The order of this item in the array of subelements (0, 1, 2, etc). + * - default: A boolean indicating whether the form is being shown as a dummy + * form to set default values. + * + * @see \Drupal\Core\Field\WidgetBaseInterface::form() + * @see \Drupal\Core\Field\WidgetBase::formSingleElement() + * @see hook_field_widget_form_alter() + * @see hook_field_widget_multiple_WIDGET_TYPE_form_alter() + */ +function hook_field_widget_multiple_form_alter(array &$elements, \Drupal\Core\Form\FormStateInterface $form_state, array $context) { + // Add a css class to the overall element of any widget. + $elements['#attributes']['class'][] = 'myclass'; +} + +/** + * Alter multi-value widget forms for a widget provided by another module. + * + * Modules can implement hook_field_widget_multiple_WIDGET_TYPE_form_alter() to + * modify a specific widget form, rather than using + * hook_field_widget_form_alter() and checking the widget type. + * + * To modify the widget for individual items, use + * hook_field_widget_WIDGET_TYPE_form_alter() instead. + * + * @param array $elements + * The field widget form elements as constructed by + * \Drupal\Core\Field\WidgetBaseInterface::formMultipleElements(). + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * @param array $context + * An associative array. See hook_field_widget_form_alter() for the structure + * and content of the array. + * + * @see \Drupal\Core\Field\WidgetBaseInterface::form() + * @see \Drupal\Core\Field\WidgetBase::formSingleElement() + * @see hook_field_widget_multiple_form_alter() + */ +function hook_field_widget_multiple_WIDGET_TYPE_form_alter(array &$elements, \Drupal\Core\Form\FormStateInterface $form_state, array $context) { + // Alter the overall title for the multivalue widget (the table header, + // above the rows). + $elements['#title'] = t('Review your %title entries', ['%title' => $elements['#title']]); + + if (!empty($elements['#description'])) { + // Add a paragraph to the description, above all the rows. + $elements['#description'] = [ + '#markup' => $elements['#description'], + ]; + } + else { + $elements['#description'] = t('These items might be out of date.'); + } +} + /** * @} End of "defgroup field_widget". */ diff --git a/core/modules/media/media.module b/core/modules/media/media.module index 296945973a..cb587d613d 100644 --- a/core/modules/media/media.module +++ b/core/modules/media/media.module @@ -9,6 +9,7 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Render\Element; +use Drupal\Core\Render\Markup; use Drupal\Core\Routing\RouteMatchInterface; use Drupal\Core\Session\AccountInterface; use Drupal\Core\Url; @@ -66,6 +67,10 @@ function media_theme() { 'media' => [ 'render element' => 'elements', ], + 'media_reference_help' => [ + 'render element' => 'element', + 'base hook' => 'field_multiple_value_form', + ], ]; } @@ -172,3 +177,64 @@ function media_form_field_ui_field_storage_add_form_alter(&$form, FormStateInter $form['add']['new_storage_type']['#weight'] = 0; $form['add']['description_wrapper']['#weight'] = 1; } + +/** + * Implements hook_field_widget_multiple_WIDGET_TYPE_form_alter(). + */ +function media_field_widget_multiple_entity_reference_autocomplete_form_alter(array &$elements, FormStateInterface $form_state, array $context) { + // Add a description to inform users where they can find and add new media. + // Only add the description on autocomplete widgets for entity reference + // field pointing to media. + if (!empty($elements[0]['target_id']['#type']) && ($elements[0]['target_id']['#type'] === 'entity_autocomplete') && ($elements[0]['target_id']['#target_type'] === 'media')) { + $elements['#theme'] = 'media_reference_help'; + + // Customize the label for the field widget. + $label = $elements['#title']; + $elements['#original_label'] = $label; + $use_existing_label = t('Use existing %title', ['%title' => $label]); + + if ($elements['#cardinality'] === 1) { + $elements[0]['target_id']['#title'] = $use_existing_label; + } + else { + $elements['#title'] = $use_existing_label; + } + } +} + +/** + * Implements hook_preprocess_HOOK() for media reference widgets. + */ +function media_preprocess_media_reference_help(&$variables) { + $element = $variables['element']; + // Use the user-defined label for the field to indicate that the form allows + // reusing existing media. + $variables['label'] = $element['#original_label']; + + if (!empty($element[0]['target_id']['#selection_settings']['target_bundles'])) { + $bundles = $element[0]['target_id']['#selection_settings']['target_bundles']; + $variables['types'] = implode(", ", $bundles); + $create_bundles = []; + $access_handler = \Drupal::entityTypeManager()->getAccessControlHandler('media'); + foreach ($bundles as $bundle) { + if ($access_handler->createAccess($bundle)) { + $create_bundles[] = $bundle; + if (count($create_bundles) > 1) { + // If the user has access to create more than 1 bundle then the + // individual media type form can not be used. + break; + } + } + } + if (count($create_bundles) === 1) { + $variables['media_add_page'] = Url::fromRoute('entity.media.add_form')->setRouteParameter('media_type', $create_bundles[0])->toString(); + } + elseif (count($create_bundles) > 1) { + $variables['media_add_page'] = Url::fromRoute('entity.media.add_page')->toString(); + } + $overview_url = Url::fromRoute('entity.media.collection'); + if ($overview_url->access()) { + $variables['media_list'] = $overview_url->toString(); + } + } +} diff --git a/core/modules/media/templates/media-reference-help.html.twig b/core/modules/media/templates/media-reference-help.html.twig new file mode 100644 index 0000000000..7a37194812 --- /dev/null +++ b/core/modules/media/templates/media-reference-help.html.twig @@ -0,0 +1,57 @@ +{# +/** + * @file + * Theme override for media reference fields. + * + * @see template_preprocess_field_multiple_value_form() + */ +#} +
+ {{ label }} + + {% if media_add_page %} +

+ {% trans %} + Create new {{ label|placeholder }} + {% endtrans %} +

+ {% trans %} + Create your media on the media add page (opens a new window), then add it by name to the field below. + {% endtrans %} + {% endif %} + + {% if multiple %} +
+ {{ table }} + {% else %} + {% for element in elements %} + {{ element }} + {% endfor %} + {% endif %} + + + {% trans %} + Type part of the media name. + {% endtrans %} + {% if media_list %} + {% trans %} + See the media list (opens a new window) to help locate media. + {% endtrans %} + {% endif %} + {% trans %} + Allowed media types: {{ types|placeholder }} + {% endtrans %} + {% if multiple %} + {% if description.content %} + {{ description.content }} + {% endif %} + {% if button %} +
{{ button }}
+ {% endif %} + {% endif %} +
+ + {% if multiple %} + + {% endif %} +
diff --git a/core/modules/media/tests/src/Functional/MediaFunctionalTestTrait.php b/core/modules/media/tests/src/Functional/MediaFunctionalTestTrait.php index 224bb426e3..379ba74717 100644 --- a/core/modules/media/tests/src/Functional/MediaFunctionalTestTrait.php +++ b/core/modules/media/tests/src/Functional/MediaFunctionalTestTrait.php @@ -14,6 +14,7 @@ */ protected static $adminUserPermissions = [ // Media module permissions. + 'access media overview', 'administer media', 'administer media fields', 'administer media form display', diff --git a/core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php b/core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php index 8d876b7b0d..49e6db3295 100644 --- a/core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php +++ b/core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php @@ -2,7 +2,12 @@ namespace Drupal\Tests\media\Functional; +use Behat\Mink\Element\NodeElement; use Drupal\media\Entity\Media; +use Drupal\Core\Field\FieldStorageDefinitionInterface; +use Drupal\Core\Url; +use Drupal\field\Entity\FieldConfig; +use Drupal\field\Entity\FieldStorageConfig; /** * Ensures that media UI works correctly. @@ -21,6 +26,13 @@ class MediaUiFunctionalTest extends MediaFunctionalTestBase { 'media_test_source', ]; + /** + * The assertion session. + * + * @var \Behat\Mink\Session + */ + protected $session; + /** * {@inheritdoc} */ @@ -192,6 +204,294 @@ public function testRenderedEntityReferencedMedia() { $assert_session->fieldValueEquals('fields[field_foo_field][type]', 'entity_reference_entity_view'); } + /** + * Data provider for testMediaReferenceWidget(). + * + * @return array[] + * Test data. See testMediaReferenceWidget() for the child array structure. + */ + public function providerTestMediaReferenceWidget() { + return [ + // Single-value fields with a single media type: + // - The user can create and list the media. + 'single_value:single_type:create_list' => [1, [TRUE], TRUE], + + // - The user can list but not create the media. + 'single_value:single_type:list' => [1, [FALSE], TRUE], + // - The user can create but not list the media. + 'single_value:single_type:create' => [1, [TRUE], FALSE], + // - The user can neither create nor list the media. + 'single_value:single_type' => [1, [FALSE], FALSE], + + // Single-value fields with two media types: + // - The user can create both types. + 'single_value:two_type:create2_list' => [1, [TRUE, TRUE], TRUE], + // - The user can create only one type. + 'single_value:two_type:create1_list' => [1, [TRUE, FALSE], TRUE], + // - The user cannot create either type. + 'single_value:two_type:list' => [1, [FALSE, FALSE], TRUE], + + // Multiple-value field with a cardinality of 3, with media the user can + // create and list. + 'multi_value:single_type:create_list' => [3, [TRUE], TRUE], + + // Unlimited value field. + 'unlimited_value:single_type:create_list' => [FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, [TRUE], TRUE], + ]; + } + + /** + * Test the default autocomplete widgets for media reference fields. + * + * @param int $cardinality + * The field cardinality. + * @param bool[] $media_type_create_access + * An array of booleans indicating whether to grant the test user create + * access for each media type. A media type is created automatically for + * each; for example, an array [TRUE, FALSE] would create two media types, + * one that allows the user to create media and a second that does not. + * @param bool $list_access + * Whether to grant the test user access to list media. + * + * @see media_field_widget_entity_reference_autocomplete_form_alter() + * @see media_field_widget_multiple_entity_reference_autocomplete_form_alter() + * + * @dataProvider providerTestMediaReferenceWidget + */ + public function testMediaReferenceWidget($cardinality, array $media_type_create_access, $list_access) { + $this->session = $this->assertSession(); + + // Create two content types. + $non_media_content_type = $this->createContentType(); + $content_type = $this->createContentType(); + + // Create some media types. + $media_types = []; + $permissions = []; + $create_media_types = []; + foreach ($media_type_create_access as $id => $access) { + if ($access) { + $create_media_types[] = "media_type_$id"; + $permissions[] = "create media_type_$id media"; + } + $this->createMediaType(['bundle' => "media_type_$id"]); + $media_types["media_type_$id"] = "media_type_$id"; + } + + // Create a user that can create content of the type, with other + // permissions as given by the data provider. + $permissions[] = "create {$content_type->id()} content"; + if ($list_access) { + $permissions[] = "access media overview"; + } + $test_user = $this->drupalCreateUser($permissions); + + // Create a non-media entity reference. + $non_media_storage = FieldStorageConfig::create([ + 'field_name' => 'field_not_a_media_field', + 'entity_type' => 'node', + 'type' => 'entity_reference', + 'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED, + 'settings' => [ + 'target_type' => 'node', + ], + ]); + $non_media_storage->save(); + $non_media_field = FieldConfig::create([ + 'label' => 'No media here!', + 'field_storage' => $non_media_storage, + 'entity_type' => 'node', + 'bundle' => $non_media_content_type->id(), + 'settings' => [ + 'handler' => 'default', + 'handler_settings' => [ + 'target_bundles' => [ + $non_media_content_type->id() => $non_media_content_type->id(), + ], + ], + ], + ]); + $non_media_field->save(); + entity_get_form_display('node', $non_media_content_type->id(), 'default') + ->setComponent('field_not_a_media_field', [ + 'type' => 'entity_reference_autocomplete', + ]) + ->save(); + + // Create a media field. + $storage = FieldStorageConfig::create([ + 'field_name' => "field_media_reference", + 'entity_type' => 'node', + 'type' => 'entity_reference', + 'cardinality' => $cardinality, + 'settings' => [ + 'target_type' => 'media', + ], + ]); + $storage->save(); + $field = FieldConfig::create([ + 'label' => "Media (cardinality $cardinality)", + 'field_storage' => $storage, + 'entity_type' => 'node', + 'bundle' => $content_type->id(), + 'settings' => [ + 'handler' => 'default', + 'handler_settings' => [ + 'target_bundles' => $media_types, + ], + ], + ]); + $field->save(); + entity_get_form_display('node', $content_type->id(), 'default') + ->setComponent('field_media_reference', [ + 'type' => 'entity_reference_autocomplete', + ]) + ->save(); + + // Some of the expected texts. + $create_help = 'Create your media on the media add page (opens a new window), then add it by name to the field below.'; + $list_text = 'See the media list (opens a new window) to help locate media.'; + $use_help = 'Type part of the media name.'; + + // First check that none of the help texts are on the non-media content. + $this->drupalGet("/node/add/{$non_media_content_type->id()}"); + $this->assertNoHelpTexts([ + 'Create new', + $create_help, + 'Use existing', + $use_help, + $list_text, + 'Allowed media types:', + ]); + + // Now, check that the widget displays the expected help text under the + // given conditions for the test user. + $this->drupalLogin($test_user); + $this->drupalGet("/node/add/{$content_type->id()}"); + + // Specific expected help texts for the media field. + $create_header = "Create new {$field->getLabel()}"; + $use_header = "Use existing {$field->getLabel()}"; + $type_list = 'Allowed media types: ' . implode(", ", array_keys($media_types)); + + $fieldset_selector = '#edit-field-media-reference-wrapper fieldset'; + $fieldset = $this->session->elementExists('css', $fieldset_selector); + + $this->assertSame($field->getLabel(), $this->session->elementExists('css', 'legend', $fieldset)->getText()); + + // Assert text that should be displayed regardless of other access. + $this->assertHelpTexts([$use_header, $use_help, $type_list], $fieldset_selector); + + // The entire section for creating new media should only be displayed if + // the user can create at least one media of the type. + if ($create_media_types) { + if (count($create_media_types) === 1) { + $url = Url::fromRoute('entity.media.add_form')->setRouteParameter('media_type', $create_media_types[0]); + } + else { + $url = Url::fromRoute('entity.media.add_page'); + } + $this->assertHelpTexts([$create_header, $create_help], $fieldset_selector); + $this->assertHelpLink( + $fieldset, + 'media add page', + [ + 'target' => '_blank', + 'href' => $url->toString(), + ] + ); + } + else { + $this->assertNoHelpTexts([$create_header, $create_help]); + $this->assertNoHelpLink($fieldset, 'media add page'); + } + + if ($list_access) { + $this->assertHelpTexts([$list_text], $fieldset_selector); + $this->assertHelpLink( + $fieldset, + 'media list', + [ + 'target' => '_blank', + 'href' => Url::fromRoute('entity.media.collection')->toString(), + ] + ); + } + else { + $this->assertNoHelpTexts([$list_text]); + $this->assertNoHelpLink($fieldset, 'media list'); + } + } + + /** + * Asserts that the given texts are present exactly once. + * + * @param string[] $texts + * A list of the help texts to check. + * @param string $selector + * (optional) The selector to search. + */ + public function assertHelpTexts(array $texts, $selector = '') { + foreach ($texts as $text) { + // We only want to escape single quotes, so use str_replace() rather than + // addslashes(). + $text = str_replace("'", "\'", $text); + if ($selector) { + $this->session->elementsCount('css', $selector . ":contains('$text')", 1); + } + else { + $this->session->pageTextContains($text); + } + } + } + + /** + * Asserts that none of the given texts are present. + * + * @param string[] $texts + * A list of the help texts to check. + */ + public function assertNoHelpTexts(array $texts) { + foreach ($texts as $text) { + $this->session->pageTextNotContains($text); + } + } + + /** + * Asserts whether a given link is present. + * + * @param \Behat\Mink\Element\NodeElement $element + * The element to search. + * @param string $text + * The link text. + * @param string[] attributes + * An associative array of any expected attributes, keyed by the + * attribute name. + */ + protected function assertHelpLink(NodeElement $element, $text, array $attributes = []) { + // Find all the links inside the element. + $link = $element->findLink($text); + + $this->assertNotEmpty($link); + foreach ($attributes as $attribute => $value) { + $this->assertEquals($link->getAttribute($attribute), $value); + } + } + + /** + * Asserts that a given link is not present. + * + * @param \Behat\Mink\Element\NodeElement $element + * The element to search. + * @param string $text + * The link text. + */ + protected function assertNoHelpLink(NodeElement $element, $text) { + // Assert that the link and its text are not present anywhere on the page. + $this->session->elementNotExists('named', ['link', $text], $element); + $this->session->pageTextNotContains($text); + } + /** * Test the media collection route. */