feat(forms): add Tag question type and category implementation

Makefile

@@ -0,0 +1 @@
+include ../../PluginsMakefile.mk

inc/questiontype.class.php

@@ -0,0 +1,164 @@
+<?php
+
+/**
+ * -------------------------------------------------------------------------
+ * Tag plugin for GLPI
+ * -------------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of Tag.
+ *
+ * Tag is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Tag is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tag. If not, see <http://www.gnu.org/licenses/>.
+ * -------------------------------------------------------------------------
+ * @copyright Copyright (C) 2014-2023 by Teclib'.
+ * @license   GPLv2 https://www.gnu.org/licenses/gpl-2.0.html
+ * @link      https://github.com/pluginsGLPI/tag
+ * -------------------------------------------------------------------------
+ */
+
+use Glpi\Application\View\TemplateRenderer;
+use Glpi\Form\Form;
+use Glpi\Form\Migration\FormQuestionDataConverterInterface;
+use Glpi\Form\Question;
+use Glpi\Form\QuestionType\AbstractQuestionType;
+use Glpi\Form\QuestionType\QuestionTypeCategoryInterface;
+
+class PluginTagQuestionType extends AbstractQuestionType implements FormQuestionDataConverterInterface
+{
+    #[Override]
+    public function getCategory(): QuestionTypeCategoryInterface
+    {
+        return new PluginTagQuestionTypeCategory();
+    }
+
+    #[Override]
+    public function isAllowedForUnauthenticatedAccess(): bool
+    {
+        return true;
+    }
+
+    #[Override]
+    public function formatDefaultValueForDB(mixed $value): ?string
+    {
+        if (!is_array($value)) {
+            return null;
+        }
+
+        return implode(',', $value);
+    }
+
+    #[Override]
+    public function formatRawAnswer(mixed $answer, Question $question): string
+    {
+        if (!is_array($answer)) {
+            throw new LogicException('Answer must be an array');
+        }
+
+        if (count(array_filter($answer, 'is_numeric')) !== count($answer)) {
+            throw new LogicException('Answer must be an array of numeric IDs');
+        }
+
+        $tags = PluginTagTag::getByIds($answer);
+        $tag_names = array_map(fn($tag) => $tag->fields['name'], $tags);
+
+        return implode(',', $tag_names);
+    }
+
+    #[Override]
+    public function renderAdministrationTemplate(?Question $question): string
+    {
+        [$available_tags, $available_tags_color] = $this->getAvailableTags();
+
+        $twig = TemplateRenderer::getInstance();
+        return $twig->render('@tag/question_dropdown.html.twig', [
+            'input_name'      => 'default_value',
+            'selected_tags'   => empty($question?->fields['default_value']) ? [] : explode(',', $question->fields['default_value']),
+            'available_tags'  => $available_tags,
+            'tags_color'      => $available_tags_color,
+            'dropdown_params' => [
+                'no_label' => true,
+                'init'     => $question !== null,
+            ],
+        ]);
+    }
+
+    #[Override]
+    public function renderEndUserTemplate(Question $question): string
+    {
+        [$available_tags, $available_tags_color] = $this->getAvailableTags($question->getForm());
+
+        $twig = TemplateRenderer::getInstance();
+        return $twig->render('@tag/question_dropdown.html.twig', [
+            'input_name'          => $question->getEndUserInputName(),
+            'selected_tags'       => empty($question?->fields['default_value']) ? [] : explode(',', $question->fields['default_value']),
+            'available_tags'      => $available_tags,
+            'tags_color'          => $available_tags_color,
+            'show_search_tooltip' => false,
+            'dropdown_params'     => [
+                'no_label' => true,
+                'init'     => true,
+            ],
+        ]);
+    }
+
+    #[Override]
+    public function beforeConversion(array $rawData): void {}
+
+    #[Override]
+    public function convertDefaultValue(array $rawData): null
+    {
+        return null;
+    }
+
+    #[Override]
+    public function convertExtraData(array $rawData): null
+    {
+        return null;
+    }
+
+    #[Override]
+    public function getTargetQuestionType(array $rawData): string
+    {
+        return self::class;
+    }
+
+    private function getAvailableTags(?Form $form = null): array
+    {
+        $active_entities_ids = Session::getActiveEntities();
+        if ($active_entities_ids === [] && $form) {
+            $active_entities_ids = [$form->getEntityID()];
+        }
+
+        $tag                  = new PluginTagTag();
+        $available_tags       = [];
+        $available_tags_color = [];
+        $result               = $tag->find([
+            'is_active' => 1,
+            'OR' => [
+                ['type_menu' => ['LIKE', '%\"Ticket\"%']],
+                ['type_menu' => ['LIKE', '%\"Change\"%']],
+                ['type_menu' => ['LIKE', '%\"Problem\"%']],
+                ['type_menu' => '0'],
+                ['type_menu' => ''],
+                ['type_menu' => 'NULL'],
+            ],
+        ] + getEntitiesRestrictCriteria('', '', $active_entities_ids, true), 'name');
+        foreach ($result as $id => $data) {
+            $available_tags[$id] = $data['name'];
+            $available_tags_color[$id] = $data['color'] ?: '#DDDDDD';
+        }
+        return [$available_tags, $available_tags_color];
+    }
+}

