Provide method for views widget to filter based on context

Lightning is using this patch. It works for us, and we like it too. I think that's RTBC.

+++ b/src/Plugin/Field/FieldWidget/EntityReferenceBrowserWidget.php
@@ -560,11 +560,15 @@
+    $handler = $settings['handler_settings'];
...
+      'widget_context' => [
+        'target_bundles' => !empty($handler['target_bundles']) ? $handler['target_bundles'] : [],

This is assuming a specific entity reference selection display plugin (which probably covers a good portion of the use cases).

It would be very hand to do this generally but at least we should to the empty check or something along those lines to prevent notices from happening.

The fact that the tests didn't detect that make me think that we should improve those too.

After reviewing the patch I agree with phenaproxima. The patch does what it says on the tin and the code looks good. Sure there might be some improvements that could be made, but I'd rather have this in and improve on it than spend another couple of months perfecting it (and rerolling it a dozen times in the process)

Attached is a re-roll against the latest dev #0f7df4a since this commit causes a conflict with the patch: http://drupalcode.org/entity_browser/commit/?id=0f7df4a .

re-queuing tests.

Hi samuel.mortensen,

thanks for working on this, I hope it can make it into the module soon.

Edit: as happens so often, I found the answer 15 minutes after sending the issue.

The filtering works, but I assumed that this patch would also restrict the values in the filter dropdown to the allowed media bundles.

The only thing I'm still wondering is why the "Entity Browser Context" default value is not available when I add the filter in the Master display.

------

Regarding the instructions, can you clarify something for me?

1. Add a new contextual filter for the entity type bundle.

I assume this means the "Bundle" entry of the media module in the list of contextual filters, right? -> correct

I've noticed that the "Entity Browser Context" default value is not available when I add the filter in the Master display, is that normal?

And since there are many different displays in the "Media Library" view, I wonder where I need to add the filter to have it show up on the "Gallery media library" entity browser?

Tested the patch using field widget "entity browser" & "inline entity form".

entity browse
Added an "entity browser" view display on the default content view from Drupal. Than added a contextual filter: Content type with the options described as in comment #3.
Using a field with form display "entity browser". Clicking on button launches the entity browser in my model with the filtered view.

inline entity form
Tested this with inline entity form. Using a field widget "Inline entity form - Complex".
When enabling the entity browser here. The views doesn't seems to get the context from the field. It seems that the widget_context is empty using this setup.

I'm not a developer so I can't help you with an extension to the patch. I sure hope this also can be fixed for the inline entity form widget.
As a side note, totally agree this solution needs some UX improvements. Without the help of comment #3. A normal site builder would not be able to get this working.

I'm using the patch for entity browser and an entity form widget. I'm using it in production since a while and it simply works.

I just tested the patch with a combination of entity_embed and entity_browser within CKEditor. Here, the library is shown empty, because it's missing the context.

I see, that it's the result of not being an entity reference field, but I just wanted to notice it here for further reference.

I'm running into this as well, but using the core media functionality with Entity Browser 8.x-2.0-alpha2.

Any feedback on if this patch will (almost?) apply or if the implementation will be somewhat similar for the 8.x-2.x branch?

We are using the patch from #15 for version 8.x-2.0-aplha2. It works fine for the entity reference field. As early mentioned it doesn't work for the IEF module.
Added a test at patch #15 for 8.x-2.0-aplha2

Used drupal/entity_browser (1.5.0) with the settings mentioned in #15 and works perfect.

#15 Patch working nicely with entity_browser 1.6.

I tried to apply it to 2.3 and it failed.

So using 1.6 for now, thank you!

Tested with 8.x-2.1, works well with field widget with nodes. It took a bit to figure out.

1) I think an update to the README.md with the instructions in #3 would be really helpful.

2) This text seems out of date: "The key within the widget context. If the corresponding value is an array its values will be joined with an AND."

Since it gives you the option to use AND or OR. I think the second sentence should be dropped. Right?

Here's an updated patch

1) Adds widget context target bundles for entity embed dialog. This means you can use the same entity browser for both field widgets and entity embeds. Eventually the code could be moved to the entity_embed module. But we can leave it here for now.

