Merge pull request #11486 from creative-commoners/pulls/6/valid

API Rename validator classes

src/Forms/FieldsValidator.php

@@ -3,6 +3,7 @@
 namespace SilverStripe\Forms;
 
 use SilverStripe\Dev\Deprecation;
+use SilverStripe\Forms\Validation\Validator;
 
 /**
  * Validates the internal state of all fields in the form.

src/Forms/FileField.php

@@ -33,7 +33,7 @@
  *      $actions = new FieldList(
  *          new FormAction('doUpload', 'Upload file')
  *      );
- *      $validator = new RequiredFields(['MyName', 'MyFile']);
+ *      $validator = new RequiredFieldsValidator(['MyName', 'MyFile']);
  *
  *      return new Form($this, 'Form', $fields, $actions, $validator);
  *  }

src/Forms/Form.php

@@ -20,6 +20,8 @@
 use SilverStripe\View\AttributesHTML;
 use SilverStripe\View\SSViewer;
 use SilverStripe\Model\ModelData;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
+use SilverStripe\Forms\Validation\Validator;
 
 /**
  * Base class for all forms.
@@ -297,7 +299,7 @@ public function __construct(
         $this->setName($name);
 
         // Form validation
-        $this->validator = ($validator) ? $validator : new RequiredFields();
+        $this->validator = ($validator) ? $validator : new RequiredFieldsValidator();
         $this->validator->setForm($this);
 
         // Form error controls

src/Forms/GridField/GridFieldDetailForm.php

@@ -15,7 +15,7 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\FieldsValidator;
-use SilverStripe\Forms\Validator;
+use SilverStripe\Forms\Validation\Validator;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\Model\ModelData;

src/Forms/HasOneRelationFieldInterface.php

@@ -4,7 +4,7 @@
 
 /**
  * Added to form fields whose values are the ID of a has_one relation
- * This is used in RequiredFields validation to check if the value is set
+ * This is used in RequiredFieldsValidator validation to check if the value is set
  */
 interface HasOneRelationFieldInterface
 {

src/Forms/CompositeValidator.php → src/Forms/Validation/CompositeValidator.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace SilverStripe\Forms;
+namespace SilverStripe\Forms\Validation;
 
 use InvalidArgumentException;
 use SilverStripe\Core\Validation\ValidationResult;
@@ -20,7 +20,7 @@
  * {
  *   $compositeValidator = parent::getCMSCompositeValidator();
  *
- *   $compositeValidator->addValidator(RequiredFields::create(['MyRequiredField']));
+ *   $compositeValidator->addValidator(RequiredFieldsValidator::create(['MyRequiredField']));
  *
  *   return $compositeValidator
  * }
@@ -29,9 +29,8 @@
  *
  * protected function updateCMSCompositeValidator(CompositeValidator $compositeValidator): void
  * {
- *   $compositeValidator->addValidator(RequiredFields::create(['AdditionalContent']));
+ *   $compositeValidator->addValidator(RequiredFieldsValidator::create(['AdditionalContent']));
  * }
- * @deprecated 5.4.0 Will be renamed to SilverStripe\Forms\Validation\CompositeValidator
  */
 class CompositeValidator extends Validator
 {
@@ -47,11 +46,6 @@ class CompositeValidator extends Validator
      */
     public function __construct(array $validators = [])
     {
-        Deprecation::noticeWithNoReplacment(
-            '5.4.0',
-            'Will be renamed to SilverStripe\\Forms\\Validation\\CompositeValidator',
-            Deprecation::SCOPE_CLASS
-        );
         $this->validators = array_values($validators ?? []);
         parent::__construct();
     }
@@ -106,7 +100,7 @@ public function validate()
     }
 
     /**
-     * Note: The existing implementations for the php() method (@see RequiredFields) does not check whether the
+     * Note: The existing implementations for the php() method (@see RequiredFieldsValidator) does not check whether the
      * Validator is enabled or not, and it also does not reset the validation result - so, neither does this.
      *
      * @param array $data
@@ -156,7 +150,7 @@ public function getValidators(): array
     }
 
     /**
-     * Return all Validators that match a certain class name. EG: RequiredFields::class
+     * Return all Validators that match a certain class name. EG: RequiredFieldsValidator::class
      *
      * The keys for the return array match the keys in the unfiltered array. You cannot assume the keys will be
      * sequential or that the first key will be ZERO.
@@ -181,7 +175,7 @@ public function getValidatorsByType(string $className): array
     }
 
     /**
-     * Remove all Validators that match a certain class name. EG: RequiredFields::class
+     * Remove all Validators that match a certain class name. EG: RequiredFieldsValidator::class
      *
      * @param string $className
      * @return CompositeValidator

src/Forms/RequiredFields.php → src/Forms/Validation/RequiredFieldsValidator.php

@@ -1,9 +1,11 @@
 <?php
 
-namespace SilverStripe\Forms;
+namespace SilverStripe\Forms\Validation;
 
 use SilverStripe\Core\ArrayLib;
-use SilverStripe\Dev\Deprecation;
+use SilverStripe\Forms\HasOneRelationFieldInterface;
+use SilverStripe\Forms\FileField;
+use SilverStripe\Forms\FormField;
 
 /**
  * Required Fields allows you to set which fields need to be present before
@@ -12,10 +14,8 @@
  *
  * Validation is performed on a field by field basis through
  * {@link FormField::validate}.
- *
- * @deprecated 5.4.0 Will be renamed to SilverStripe\Forms\Validation\RequiredFieldsValidator
  */
-class RequiredFields extends Validator
+class RequiredFieldsValidator extends Validator
 {
     /**
      * Whether to globally allow whitespace only as a valid value for a required field
@@ -42,11 +42,6 @@ class RequiredFields extends Validator
      */
     public function __construct()
     {
-        Deprecation::noticeWithNoReplacment(
-            '5.4.0',
-            'Will be renamed to SilverStripe\\Forms\\Validation\\RequiredFieldsValidator',
-            Deprecation::SCOPE_CLASS
-        );
         $required = func_get_args();
         if (isset($required[0]) && is_array($required[0])) {
             $required = $required[0];
@@ -232,7 +227,7 @@ public function removeRequiredField($field)
     /**
      * Add {@link RequiredField} objects together
      *
-     * @param RequiredFields $requiredFields
+     * @param RequiredFieldsValidator $requiredFields
      * @return $this
      */
     public function appendRequiredFields($requiredFields)

src/Forms/Validator.php → src/Forms/Validation/Validator.php

@@ -1,19 +1,16 @@
 <?php
 
-namespace SilverStripe\Forms;
+namespace SilverStripe\Forms\Validation;
 
 use SilverStripe\Core\Config\Configurable;
 use SilverStripe\Core\Extensible;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Validation\ValidationResult;
-use SilverStripe\Dev\Deprecation;
 
 /**
  * This validation class handles all form and custom form validation through the use of Required
  * fields. It relies on javascript for client-side validation, and marking fields after server-side
  * validation. It acts as a visitor to individual form fields.
- *
- * @deprecated 5.4.0 Will be renamed to SilverStripe\Forms\Validation\Validator
  */
 abstract class Validator
 {
@@ -23,11 +20,6 @@ abstract class Validator
 
     public function __construct()
     {
-        Deprecation::noticeWithNoReplacment(
-            '5.4.0',
-            'Will be renamed to SilverStripe\\Forms\\Validation\\Validator',
-            Deprecation::SCOPE_CLASS
-        );
         $this->resetResult();
     }
 
@@ -179,7 +171,7 @@ public function removeValidation()
     /**
      * When Validators are set on the form, it can affect whether or not the form cannot be cached.
      *
-     * @see RequiredFields for an example of when you might be able to cache your form.
+     * @see RequiredFieldsValidator for an example of when you might be able to cache your form.
      *
      * @return bool
      */

src/ORM/DataObject.php

@@ -18,7 +18,7 @@
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\FormField;
 use SilverStripe\Forms\FormScaffolder;
-use SilverStripe\Forms\CompositeValidator;
+use SilverStripe\Forms\Validation\CompositeValidator;
 use SilverStripe\Forms\FieldsValidator;
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;

src/Security/Group.php

@@ -4,7 +4,7 @@
 
 use SilverStripe\Admin\SecurityAdmin;
 use SilverStripe\Core\Convert;
-use SilverStripe\Forms\CompositeValidator;
+use SilverStripe\Forms\Validation\CompositeValidator;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
@@ -23,7 +23,7 @@
 use SilverStripe\Forms\HTMLEditor\HTMLEditorConfig;
 use SilverStripe\Forms\ListboxField;
 use SilverStripe\Forms\LiteralField;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 use SilverStripe\Forms\Tab;
 use SilverStripe\Forms\TabSet;
 use SilverStripe\Forms\TextareaField;
@@ -559,7 +559,7 @@ public function getCMSCompositeValidator(): CompositeValidator
     {
         $validator = parent::getCMSCompositeValidator();
 
-        $validator->addValidator(RequiredFields::create([
+        $validator->addValidator(RequiredFieldsValidator::create([
             'Title'
         ]));
 

src/Security/LogoutForm.php

@@ -9,7 +9,7 @@
 use SilverStripe\Forms\Form;
 use SilverStripe\Forms\FormAction;
 use SilverStripe\Forms\HiddenField;
-use SilverStripe\Forms\Validator;
+use SilverStripe\Forms\Validation\Validator;
 
 /**
  * Log out form to display to users who arrive at 'Security/logout' without a

src/Security/Member.php

@@ -15,7 +15,7 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\TestMailer;
 use SilverStripe\Forms\CheckboxField;
-use SilverStripe\Forms\CompositeValidator;
+use SilverStripe\Forms\Validation\CompositeValidator;
 use SilverStripe\Forms\ConfirmedPasswordField;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
@@ -682,7 +682,7 @@ public function getMemberPasswordField()
 
 
     /**
-     * Returns the {@link RequiredFields} instance for the Member object. This
+     * Returns the {@link RequiredFieldsValidator} instance for the Member object. This
      * Validator is used when saving a {@link CMSProfileController} or added to
      * any form responsible for saving a users data.
      *

src/Security/MemberAuthenticator/MemberLoginForm.php

@@ -10,7 +10,7 @@
 use SilverStripe\Forms\HiddenField;
 use SilverStripe\Forms\LiteralField;
 use SilverStripe\Forms\PasswordField;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 use SilverStripe\Forms\TextField;
 use SilverStripe\Core\Validation\ValidationResult;
 use SilverStripe\Security\LoginForm as BaseLoginForm;
@@ -111,7 +111,7 @@ public function __construct(
         if (isset($logoutAction)) {
             $this->setFormAction($logoutAction);
         }
-        $this->setValidator(RequiredFields::create(static::config()->get('required_fields')));
+        $this->setValidator(RequiredFieldsValidator::create(static::config()->get('required_fields')));
     }
 
     /**

src/Security/Member_Validator.php

@@ -3,7 +3,7 @@
 namespace SilverStripe\Security;
 
 use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 
 /**
  * Member Validator
@@ -22,7 +22,7 @@
  *     - Surname
  * </code>
  */
-class Member_Validator extends RequiredFields
+class Member_Validator extends RequiredFieldsValidator
 {
     /**
      * Fields that are required by this validator

tests/php/Forms/CheckboxFieldTest.php

@@ -9,7 +9,7 @@
 use SilverStripe\ORM\DB;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Forms\CheckboxField;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 
 class CheckboxFieldTest extends SapphireTest
 {
@@ -200,7 +200,7 @@ public function testNoAriaRequired()
             "form",
             new FieldList($field),
             new FieldList(),
-            new RequiredFields(["RequiredField"])
+            new RequiredFieldsValidator(["RequiredField"])
         );
         $this->assertTrue($field->Required());
 

tests/php/Forms/CheckboxSetFieldTest.php

@@ -15,7 +15,7 @@
 use SilverStripe\Forms\CheckboxSetField;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 use SilverStripe\Model\ArrayData;
 
 class CheckboxSetFieldTest extends SapphireTest
@@ -355,7 +355,7 @@ public function testNoAriaRequired()
             "form",
             new FieldList($field),
             new FieldList(),
-            new RequiredFields(["RequiredField"])
+            new RequiredFieldsValidator(["RequiredField"])
         );
         $this->assertTrue($field->Required());
 

tests/php/Forms/CompositeFieldTest.php

@@ -7,7 +7,7 @@
 use SilverStripe\Forms\CompositeField;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\RequiredFields;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 use SilverStripe\Forms\TextField;
 
 class CompositeFieldTest extends SapphireTest