inc/questiontypecategory.class.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * -------------------------------------------------------------------------
+ * Tag plugin for GLPI
+ * -------------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of Tag.
+ *
+ * Tag is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Tag is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tag. If not, see <http://www.gnu.org/licenses/>.
+ * -------------------------------------------------------------------------
+ * @copyright Copyright (C) 2014-2023 by Teclib'.
+ * @license   GPLv2 https://www.gnu.org/licenses/gpl-2.0.html
+ * @link      https://github.com/pluginsGLPI/tag
+ * -------------------------------------------------------------------------
+ */
+
+use Glpi\Form\QuestionType\QuestionTypeCategoryInterface;
+
+/**
+ * -------------------------------------------------------------------------
+ * Tag plugin for GLPI
+ * -------------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of Tag.
+ *
+ * Tag is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Tag is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tag. If not, see <http://www.gnu.org/licenses/>.
+ * -------------------------------------------------------------------------
+ * @copyright Copyright (C) 2014-2023 by Teclib'.
+ * @license   GPLv2 https://www.gnu.org/licenses/gpl-2.0.html
+ * @link      https://github.com/pluginsGLPI/tag
+ * -------------------------------------------------------------------------
+ */
+
+
+class PluginTagQuestionTypeCategory implements QuestionTypeCategoryInterface
+{
+    public function getLabel(): string
+    {
+        return __('Tag', 'tag');
+    }
+
+    public function getIcon(): string
+    {
+        return 'ti ti-tag';
+    }
+
+    public function getWeight(): int
+    {
+        return 1000;
+    }
+}

phpstan.neon

@@ -4,7 +4,6 @@ parameters:
     level: 5
     paths:
         - ajax
-        - front
         - inc
         - stubs
         - hook.php

psalm.xml

@@ -4,7 +4,6 @@
 >
     <projectFiles>
         <directory name="ajax" />
-        <directory name="front" />
         <directory name="inc" />
         <directory name="stubs" />
         <directory name="tests" />

rector.php

@@ -39,7 +39,6 @@
 return RectorConfig::configure()
     ->withPaths([
         __DIR__ . '/ajax',
-        __DIR__ . '/front',
         __DIR__ . '/inc',
         __DIR__ . '/stubs',
         __DIR__ . '/tests',

setup.php

@@ -28,6 +28,8 @@
  * -------------------------------------------------------------------------
  */
 use Glpi\Form\Form;
+use Glpi\Form\Migration\TypesConversionMapper;
+use Glpi\Form\QuestionType\QuestionTypesManager;
 use Glpi\Plugin\Hooks;
 
 define('PLUGIN_TAG_VERSION', '2.13.0');
@@ -154,6 +156,9 @@ function plugin_init_tag()
         Plugin::registerClass('PluginTagConfig', ['addtabon' => 'Config']);
 
         $PLUGIN_HOOKS['use_rules']['tag']      = ['RuleTicket'];
+
+        // Register tag question type
+        registerPluginTypes();
     }
 }
 
@@ -203,3 +208,18 @@ function plugin_tag_geturl(): string
     global $CFG_GLPI;
     return sprintf('%s/plugins/tag', $CFG_GLPI['url_base']);
 }
+
+function registerPluginTypes(): void
+{
+    $types = QuestionTypesManager::getInstance();
+    $type_mapper = TypesConversionMapper::getInstance();
+
+    // Register question type category
+    $types->registerPluginCategory(new PluginTagQuestionTypeCategory());
+
+    // Register question type
+    $types->registerPluginQuestionType(new PluginTagQuestionType());
+
+    // Register mapper for legacy question type
+    $type_mapper->registerPluginQuestionTypeConverter('tag', new PluginTagQuestionType());
+}