feat(form): condition on submit button

btry · btry · commit 73af77dbf36f · 2020-01-22T11:31:57.000+01:00
Signed-off-by: Thierry Bugier &lt;tbugier@teclib.com&gt;
diff --git a/ajax/condition.php b/ajax/condition.php
@@ -66,14 +66,22 @@
       $section->getFromDB($sectionId);
       $form->getFromDBBySection($section);
       break;
-   case PluginFormcreatorSection::class: 
+   case PluginFormcreatorSection::class:
       if (!isset($_REQUEST['plugin_formcreator_forms_id'])) {
          http_response_code(400);
          exit;
       }
       $formId = (int) $_REQUEST['plugin_formcreator_forms_id'];
       $form->getFromDB($formId);
       break;
+   case PluginFormcreatorForm::class:
+      if (!isset($_REQUEST['id'])) {
+         http_response_code(400);
+         exit;
+      }
+      $formId = (int) $_REQUEST['id'];
+      $form->getFromDB($formId);
+      break;
 }
 
 if ($form->isNewItem()) {
diff --git a/front/form.form.php b/front/form.form.php
@@ -50,6 +50,7 @@
    // Edit an existing form
    Session::checkRight('entity', UPDATE);
    $form->update($_POST);
+   $form->updateConditions($_POST);
    Html::back();
 
 } else if (isset($_POST['delete'])) {
diff --git a/front/section.form.php b/front/section.form.php
@@ -43,14 +43,12 @@
       // Add a new Section
       Session::checkRight('entity', UPDATE);
       $section->add($_POST);
-      $section->updateConditions($_POST);
       Html::back();
 
    } else if (isset($_POST['update'])) {
       // Edit an existing section
       Session::checkRight("entity", UPDATE);
       $section->update($_POST);
-      $section->updateConditions($_POST);
       Html::back();
 
    } else if (isset($_POST['delete_section'])) {
diff --git a/inc/condition.class.php b/inc/condition.class.php
@@ -217,18 +217,11 @@ public function getConditionsFromItem(PluginFormcreatorConditionnableInterface $
     */
    public function showConditionsForItem($form, PluginFormcreatorConditionnableInterface $item) {
       $rand = mt_rand();
-      echo '<tr>';
-      echo '<th colspan="4">';
-      echo '<label for="dropdown_show_rule'.$rand.'" id="label_show_type">';
-      echo __('Show field', 'formcreator');
-      echo '</label>';
-      echo '</th>';
-      echo '</tr>';
 
-      echo '<tr">';
+      echo '<tr>';
       echo '<td colspan="4">';
       Dropdown::showFromArray(
-         'show_rule', 
+         'show_rule',
          $this->getEnumShowRule(),
          [
             'value'        => $item->fields['show_rule'],
@@ -239,15 +232,15 @@ public function showConditionsForItem($form, PluginFormcreatorConditionnableInte
       echo '</td>';
       echo '</tr>';
 
-      // Get conditionsexisting conditions for the item
+      // Get existing conditions for the item
       $conditions = $this->getConditionsFromItem($item);
       reset($conditions);
       $condition = array_shift($conditions);
       if ($condition !== null) {
-         echo $condition->getConditionHtml($form, PluginFormcreatorQuestion::class, 0, true);
+         echo $condition->getConditionHtml($form, $condition->fields['itemtype'], $condition->fields['items_id'], true);
       }
       foreach ($conditions as $condition) {
-         echo $condition->getConditionHtml($form, PluginFormcreatorQuestion::class, 0);
+         echo $condition->getConditionHtml($form, $condition->fields['itemtype'], $condition->fields['items_id']);
       }
    }
 
@@ -317,7 +310,6 @@ public function getConditionHtml($form, $itemtype, $itemId = 0, $isFirst = false
       $html.= '<div class="div_show_condition_field">';
       $html.= Dropdown::showFromArray('plugin_formcreator_questions_id[]', $questions_tab, [
          'display'      => false,
-         'used'         => [$itemId => ''],
          'value'        => $show_field,
          'rand'         => $rand,
       ]);
diff --git a/inc/fields.class.php b/inc/fields.class.php
@@ -138,6 +138,10 @@ public static function isVisible(PluginFormcreatorConditionnableInterface $item,
          if ($item instanceof CommonDBChild) {
             if (is_subclass_of($item::$itemtype, PluginFormcreatorConditionnableInterface::class)) {
                if ($parent = $item->getItem(true, false)) {
+                  if ($parent->getType() == PluginFormcreatorForm::class) {
+                     // the condition for form is only for its submit button. A form is always visible
+                     return true;
+                  }
                   // Use visibility of the parent item
                   $evalItem[$itemtype][$itemId] = self::isVisible($parent, $fields);
                   return $evalItem[$itemtype][$itemId];
@@ -331,6 +335,9 @@ public static function updateVisibility($input) {
          $fields[$id]->parseAnswerValues($input, true);
       }
 
+      // Get the visibility for the submit button of the form
+      $submitShow = PluginFormcreatorFields::isVisible($form, $fields);
+
       // Get the visibility result of questions
       $questionToShow = [];
       foreach ($fields as $id => $field) {
@@ -341,12 +348,13 @@ public static function updateVisibility($input) {
       $sectionToShow = [];
       $sections = (new PluginFormcreatorSection)->getSectionsFromForm($form->getID());
       foreach($sections as $section) {
-         $sectionToShow[$section->getID()] = PluginFormcreatorFields::isVisible($section, $fields);;
+         $sectionToShow[$section->getID()] = PluginFormcreatorFields::isVisible($section, $fields);
       }
 
       return [
          PluginFormcreatorQuestion::class => $questionToShow,
          PluginFormcreatorSection::class => $sectionToShow,
+         PluginFormcreatorForm::class => $submitShow,
       ];
    }
 
diff --git a/inc/form.class.php b/inc/form.class.php
@@ -37,7 +37,8 @@
 
 class PluginFormcreatorForm extends CommonDBTM implements
 PluginFormcreatorExportableInterface,
-PluginFormcreatorDuplicatableInterface
+PluginFormcreatorDuplicatableInterface,
+PluginFormcreatorConditionnableInterface
 {
    static $rightname = 'entity';
 
@@ -1718,6 +1719,14 @@ function export($remove_uuid = false) {
          $form['_sections'][] = $form_section->export($remove_uuid);
       }
 
+      // get submit conditions
+      $form['_conditions'] = [];
+      $condition = new PluginFormcreatorCondition();
+      $all_conditions = $condition->getConditionsFromItem($this);
+      foreach ($all_conditions as $condition) {
+         $form['_conditions'][] = $condition->export($remove_uuid);
+      }
+
       // get validators
       $form['_validators'] = [];
       $all_validators = $DB->request([
@@ -2042,6 +2051,13 @@ public static function import(PluginFormcreatorLinker $linker, $input = [], $con
          ]);
       }
 
+      // Import submit conditions
+      if (isset($input['_conditions'])) {
+         foreach ($input['_conditions'] as $condition) {
+            PluginFormcreatorCondition::import($linker, $condition, $itemId);
+         }
+      }
+
       // import form's targets
       if (isset($input['_targets'])) {
          foreach ((new self())->getTargetTypes() as $targetType) {
@@ -2582,4 +2598,59 @@ public function post_getFromDB() {
          $this->fields += \PluginFormcreatorSection::getFullData($this->fields['id']);
       }
    }
+
+   public function updateConditions($input) {
+      if (!isset($input['plugin_formcreator_questions_id']) || !isset($input['show_condition'])
+         || !isset($input['show_value']) || !isset($input['show_logic'])) {
+         return  false;
+      }
+
+      if (!is_array($input['plugin_formcreator_questions_id']) || !is_array($input['show_condition'])
+         || !is_array($input['show_value']) || !is_array($input['show_logic'])) {
+         return false;
+      }
+
+      // All arrays of condition exists
+      if ($input['show_rule'] == PluginFormcreatorCondition::SHOW_RULE_ALWAYS) {
+         return false;
+      }
+
+      if (!(count($input['plugin_formcreator_questions_id']) == count($input['show_condition'])
+            && count($input['show_value']) == count($input['show_logic'])
+            && count($input['plugin_formcreator_questions_id']) == count($input['show_value']))) {
+         return false;
+      }
+
+      // Delete all existing conditions for the question
+      $condition = new PluginFormcreatorCondition();
+      $condition->deleteByCriteria([
+         'itemtype' => static::class,
+         'items_id' => $input['id'],
+      ]);
+
+      // Arrays all have the same count and have at least one item
+      $order = 0;
+      while (count($input['plugin_formcreator_questions_id']) > 0) {
+         $order++;
+         $value            = array_shift($input['show_value']);
+         $questionID       = (int) array_shift($input['plugin_formcreator_questions_id']);
+         $showCondition    = html_entity_decode(array_shift($input['show_condition']));
+         $showLogic        = array_shift($input['show_logic']);
+         $condition = new PluginFormcreatorCondition();
+         $condition->add([
+            'itemtype'                        => static::class,
+            'items_id'                        => $input['id'],
+            'plugin_formcreator_questions_id' => $questionID,
+            'show_condition'                  => $showCondition,
+            'show_value'                      => $value,
+            'show_logic'                      => $showLogic,
+            'order'                           => $order,
+         ]);
+         if ($condition->isNewItem()) {
+            return false;
+         }
+      }
+
+      return true;
+   }
 }
diff --git a/inc/question.class.php b/inc/question.class.php
@@ -270,6 +270,24 @@ public static function showForForm(CommonDBTM $item, $withtemplate = '') {
       echo '</tr>';
 
       echo '</table>';
+
+      echo '<form name="plugin_formcreator_form" method="post" action="'.PluginFormcreatorForm::getFormURL().'">';
+      echo '<table class="tab_cadre_fixe">';
+
+      echo '<tr>';
+      echo '<th colspan="4">';
+      echo __('Show submit button', 'formcreator');
+      echo '</th>';
+      echo '</tr>';
+      $condition = new PluginFormcreatorCondition();
+      $condition->showConditionsForItem($item, $item);
+
+      echo '</table>';
+
+      $item->showFormButtons([
+         'candel' => false
+      ]);
+      Html::closeForm();
    }
 
    /**
@@ -585,11 +603,6 @@ public function setRequired($isRequired) {
       ]);
    }
 
-   /**
-    * Updates the conditions of the question
-    * @param array $input
-    * @return boolean true if success, false otherwise
-    */
    public function updateConditions($input) {
       if (!isset($input['plugin_formcreator_questions_id']) || !isset($input['show_condition'])
          || !isset($input['show_value']) || !isset($input['show_logic'])) {
@@ -891,6 +904,11 @@ public function showForm($ID, $options = []) {
       echo '</td>';
       echo '</tr>';
 
+      echo '<tr>';
+      echo '<th colspan="4">';
+      echo __('Show field', 'formcreator');
+      echo '</th>';
+      echo '</tr>';
       $condition = new PluginFormcreatorCondition();
       $condition->showConditionsForItem($form, $this);
 
diff --git a/inc/section.class.php b/inc/section.class.php
@@ -35,7 +35,7 @@
    die("Sorry. You can't access this file directly");
 }
 
-class PluginFormcreatorSection extends CommonDBChild implements 
+class PluginFormcreatorSection extends CommonDBChild implements
 PluginFormcreatorExportableInterface,
 PluginFormcreatorDuplicatableInterface,
 PluginFormcreatorConditionnableInterface
@@ -350,7 +350,7 @@ public function showForm($ID, $options = []) {
       }
       echo '<form name="plugin_formcreator_form" method="post" action="'.static::getFormURL().'">';
       echo '<table class="tab_cadre_fixe">';
-     
+
       echo '<tr>';
       echo '<th colspan="4">';
       echo $title;
@@ -364,6 +364,11 @@ public function showForm($ID, $options = []) {
       echo '</td>';
       echo '</tr>';
 
+      echo '<tr>';
+      echo '<th colspan="4">';
+      echo __('Show section', 'formcreator');
+      echo '</th>';
+      echo '</tr>';
       $form = new PluginFormcreatorForm();
       $form->getFromDBBySection($this);
       $condition = new PluginFormcreatorCondition();
@@ -433,12 +438,15 @@ public function post_getFromDB() {
       }
    }
 
-   /**
-    * Updates the conditions of the question
-    * @param array $input
-    * @return boolean true if success, false otherwise
-    */
-    public function updateConditions($input) {
+   public function post_addItem() {
+      $this->updateConditions($this->input);
+   }
+
+   public function post_updateItem($history = 1) {
+      $this->updateConditions($this->input);
+   }
+
+   public function updateConditions($input) {
       if (!isset($input['plugin_formcreator_questions_id']) || !isset($input['show_condition'])
          || !isset($input['show_value']) || !isset($input['show_logic'])) {
          return  false;
@@ -478,7 +486,7 @@ public function updateConditions($input) {
          $condition = new PluginFormcreatorCondition();
          $condition->add([
             'itemtype'                        => static::class,
-            'items_id'                        => $input['id'],
+            'items_id'                        => $this->getID(),
             'plugin_formcreator_questions_id' => $questionID,
             'show_condition'                  => $showCondition,
             'show_value'                      => $value,
diff --git a/install/mysql/plugin_formcreator_empty.sql b/install/mysql/plugin_formcreator_empty.sql
@@ -53,6 +53,7 @@ CREATE TABLE IF NOT EXISTS `glpi_plugin_formcreator_forms` (
   `validation_required` tinyint(1) NOT NULL DEFAULT '0',
   `usage_count` int(11) NOT NULL DEFAULT '0',
   `is_default` tinyint(1) NOT NULL DEFAULT '0',
+  `show_rule` INT(11) NOT NULL DEFAULT '1' COMMENT 'Conditions setting to show the submit button',
   `uuid` varchar(255) DEFAULT NULL,
   PRIMARY KEY (`id`),
   INDEX `entities_id` (`entities_id`),
diff --git a/install/upgrade_to_2.10.php b/install/upgrade_to_2.10.php
diff --git a/js/scripts.js.php b/js/scripts.js.php
diff --git a/tests/suite-unit/PluginFormcreatorFields.php b/tests/suite-unit/PluginFormcreatorFields.php
diff --git a/tests/suite-unit/PluginFormcreatorForm.php b/tests/suite-unit/PluginFormcreatorForm.php
