LanguageSelectWidget should have options for which language types to show

Marking Novice. If you want to tackle this and need help please just ask here and I will provide detailed instructions.

Sure.

In LanguageSelectWidget, you should add a defaultSettings() which provides an array with include_locked as key and the default value (I guess it should be TRUE in this case) as the value.

Then you should add a settingsForm() method which returns a form to configure this setting, so it should just contain a single include_locked setting which is just a checkbox.

Then in formElement() you should replace the value of the #languages key with $this->getSetting('include_locked').

Does that help?

Thanks @cebasqueira for the patch! Thanks also @juancasantito, your patch was almost identical, but had some identation problems, and since this was assigned to @cebasqueira I'm reviewing the last patch. It's best to always keep a watch on if an issue is already assigned to someone else or not.

+++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/LanguageSelectWidget.php
@@ -27,10 +27,35 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
+      '#title' => $this->t('Include locked languages such as Not specified and Not applicable'),

I think we should wrap the "Not specified" and "Not applicable" in < em > tags.

Other than that, the patch looks great.

This will need some tests and an upgrade path for existing form displays, however. Removing the Novice tag for that, but do feel free to tackle that if you want. I will try to help.

That looks great, thanks! Now just needs tests and an upgrade path, as noted above.

By the way @cebasqueira, it is a best practice to always create an interdiff when you update a patch. That would be great to do, next time (no need to do it for this one, that's fine). More information on: https://www.drupal.org/documentation/git/interdiff

@faline Unfortunately there are no tests at all for LanguageSelectWidget at the moment, so you would have to create a new test. Maybe you can look at OptionsWidgetsTest for inspiration. Basically we would need 2 test methods, one which just uses the default settings and asserts that the locked languages are there and then another test method which disables the include_locked setting and then asserts that the locked languages are not there.

Also putting this on the D8MI sprint board, as this is actively being worked on ATM.

Let's see what the bot thinks. Patch looks pretty good.

Nice work. Please don't be discouraged that I marked a big portion of the test below, the test is actually not that far from what we want, it just needs some tweaks that make a lot of lines of code.

Some ideas for improvement for the test:

1. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +namespace Drupal\language\Tests;
   ...
   +class LanguageSelectWidgetTest extends FieldTestBase {
   

   FieldTestBase is an old WebTestBase-based test. There is now a new replacement, called FieldKernelTestBase. It's very easy to miss, because there are so many different classes at so many different locations... :-/

   Looking at FieldKernelTestBase I'm not sure if we actually need it here, or we can just extend KernelTestBase directly. Then you would have to do, for example

   $this->installEntitySchema('entity_test');
   

   in setUp() but maybe not much more.

   Either way, the test will then be in the Drupal\Tests\language\Kernel and it will be located in core/modules/language/tests/src/Kernel

   Again, sorry that this is so weird...

2. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +  public static $modules = array(
   ...
   +  );
   

   Here, and elsewhere: It's not required, but it's nice to use the short array syntax ([]) for new classes.

3. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +    // Install Portuguese, Brazil language.
   +    $edit = array();
   +    $edit['predefined_langcode'] = 'pt-br';
   +
   +    $this->drupalPostForm(
   +      'admin/config/regional/language/add',
   +      $edit,
   +      t('Add language')
   +    );
   

   This is currently failing, I think, because you are not logged in as an administrator. Instead of creating it from the UI, though, we can create a language directly from code.

   Something like this (untested):

   $language = ConfigurableLanguage::createFromLangcode('pt-br');
   $language->save();
   

4. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +    $this->fieldLanguageLocked = FieldStorageConfig::create([
   +      'field_name' => 'language_locked',
   +      'entity_type' => 'entity_test',
   +      'type' => 'language_select',
   +      'languages' => LanguageInterface::STATE_ALL,
   +    ]);
   +
   +    $this->fieldLanguageLocked->save();
   +
   +    $this->fieldLanguageUnlocked = FieldStorageConfig::create([
   +      'field_name' => 'language_unlocked',
   +      'entity_type' => 'entity_test',
   +      'type' => 'language_select',
   +      'languages' => LanguageInterface::STATE_CONFIGURABLE,
   +    ]);
   +
   +    $this->fieldLanguageUnlocked->save();
   

   So if we use the entity_test entity type we can directly use the language base field that that provides and don't have to add any fields ourselves. We simply have to configure the form display to use the widget with a particular setting.

   Adapting this from similar code in OptionsWidgetsTest you could try something like the following (untested):

       entity_get_form_display('entity_test', 'entity_test', 'default')
         ->setComponent('language', [
           'type' => 'language_select',
         ])
         ->save();
   

   (That's without the setting. And then you would have to add the setting in the other test method.)

5. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +    // Create an instance of the 'single value' field.
   +    $field = FieldConfig::create([
   +      'field_storage' => $this->fieldLanguageLocked,
   +      'bundle' => 'entity_test',
   +    ]);
   +
   +    $field->save();
   ...
   +    // Create an instance of the 'single value' field.
   +    $field = FieldConfig::create([
   +      'field_storage' => $this->fieldLanguageUnlocked,
   +      'bundle' => 'entity_test',
   +    ]);
   +
   +    $field->save();
   

   Again, this should not be needed, because we can just re-use the existing langcode field.

6. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +    // Create an entity.
   +    $entity = EntityTest::create(array(
   +      'user_id' => 1,
   +      'name' => $this->randomMachineName(),
   +    ));
   +    $entity->save();
   ...
   +    // Create an entity.
   +    $entity = EntityTest::create(array(
   +      'user_id' => 1,
   +      'name' => $this->randomMachineName(),
   +    ));
   +    $entity->save();
   

   This is not necessarily wrong, but I wonder if we could just go to the add form and do the assertions there? That should work just the same, I think?

7. +++ b/core/modules/language/src/Tests/LanguageSelectWidgetTest.php
   @@ -0,0 +1,134 @@
   +    $this->assertOptionSelected('edit-language-locked', LanguageInterface::LANGCODE_NOT_APPLICABLE);
   +    $this->assertOptionSelected('edit-language-locked', LanguageInterface::LANGCODE_NOT_SPECIFIED);
   +    $this->assertOptionSelected('edit-language-locked', 'pt-br');
   ...
   +    $this->assertNoOptionSelected('edit-language-locked', LanguageInterface::LANGCODE_NOT_APPLICABLE);
   +    $this->assertNoOptionSelected('edit-language-locked', LanguageInterface::LANGCODE_NOT_SPECIFIED);
   +    $this->assertOptionSelected('edit-language-locked', 'pt-br');
   

   I think we don't actually want to assert that the option is selected (or not), but that it exists (or not) so I think we should be using $this->assertOption() and $this->assertNoOption()

Hopefully that will allow you or someone else to move this along. Also re-marking "Novice" as - now that you've put the test in place, I think it's a Novice task to fix at least some of the issues I noted above, even if some might be a bit trickier.

Awesome, thank you so much. Looks absolutely perfect.

Perfect, thanks for the review @alexpott and the quick turnaround @maxocub!