feat(form): rename anonymous form to public form

pluginsGLPI · Feb 15, 2022 · 538aebd · 538aebd
1 parent 9e86780
commit 538aebd
Show file tree

Hide file tree

Showing 46 changed files with 71 additions and 71 deletions.
diff --git a/front/formdisplay.php b/front/formdisplay.php
@@ -60,7 +60,7 @@
       // If user is not authenticated, create temporary user
       if (!isset($_SESSION['glpiname'])) {
          $_SESSION['formcreator_forms_id'] = $form->getID();
-         $_SESSION['formcreator_anonymous'] = true;
+         $_SESSION['formcreator_public'] = true;
          $_SESSION['glpiname'] = 'formcreator_temp_user';
          $_SESSION['valid_id'] = session_id();
          $_SESSION['glpiactiveentities'] = [$form->fields['entities_id']];
@@ -75,9 +75,9 @@
    $form->displayUserForm();
 
    // If user was not authenticated, remove temporary user
-   if (isset($_SESSION['formcreator_anonymous'])) {
+   if (isset($_SESSION['formcreator_public'])) {
       unset($_SESSION['glpiname']);
-      unset($_SESSION['formcreator_anonymous']);
+      unset($_SESSION['formcreator_public']);
       session_write_close();
    }
 } else if (isset($_GET['answer_saved'])) {

diff --git a/inc/abstracttarget.class.php b/inc/abstracttarget.class.php
@@ -799,7 +799,7 @@ protected function prepareActors(PluginFormcreatorForm $form, PluginFormcreatorF
     * Adds an user to the given actor role (requester, observer assigned or supplier)
     *
     * @param string $role role of the user
-    * @param string $user user ID or email address for anonymous users
+    * @param string $user user ID or email address for accountless users
     * @param bool $notify true to enable notification for the actor
     * @return boolean true on success, false on error
     */

diff --git a/inc/field/actorfield.class.php b/inc/field/actorfield.class.php
@@ -401,7 +401,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return false;
    }
 

diff --git a/inc/field/checkboxesfield.class.php b/inc/field/checkboxesfield.class.php
@@ -369,7 +369,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/datefield.class.php b/inc/field/datefield.class.php
@@ -217,7 +217,7 @@ public function parseAnswerValues($input, $nonDestructive = false): bool {
       return true;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/datetimefield.class.php b/inc/field/datetimefield.class.php
@@ -218,7 +218,7 @@ public function parseAnswerValues($input, $nonDestructive = false): bool {
       return true;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/descriptionfield.class.php b/inc/field/descriptionfield.class.php
@@ -151,7 +151,7 @@ public function parseAnswerValues($input, $nonDestructive = false): bool {
       return true;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/dropdownfield.class.php b/inc/field/dropdownfield.class.php
@@ -768,7 +768,7 @@ public function parseAnswerValues($input, $nonDestructive = false): bool {
       return true;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return false;
    }
 

diff --git a/inc/field/emailfield.class.php b/inc/field/emailfield.class.php
@@ -174,7 +174,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/filefield.class.php b/inc/field/filefield.class.php
@@ -291,7 +291,7 @@ public function regex($value): bool {
       throw new ComparisonException('Meaningless comparison');
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/floatfield.class.php b/inc/field/floatfield.class.php
@@ -291,7 +291,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/glpiselectfield.class.php b/inc/field/glpiselectfield.class.php
@@ -241,7 +241,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return false;
    }
 

diff --git a/inc/field/hiddenfield.class.php b/inc/field/hiddenfield.class.php
@@ -163,7 +163,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/hostnamefield.class.php b/inc/field/hostnamefield.class.php
@@ -148,7 +148,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/ipfield.class.php b/inc/field/ipfield.class.php
@@ -160,7 +160,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/ldapselectfield.class.php b/inc/field/ldapselectfield.class.php
@@ -340,7 +340,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return false;
    }
 

diff --git a/inc/field/radiosfield.class.php b/inc/field/radiosfield.class.php
@@ -275,7 +275,7 @@ public function regex($value): bool {
       return preg_match($value, $this->value) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/requesttypefield.class.php b/inc/field/requesttypefield.class.php
@@ -223,7 +223,7 @@ public function regex($value): bool {
       throw new ComparisonException('Meaningless comparison');
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/tagfield.class.php b/inc/field/tagfield.class.php
@@ -241,7 +241,7 @@ public function regex($value): bool {
       throw new ComparisonException('Meaningless comparison');
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return false;
    }
 

diff --git a/inc/field/textareafield.class.php b/inc/field/textareafield.class.php
@@ -272,7 +272,7 @@ public function regex($value): bool {
       return (preg_grep($value, $this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/textfield.class.php b/inc/field/textfield.class.php
@@ -273,7 +273,7 @@ public function regex($value): bool {
       return preg_match($value, Toolbox::stripslashes_deep($this->value)) ? true : false;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/timefield.class.php b/inc/field/timefield.class.php
@@ -210,7 +210,7 @@ public function parseAnswerValues($input, $nonDestructive = false): bool {
       return true;
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/field/urgencyfield.class.php b/inc/field/urgencyfield.class.php
@@ -227,7 +227,7 @@ public function regex($value): bool {
       throw new ComparisonException('Meaningless comparison');
    }
 
-   public function isAnonymousFormCompatible(): bool {
+   public function isPublicFormCompatible(): bool {
       return true;
    }
 

diff --git a/inc/fieldinterface.class.php b/inc/fieldinterface.class.php
@@ -252,9 +252,9 @@ public function regex($value) : bool;
    /**
     * Is the field compatible with anonymous form ?
     *
-    * @return boolean true if the field can work with anonymous forms
+    * @return boolean true if the field can work with public forms
     */
-   public function isAnonymousFormCompatible() : bool;
+   public function isPublicFormCompatible() : bool;
 
    /**
     * Gets HTML code for the icon of a field

diff --git a/inc/form.class.php b/inc/form.class.php
@@ -1031,7 +1031,7 @@ public function displayUserForm() : void {
          'options' => [
             'columns' => PluginFormcreatorSection::COLUMNS,
             'domain'  => $domain, // For translation
-            'anonymous'=> isset($_SESSION['formcreator_anonymous']),
+            'public'  => isset($_SESSION['formcreator_public']),
             'use_captcha' => ($this->fields['access_rights'] == PluginFormcreatorForm::ACCESS_PUBLIC
                               && $this->fields['is_captcha_enabled'] != '0'),
          ]
@@ -1277,7 +1277,7 @@ protected function checkAccessRight(array $input): bool {
             $fields = $this->getFields();
             $incompatibleQuestion = false;
             foreach ($fields as $field) {
-               if (!$field->isAnonymousFormCompatible()) {
+               if (!$field->isPublicFormCompatible()) {
                   $incompatibleQuestion = true;
                   $message = __('The question %s is not compatible with public forms', 'formcreator');
                   Session::addMessageAfterRedirect(sprintf($message, $field->getLabel()), false, ERROR);
@@ -2032,8 +2032,8 @@ public function showForCentral() {
    }
 
    /**
-    * Is the form accessible anonymously (without being logged in) ?
-    * @return boolean true if the form is accessible anonymously
+    * Is the form accessible publicly (without being logged in) ?
+    * @return boolean true if the form is accessible publicly
     */
    public function isPublicAccess() : bool {
       if ($this->isNewItem()) {
@@ -2480,7 +2480,7 @@ public function setTranslations(string $language, array $translations) : bool {
    }
 
    /**
-    * Choose the best language for anonymous form
+    * Choose the best language for publicly form
     *
     * @return string the best language for this form and session context
     */

diff --git a/inc/question.class.php b/inc/question.class.php
@@ -354,7 +354,7 @@ private function checkBeforeSave($input) : array {
       $form = PluginFormcreatorCommon::getForm();
       $section = PluginFormcreatorSection::getById($input[PluginFormcreatorSection::getForeignKeyField()]);
       $form = PluginFormcreatorForm::getByItem($section);
-      if ($form->isPublicAccess() && !$this->field->isAnonymousFormCompatible()) {
+      if ($form->isPublicAccess() && !$this->field->isPublicFormCompatible()) {
          Session::addMessageAfterRedirect(__('This type of question is not compatible with public forms.', 'formcreator'), false, ERROR);
          return [];
       }

diff --git a/templates/pages/userform.html.twig b/templates/pages/userform.html.twig
@@ -87,7 +87,7 @@
                                 {% endif %}
                             {% endif %}
                         {% endif %}
-                        {% if not options.anonymous or question.getSubField().isAnonymousFormCompatible() %}
+                        {% if not options.public or question.getSubField().isPublicFormCompatible() %}
                             {% set sessionData = session('formcreator') %}
                             {{ question.getRenderedHtml(domain, true, sessionData.data)|raw }}
                         {% endif %}

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/ActorField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/ActorField.php
@@ -374,9 +374,9 @@ function() {
       )->isInstanceOf(ComparisonException::class);
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isFalse();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/CheckboxesField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/CheckboxesField.php
@@ -265,9 +265,9 @@ public function testGetEmptyParameters() {
          ->isInstanceOf(\PluginFormcreatorQuestionRange::class);
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isTrue();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/DateField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/DateField.php
@@ -117,9 +117,9 @@ public function testGetName() {
       $this->string($output)->isEqualTo('Date');
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isTrue();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/DatetimeField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/DatetimeField.php
@@ -244,9 +244,9 @@ public function testNotEquals($value, $answer, $expected) {
       $this->boolean($instance->notEquals($value))->isEqualTo($expected);
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isTrue();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/DescriptionField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/DescriptionField.php
@@ -88,9 +88,9 @@ public function testPrepareQuestionInputForSave($input, $expected, $message) {
       }
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isTrue();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/DropdownField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/DropdownField.php
@@ -106,9 +106,9 @@ public function testPrepareQuestionInputForSave($input, $expected) {
       }
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isFalse();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/EmailField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/EmailField.php
@@ -97,10 +97,10 @@ public function testSerializeValue($value, $expected) {
       $this->string($output)->isEqualTo($expected ? $value : '');
    }
 
-   public function  testIsAnonymousFormCompatible() {
+   public function  testisPublicFormCompatible() {
       $question = $this->getQuestion();
       $instance = $this->newTestedInstance($question);
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isEqualTo(true);
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/FloatField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/FloatField.php
@@ -301,9 +301,9 @@ public function testGetEmptyParameters() {
          ->isInstanceOf(\PluginFormcreatorQuestionRegex::class);
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isTrue();
    }
 

diff --git a/tests/3-unit/GlpiPlugin/Formcreator/Field/GlpiSelectField.php b/tests/3-unit/GlpiPlugin/Formcreator/Field/GlpiSelectField.php
@@ -239,9 +239,9 @@ public function testIsValid($fields, $expectedValue, $expectedValidity) {
       $this->boolean($output)->isEqualTo($expectedValidity);
    }
 
-   public function testIsAnonymousFormCompatible() {
+   public function testisPublicFormCompatible() {
       $instance = $this->newTestedInstance($this->getQuestion());
-      $output = $instance->isAnonymousFormCompatible();
+      $output = $instance->isPublicFormCompatible();
       $this->boolean($output)->isFalse();
    }