feat(questiontype): add condition handlers and support for dropdown field type in forms (#1174)

Author: ccailly

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Added
+
+- Support for new value operators for “Field” question type linked to a field that is a dropdown in forms
+
 ### Fixed
 
 - Fix error when submitting a form with an hidden question of type `Field`

inc/destinationfield.class.php

@@ -134,6 +134,8 @@ public function applyConfiguratedValueToInputUsingAnswers(
                 if ($field->fields['type'] == 'glpi_item') {
                     $input[sprintf('itemtype_%s', $field_name)] = $answer->getRawAnswer()['itemtype'];
                     $input[sprintf('items_id_%s', $field_name)] = $answer->getRawAnswer()['items_id'];
+                } elseif ($field->fields['type'] == 'dropdown') {
+                    $input[$field_name] = $answer->getRawAnswer()['items_id'];
                 } else {
                     $input[$field_name] = $value ?? $answer->getRawAnswer();
                 }

inc/questiontype.class.php

@@ -29,6 +29,9 @@
  */
 
 use Glpi\Application\View\TemplateRenderer;
+use Glpi\DBAL\JsonFieldInterface;
+use Glpi\Form\Condition\ConditionHandler\ItemAsTextConditionHandler;
+use Glpi\Form\Condition\ConditionHandler\ItemConditionHandler;
 use Glpi\Form\Form;
 use Glpi\Form\Migration\FormQuestionDataConverterInterface;
 use Glpi\Form\Question;
@@ -167,12 +170,24 @@ public function renderEndUserTemplate(Question $question): string
             $default_value = json_decode($question->fields['default_value'], true);
         }
 
+        $itemtype = null;
+        if (str_starts_with((string) $current_field->fields['type'], 'dropdown')) {
+            if ($current_field->fields['type'] == 'dropdown') {
+                $itemtype = PluginFieldsDropdown::getClassname($current_field->fields['name']);
+            } else {
+                $dropdown_matches = [];
+                preg_match('/^dropdown-(?<class>.+)$/', (string) $current_field->fields['type'], $dropdown_matches);
+                $itemtype = $dropdown_matches['class'];
+            }
+        }
+
         $twig = TemplateRenderer::getInstance();
         return $twig->render('@fields/question_type_end_user.html.twig', [
             'question'      => $question,
             'field'         => $current_field->fields,
             'default_value' => $default_value,
             'item'          => new Form(),
+            'itemtype'      => $itemtype,
         ]);
     }
 
@@ -196,7 +211,8 @@ public function formatRawAnswer(mixed $answer, Question $question): string
             case 'date':
                 return (string) $answer;
             case 'dropdown':
-                if (is_string($answer)) {
+                $answer = $answer['items_id'];
+                if (is_string($answer) || is_numeric($answer)) {
                     $answer = [$answer];
                 }
 
@@ -283,6 +299,42 @@ public function getTargetQuestionType(array $rawData): string
         return self::class;
     }
 
+    #[Override]
+    public function getConditionHandlers(
+        ?JsonFieldInterface $question_config,
+    ): array {
+        $condition_handlers = parent::getConditionHandlers($question_config);
+        if (!$question_config instanceof PluginFieldsQuestionTypeExtraDataConfig) {
+            throw new InvalidArgumentException();
+        }
+
+        if (!$question_config->getFieldId()) {
+            return parent::getConditionHandlers($question_config);
+        }
+
+        // If the question is configured with a dropdown field, we add condition handlers to handle item and item as text conditions on the dropdown options
+        $field = PluginFieldsField::getById($question_config->getFieldId());
+        if ($field && str_starts_with((string) $field->fields['type'], 'dropdown')) {
+            if ($field->fields['type'] == 'dropdown') {
+                $itemtype = PluginFieldsDropdown::getClassname($field->fields['name']);
+            } else {
+                $dropdown_matches = [];
+                preg_match('/^dropdown-(?<class>.+)$/', (string) $field->fields['type'], $dropdown_matches);
+                $itemtype = $dropdown_matches['class'];
+            }
+
+            $condition_handlers = array_merge(
+                $condition_handlers,
+                [
+                    new ItemConditionHandler($itemtype),
+                    new ItemAsTextConditionHandler($itemtype),
+                ],
+            );
+        }
+
+        return $condition_handlers;
+    }
+
     /**
      * Retrieve the default value block from the question's extra data
      *

templates/question_type_administration.html.twig

@@ -32,8 +32,11 @@
 
 {% set is_ajax_reload = is_ajax_reload|default(false) %}
 
+{% set is_dropdown = field.type starts with 'dropdown' %}
+{% set name_suffix = is_dropdown ? '[items_id]' : '' %}
+
 {% set field_for_html = field|merge({
-    'default_value': default_value ?? field.default_value,
+    'default_value': default_value.items_id ?? default_value ?? field.default_value,
     'mandatory': false
 }) %}
 
@@ -44,8 +47,8 @@
     true,
     false,
     {
-        'input_name'     : 'default_value',
-        'full_width'     : not (field.type starts with 'dropdown' or field.type == 'glpi_item'),
+        'input_name'     : 'default_value' ~ name_suffix,
+        'full_width'     : not (is_dropdown or field.type == 'glpi_item'),
         'no_label'       : true,
         'mb'             : '',
         'init'           : is_ajax_reload or (question is not null),

templates/question_type_end_user.html.twig

@@ -26,10 +26,20 @@
  # -------------------------------------------------------------------------
  #}
 
+{% import 'components/form/fields_macros.html.twig' as fields %}
+
 {% set field = field|merge({
-    'default_value': default_value ?? field.default_value
+    'default_value': default_value.items_id ?? default_value ?? field.default_value
 }) %}
 
+{% set is_dropdown = field.type starts with 'dropdown' %}
+{% set name_suffix = is_dropdown ? '[items_id]' : '' %}
+
+{{ fields.hiddenField(
+    question.getEndUserInputName() ~ '[itemtype]',
+    itemtype
+) }}
+
 <div data-glpi-form-renderer-fields-question-type-specific-container>
     {{ call('PluginFieldsField::prepareHtmlFields', [
         [field],
@@ -38,7 +48,7 @@
         true,
         false,
         {
-            'input_name'     : question.getEndUserInputName(),
+            'input_name'     : question.getEndUserInputName() ~ name_suffix,
             'full_width'     : not (field.type starts with 'dropdown' or field.type == 'glpi_item'),
             'no_label'       : true,
             'mb'             : '',