Verified Commit defcb862 authored by Alex Pott's avatar Alex Pott
Browse files

Issue #3134618 by geek-merlin, smustgrave, Matroskeen, Kristen Pol, alexpott:... 

Issue #3134618 by geek-merlin, smustgrave, Matroskeen, Kristen Pol, alexpott: hook_options_list_alter lacks $context['widget']
parent ccae3c04

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php

+1 −0
Original line number Diff line number Diff line
@@ -146,6 +146,7 @@ protected function getOptions(FieldableEntityInterface $entity) { 
      $context = [

        'fieldDefinition' => $this->fieldDefinition,

        'entity' => $entity,

        'widget' => $this,

      ];

      $module_handler->alter('options_list', $options, $context);

core/modules/options/options.api.php

+1 −0
Original line number Diff line number Diff line
@@ -24,6 +24,7 @@ 
 *     (\Drupal\Core\Field\FieldDefinitionInterface).

 *   - entity: The entity object the field is attached to

 *     (\Drupal\Core\Entity\EntityInterface).

 *   - widget: The widget object (\Drupal\Core\Field\WidgetInterface).

 *

 * @ingroup hooks

 * @see hook_options_list()

core/modules/options/tests/options_test/options_test.module

+15 −0
Original line number Diff line number Diff line
@@ -54,3 +54,18 @@ function options_test_dynamic_values_callback(FieldStorageDefinitionInterface $d 
  // We need the values of the entity as keys.

  return array_combine($values, $values);

}



/**

 * Implements hook_options_list_alter().

 */

function options_test_options_list_alter(array &$options, array $context) {

  if ($context['fieldDefinition']->getName() === 'card_4' && $context['widget']->getPluginId() === 'options_select') {

    // Rename _none option.

    $options['_none'] = '- Please select something -';

  }



  if ($context['fieldDefinition']->getName() === 'card_4' && $context['entity']->bundle() === 'entity_test') {

    // Remove 0 option.

    unset($options[0]);

  }

}

core/modules/options/tests/src/Functional/OptionsWidgetsTest.php

+68 −0
Original line number Diff line number Diff line
@@ -596,4 +596,72 @@ public function testEmptyValue() { 
    $this->assertSame('- None -', $option->getText());

  }



  /**

   * Tests hook_options_list_alter().

   *

   * @see options_test_options_list_alter()

   */

  public function testOptionsListAlter() {

    $field1 = FieldConfig::create([

      'field_storage' => $this->card1,

      'bundle' => 'entity_test',

    ]);

    $field1->save();



    // Create a new field that will be altered.

    $card4 = FieldStorageConfig::create([

      'field_name' => 'card_4',

      'entity_type' => 'entity_test',

      'type' => 'list_integer',

      'cardinality' => 1,

      'settings' => [

        'allowed_values' => [

          0 => 'Zero',

          1 => 'One',

        ],

      ],

    ]);

    $card4->save();



    $field2 = FieldConfig::create([

      'field_storage' => $card4,

      'bundle' => 'entity_test',

    ]);

    $field2->save();



    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */

    $display_repository = \Drupal::service('entity_display.repository');



    // Change it to the check boxes/radio buttons widget.

    $display_repository->getFormDisplay('entity_test', 'entity_test')

      ->setComponent($this->card1->getName(), [

        'type' => 'options_select',

      ])

      ->setComponent($card4->getName(), [

        'type' => 'options_select',

      ])

      ->save();



    // Create an entity.

    $entity = EntityTest::create([

      'user_id' => 1,

      'name' => $this->randomMachineName(),

    ]);

    $entity->save();



    // Display form: check that _none options are present.

    $this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');

    $xpath = '//select[@id=:id]//option[@value="_none" and text()=:label]';

    $xpath_args = [':id' => 'edit-card-1', ':label' => '- None -'];

    $this->assertSession()->elementExists('xpath', $this->assertSession()->buildXPathQuery($xpath, $xpath_args));

    $xpath_args = [':id' => 'edit-card-4', ':label' => '- Please select something -'];

    $this->assertSession()->elementExists('xpath', $this->assertSession()->buildXPathQuery($xpath, $xpath_args));



    // Display form: check that options are displayed correctly.

    $this->assertSession()->optionExists('card_1', 0);

    $this->assertSession()->optionExists('card_1', 1);

    $this->assertSession()->optionNotExists('card_4', 0);

    $this->assertSession()->optionExists('card_4', 1);

  }



}