feat(issue): add option to hide search Issue if needed

Co-authored-by: btry <tbugier@teclib.com>

Author: stonebuzz

front/issue.php

@@ -53,8 +53,19 @@
 if (Session::getCurrentInterface() == 'helpdesk') {
    PluginFormcreatorCommon::showMiniDashboard();
 }
+
+//backup session value
+$save_session_fold_search = $_SESSION['glpifold_search'];
+//hide search if need
+if (PluginFormcreatorEntityconfig::getUsedConfig('is_search_issue_visible', Session::getActiveEntity()) == PluginFormcreatorEntityconfig::CONFIG_SEARCH_ISSUE_HIDDEN) {
+   $_SESSION['glpifold_search'] = true;
+}
+
 Search::show('PluginFormcreatorIssue');
 
+//restore session value
+$_SESSION['glpifold_search'] = $save_session_fold_search;
+
 if (Session::getCurrentInterface() == "helpdesk") {
    Html::helpFooter();
 } else {

inc/entityconfig.class.php

@@ -63,6 +63,9 @@ class PluginFormcreatorEntityconfig extends CommonDBTM {
    const CONFIG_DASHBOARD_HIDDEN = 0;
    const CONFIG_DASHBOARD_VISIBLE = 1;
 
+   const CONFIG_SEARCH_ISSUE_HIDDEN = 0;
+   const CONFIG_SEARCH_ISSUE_VISIBLE = 1;
+
    /**
     * @var bool $dohistory maintain history
     */
@@ -135,6 +138,14 @@ public static function getEnumDashboardVisibility() : array {
       ];
    }
 
+   public static function getEnumSearchIssueVisibility() : array {
+      return [
+         self::CONFIG_PARENT            => __('Inheritance of the parent entity'),
+         self::CONFIG_SEARCH_ISSUE_VISIBLE => __('Visible', 'formcreator'),
+         self::CONFIG_SEARCH_ISSUE_HIDDEN  => __('Hidden', 'formcreator'),
+      ];
+   }
+
    public static function displayTabContentForItem(CommonGLPI $item, $tabnum = 1, $withtemplate = 0) {
       if ($item->getType() == 'Entity') {
          $config = new self();
@@ -315,6 +326,22 @@ public function showFormForEntity(Entity $entity) {
       }
       echo '</td></tr>';
 
+      // Search issue visibility
+      $elements = self::getEnumSearchIssueVisibility();
+      if ($entityId == 0) {
+         unset($elements[self::CONFIG_PARENT]);
+      }
+      echo "<tr class='tab_bg_1'>";
+      echo "<td>".__('Search issue', 'formcreator')."</td>";
+      echo "<td>";
+      Dropdown::showFromArray('is_search_issue_visible', $elements, ['value' => $this->fields['is_search_issue_visible']]);
+      if ($this->fields['is_search_issue_visible'] == self::CONFIG_PARENT) {
+         $tid = self::getUsedConfig('is_search_issue_visible', $entityId);
+         echo '<br>';
+         Entity::inheritedValue($elements[$tid], true);
+      }
+      echo '</td></tr>';
+
       // header
       echo "<tr class='tab_bg_1'>";
       echo "<td>" . _n('Header', 'Headers', 1, 'formcreator') . "</td>";

install/install.php

@@ -263,15 +263,16 @@ protected function configureExistingEntities() {
 
       /** Value -2 is "inheritance from parent" @see PluginFormcreatorEntityconfig::CONFIG_PARENT */
       $query = "INSERT INTO glpi_plugin_formcreator_entityconfigs
-                  (entities_id, replace_helpdesk, default_form_list_mode, sort_order, is_kb_separated, is_search_visible, is_dashboard_visible, is_header_visible)
+                  (entities_id, replace_helpdesk, default_form_list_mode, sort_order, is_kb_separated, is_search_visible, is_dashboard_visible, is_header_visible, is_search_issue_visible)
                SELECT ent.id,
                   IF(ent.id = 0, 0, -2),
                   IF(ent.id = 0, 0, -2),
                   IF(ent.id = 0, 0, -2),
                   IF(ent.id = 0, 0, -2),
                   IF(ent.id = 0, 0, -2),
                   IF(ent.id = 0, 1, -2),
-                  IF(ent.id = 0, 0, -2)
+                  IF(ent.id = 0, 0, -2),
+                  IF(ent.id = 0, 1, -2)
                 FROM glpi_entities ent
                 LEFT JOIN glpi_plugin_formcreator_entityconfigs conf
                   ON ent.id = conf.entities_id

install/mysql/plugin_formcreator_empty.sql

@@ -28,16 +28,17 @@ CREATE TABLE IF NOT EXISTS `glpi_plugin_formcreator_categories` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS `glpi_plugin_formcreator_entityconfigs` (
-  `id`                     int unsigned NOT NULL AUTO_INCREMENT,
-  `entities_id`            int unsigned NOT NULL DEFAULT '0',
-  `replace_helpdesk`       int(11) NOT NULL DEFAULT '-2',
-  `default_form_list_mode` int(11) NOT NULL DEFAULT '-2',
-  `sort_order`             int(11) NOT NULL DEFAULT '-2',
-  `is_kb_separated`        int(11) NOT NULL DEFAULT '-2',
-  `is_search_visible`      int(11) NOT NULL DEFAULT '-2',
-  `is_dashboard_visible`   int(11) NOT NULL DEFAULT '-2',
-  `is_header_visible`      int(11) NOT NULL DEFAULT '-2',
-  `header`                 text,
+  `id`                      int unsigned NOT NULL AUTO_INCREMENT,
+  `entities_id`             int unsigned NOT NULL DEFAULT '0',
+  `replace_helpdesk`        int(11) NOT NULL DEFAULT '-2',
+  `default_form_list_mode`  int(11) NOT NULL DEFAULT '-2',
+  `sort_order`              int(11) NOT NULL DEFAULT '-2',
+  `is_kb_separated`         int(11) NOT NULL DEFAULT '-2',
+  `is_search_visible`       int(11) NOT NULL DEFAULT '-2',
+  `is_dashboard_visible`    int(11) NOT NULL DEFAULT '-2',
+  `is_header_visible`       int(11) NOT NULL DEFAULT '-2',
+  `is_search_issue_visible` int(11) NOT NULL DEFAULT '-2',
+  `header`                  text,
   PRIMARY KEY (`id`),
   UNIQUE KEY `unicity` (`entities_id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

install/upgrade_to_2.13.php

@@ -48,6 +48,17 @@ public function upgrade(Migration $migration) {
       $this->addTargetValidationSetting();
       $this->addFormVisibility();
       $this->addRequestSourceSetting();
+      $this->addEntityOption();
+   }
+
+   public function addEntityOption() {
+      global $DB;
+      $table = 'glpi_plugin_formcreator_entityconfigs';
+
+      if (!$DB->fieldExists($table, 'is_search_issue_visible')) {
+         $this->migration->addField($table, 'is_search_issue_visible', 'integer', ['after' => 'is_header_visible', 'value' => '-2']);
+         $this->migration->addPostQuery("UPDATE `glpi_plugin_formcreator_entityconfigs` SET `is_search_issue_visible`= 1 WHERE `entities_id` = 0");
+      }
    }
 
    public function addFormAnswerTitle() {