2) Adds sensible defaults in the contextual plugin that follow the instructions in #3. I don't think we need to update the README.md with these defaults and updated description text in place in place. Most importantly, I add a note about checking "Allow multiple values" at the bottom of the form. I got stuck on this when testing this morning, so I think it will be helpful to have this note there.

This patch expands on #14 and #29.

This patch adds integration with inline entity form so that the default value views plugin works.

Reroll of #30 (arguments for FileBrowserWidget have changed)

Adding target_entity_type to widget context. Not sure how it might be used, but I'm working on an alter hook in a patch for #2790951: Provide for contextual filter argument option on field widget, and I think having the information there could be useful. The entity browser doesn't store a target type, so it will be convenient to have it stored in the widget context.

Last failure was random. Marking back to "Needs Review".

Adding test coverage for inline entity form

working on fixing tests

Working on fixing tests

Working on fixing tests

working on fixing tests

working on fixing tests

There are random failures on line 77 of PluginsTest. I have noticed this on other issues too. Seeing if this fixes it.

For some reason on the Add test /retest form, even though I check 8.x-1.x, it keeps adding tests for 8.x-2.x, so changing back to 8.x-1.x to see if that helps.

Update: No, it keeps ignoring what I check.

Same as #51, just trying to test 8.x-1.x on 8.6.

So the random failures are annoying. But back to what is left to do:

- We still need a test that shows that this works now with entity embed. I'll work on this ASAP.

Adding test coverage for entity embed! That's the last @todo item.

- Working on fixing tests, I moved some configs from entity_browser_ief_test to entity_browser_test, so that I could share them with entity_browser_test_entity_embed
- I changed EntityBrowserTest::testContextualFilter to match the other two, apologies to @samuel.mortenson for renaming content types. I also added some additional test coverage by switching the bundle and reopening the entity browser.

testing 56 against 8.x-2.x

Working on fixing tests

Working on fixing tests

Working on fixing tests

Working on fixing tests, sorry for the noise.

Working on fixing tests

I figured out why the dependencies are not working, see #3040322: Add entity_embed and embed to test dependencies.

Also, I created an issue for the broken PluginsTest: #3040286: PluginsTest failing on 8.6.11

Update, I have a fix for PluginsTest.

Updated composer require dev to fix test dependencies on entity_embed and embed. Thanks to Berdir for the info.

I believe this is ready to go now!

It has been repeatedly verified and marked RTBC. And now it has test coverage for field_widget, inline_entity_form and entity_embed.

Reroll

Marking back as RTBC.

Committed! Thanks to Samuel Mortenson, and to all who reviewed.

Great work @oknate!

One side note, I see the whole git command in your git message(s).
https://cgit.drupalcode.org/entity_browser

"git commit -m 'Issue #2865928 by samuel.mortenson, oknate: Provide method for views widget to filter based on context' --author="samuel.mortenson <samuel.mortenson@2582268.no-reply.drupal.org>" "

Oh, how embarrassing. I use tower git. I'll fix that going forward, thanks. I'm not sure I can fix the ones already added.

Yes, I considered waiting until the 31st, which would make it two years in the making! Thanks again for the new feature.

I'm working on adding another views plugin building on this feature that will allows exposed filter options to update based on target_bundles:

#3039038: Provide views filter that limits based based on allowed bundles

It would be great if someone could review it.

I use the last patch in some composer extra patches definitions, but it cannot be longer applied to any version (2.0, 2.1 or 2.x).
Is it possible tu create a new release?

If you add the entity_browser project like this in composer.json:
"drupal/entity_browser": "dev-2.x",
the patch is included, so you don't need to apply the patch.

With require command:

composer require 'drupal/entity_browser:2.x-dev'

Here is the patch for the views argument only, without tests, untill the new release is there :)

Forgot the most important part: it applies to current stable 2.1 version.

BTW, thank you for the awesome new feature, looking forward to seeing it in 2.2

++for this patch!
Great work

I added documentation on drupal.org. Feel free to review/update.