Problem/Motivation

The media library needs a field handler to select one or more items from a view. That is to be introduced in #2834729: [META] Roadmap to stabilize Media Library. Since a selection component is similar to a bulk form, but not exactly the same, it makes sense to refactor bulk forms to share their common implementation with select forms.

Proposed resolution

1. Extract some methods from the BulkForm to a base class and use it in BulkForm.
2. Change id generation in bulk forms so Ajax operations are also supported.

Remaining tasks

TBD

User interface changes

None.

API changes

The bulk form element IDs are changed because they are not unique if there is an Ajax action on the form. The current bulk form identifiers are increasing numeric items, which when an Ajax reload happens would not necessarily be the same anymore. $bulk_form_key becomes a unique identifier based on entity type, entity id, entity revision and language. This is important also if you want to reference a specific revision and/or language of an entity.

Data model changes

None.

CommentFileSizeAuthor
#29 2834777-nr-bot.txt132 bytesneeds-review-queue-bot
#17 2834777-17.patch12.1 KBchr.fritsch
#11 interdiff-6-11.txt1.02 KBseanB
#11 2834777-11.patch11.54 KBseanB
#6 2834777-6.patch11.54 KBwebflo
#5 2834777-5.patch11.54 KBwebflo
#4 2834777-4.patch17.11 KBwebflo
#2 2834777-1.patch11.91 KBwebflo
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

webflo created an issue. See original summary.

webflo’s picture

webflo CreditAttribution: webflo at UEBERBIT GmbH commented
Status: Active » Needs review
FileSize
2834777-1.patch11.91 KB

Status: Needs review » Needs work

The last submitted patch, 2: 2834777-1.patch, failed testing.

webflo’s picture

webflo CreditAttribution: webflo at UEBERBIT GmbH commented
FileSize
2834777-4.patch17.11 KB
webflo’s picture

webflo CreditAttribution: webflo at UEBERBIT GmbH commented
FileSize
2834777-5.patch11.54 KB
webflo’s picture

webflo CreditAttribution: webflo at UEBERBIT GmbH commented
FileSize
2834777-6.patch11.54 KB
Gábor Hojtsy’s picture

Gábor Hojtsy
he/him
Primary language Hungarian
Location Hungary
CreditAttribution: Gábor Hojtsy at Acquia commented

There is no SelectForm plugin yet in this patch. if that proposed for inclusion in views module? I was curious why is this against the system component, so:

+++ b/core/lib/Drupal/Component/Plugin/PluginBase.php
@@ -93,4 +97,73 @@ public function getPluginDefinition() {
+  /**
+   * Calculates a bulk form key.
+   *
+   * This generates a key that is used as the checkbox return value when
+   * submitting a bulk form. This key allows the entity for the row to be loaded
+   * totally independently of the executed view row.
...
+  /**
+   * Loads an entity based on a bulk form key.
+   *
+   * @param string $bulk_form_key

Does this functionality REALLY belong in a general PluginBase component? Would this be so widely applicable?

webflo’s picture

webflo CreditAttribution: webflo at UEBERBIT GmbH commented

Thanks for the review, i have to rewrite a new issue summary because i just created a new base class. The SelectForm plugin itself is currently media_library. $bulk_form_key is super helpful because it creates a unique identifier based on entity type, entity id, entity revision and language. This is important if you want to reference a specific revision and/or language of a entity.

Gábor Hojtsy’s picture

Gábor Hojtsy
he/him
Primary language Hungarian
Location Hungary
CreditAttribution: Gábor Hojtsy at Acquia commented
Title: Create a "Select item" views field handler » Refactor Drupal\system\Plugin\views\field\BulkForm to support a select form as well
Issue summary: View changes

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

seanB’s picture

seanB
Primary language Dutch
Location Netherlands
CreditAttribution: seanB commented
FileSize
2834777-11.patch11.54 KB
interdiff-6-11.txt1.02 KB

Rerolled since patch no longer applied (short array syntax caused the issue).

chr.fritsch’s picture

chr.fritsch
he/him
Primary language German
Location 🇩🇪🇪🇺🌍
CreditAttribution: chr.fritsch at Thunder commented
Status: Needs work » Needs review

Let's trigger testbot

The last submitted patch, 4: 2834777-4.patch, failed testing.

The last submitted patch, 5: 2834777-5.patch, failed testing.

The last submitted patch, 6: 2834777-6.patch, failed testing.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

chr.fritsch’s picture

chr.fritsch
he/him
Primary language German
Location 🇩🇪🇪🇺🌍
CreditAttribution: chr.fritsch at Thunder commented
Issue tags: +Needs tests
FileSize
2834777-17.patch12.1 KB

Rerolled because of #2916451: Move everything related to Bulk Form to Views module lands in between.

I also think we should have some tests here.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Parent issue: #2834729: [META] Roadmap to stabilize Media Library »

This issue no longer blocks any media library work, so we can remove #2834729: [META] Roadmap to stabilize Media Library as the parent issue.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

needs-review-queue-bot’s picture

needs-review-queue-bot CreditAttribution: needs-review-queue-bot as a volunteer commented
Status: Needs review » Needs work
FileSize
2834777-nr-bot.txt132 bytes

The Needs Review Queue Bot tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.