From ad10507213c5c73539a7e2a64077edbad30e759c Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Wed, 4 Dec 2024 13:34:44 +1300 Subject: [PATCH] DOC Rename validator classes --- en/02_Developer_Guides/03_Forms/00_Introduction.md | 8 ++++---- en/02_Developer_Guides/03_Forms/01_Validation.md | 14 +++++++------- .../03_Forms/How_Tos/01_Encapsulate_Forms.md | 8 ++++---- .../03_Forms/How_Tos/05_Simple_Contact_Form.md | 8 ++++---- .../03_Forms/How_Tos/06_Handle_Nested_data.md | 12 ++++++------ en/08_Changelogs/6.0.0.md | 10 ++++++++++ 6 files changed, 35 insertions(+), 25 deletions(-) diff --git a/en/02_Developer_Guides/03_Forms/00_Introduction.md b/en/02_Developer_Guides/03_Forms/00_Introduction.md index 4c769ebfc..febbbcc41 100644 --- a/en/02_Developer_Guides/03_Forms/00_Introduction.md +++ b/en/02_Developer_Guides/03_Forms/00_Introduction.md @@ -40,7 +40,7 @@ use PageController; use SilverStripe\Forms\FieldList; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormAction; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyFormPageController extends PageController @@ -63,7 +63,7 @@ class MyFormPageController extends PageController FormAction::create('doSayHello')->setTitle('Say hello') ); - $required = RequiredFields::create('Name'); + $required = RequiredFieldsValidator::create('Name'); $form = Form::create($this, 'HelloForm', $fields, $actions, $required); @@ -414,7 +414,7 @@ namespace App\PageType; use PageController; use SilverStripe\Forms\Form; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; class MyFormPageController extends PageController { @@ -424,7 +424,7 @@ class MyFormPageController extends PageController { // ... - $validator = RequiredFields::create([ + $validator = RequiredFieldsValidator::create([ 'Name', 'Email', ]); diff --git a/en/02_Developer_Guides/03_Forms/01_Validation.md b/en/02_Developer_Guides/03_Forms/01_Validation.md index 1107a4841..d29cb4684 100644 --- a/en/02_Developer_Guides/03_Forms/01_Validation.md +++ b/en/02_Developer_Guides/03_Forms/01_Validation.md @@ -21,7 +21,7 @@ use PageController; use SilverStripe\Forms\EmailField; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormAction; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyFormPageController extends PageController @@ -46,7 +46,7 @@ class MyFormPageController extends PageController ); // the fields 'Name' and 'Email' are required. - $required = RequiredFields::create([ + $required = RequiredFieldsValidator::create([ 'Name', 'Email', ]); @@ -237,7 +237,7 @@ class MyFormPageController extends PageController public function doSubmitForm($data, $form) { - // At this point, RequiredFields->isValid() will have been called already, + // At this point, RequiredFieldsValidator->isValid() will have been called already, // so we can assume that the values exist. Say we want to make sure that email hasn't already been used. $check = Member::get()->filter('Email', $data['Email'])->first(); @@ -267,7 +267,7 @@ The Silverstripe framework comes with the following built-in validators: given form by putting them inside a `CompositeValidator`. The `CompositeValidator` doesn't have perform any validation by itself. - [`FieldsValidator`](api:SilverStripe\Forms\FieldsValidator) Simply calls [`validate()`](api:SilverStripe\Forms\FormField::validate()) on all data fields in the form, to ensure fields have valid values. -- [`RequiredFields`](api:SilverStripe\Forms\RequiredFields) +- [`RequiredFieldsValidator`](api:SilverStripe\Forms\RequiredFieldsValidator) Validates that fields you declare as "required" have a value. There are additional validators available in community modules, and you can implement your own validators by subclassing the abstract `Validator` class. @@ -385,7 +385,7 @@ namespace App\PageType; use Page; use SilverStripe\Forms\CompositeValidator; use SilverStripe\Forms\FieldList; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyPage extends Page @@ -408,7 +408,7 @@ class MyPage extends Page public function getCMSCompositeValidator(): CompositeValidator { $validator = parent::getCMSCompositeValidator(); - $validator->addValidator(RequiredFields::create([ + $validator->addValidator(RequiredFieldsValidator::create([ 'MyRequiredField', ])); return $validator; @@ -422,5 +422,5 @@ class MyPage extends Page ## API documentation -- [RequiredFields](api:SilverStripe\Forms\RequiredFields) +- [RequiredFieldsValidator](api:SilverStripe\Forms\RequiredFieldsValidator) - [Validator](api:SilverStripe\Forms\Validator) diff --git a/en/02_Developer_Guides/03_Forms/How_Tos/01_Encapsulate_Forms.md b/en/02_Developer_Guides/03_Forms/How_Tos/01_Encapsulate_Forms.md index fc63868b9..aac783ab9 100644 --- a/en/02_Developer_Guides/03_Forms/How_Tos/01_Encapsulate_Forms.md +++ b/en/02_Developer_Guides/03_Forms/How_Tos/01_Encapsulate_Forms.md @@ -24,7 +24,7 @@ use SilverStripe\Forms\FormAction; use SilverStripe\Forms\HeaderField; use SilverStripe\Forms\NumericField; use SilverStripe\Forms\OptionsetField; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; class SearchPageController extends PageController { @@ -57,7 +57,7 @@ class SearchPageController extends PageController FormAction::create('doSearchForm', 'Search') ); - $required = RequiredFields::create([ + $required = RequiredFieldsValidator::create([ 'Type', ]); @@ -92,7 +92,7 @@ use SilverStripe\Forms\FormAction; use SilverStripe\Forms\HeaderField; use SilverStripe\Forms\NumericField; use SilverStripe\Forms\OptionsetField; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; class SearchForm extends Form { @@ -127,7 +127,7 @@ class SearchForm extends Form FormAction::create('doSearchForm', 'Search') ); - $required = RequiredFields::create([ + $required = RequiredFieldsValidator::create([ 'Type', ]); diff --git a/en/02_Developer_Guides/03_Forms/How_Tos/05_Simple_Contact_Form.md b/en/02_Developer_Guides/03_Forms/How_Tos/05_Simple_Contact_Form.md index 017e82621..0efc6ef07 100644 --- a/en/02_Developer_Guides/03_Forms/How_Tos/05_Simple_Contact_Form.md +++ b/en/02_Developer_Guides/03_Forms/How_Tos/05_Simple_Contact_Form.md @@ -151,14 +151,14 @@ The final thing we do is return a 'thank you for your feedback' message to the u All forms have some basic validation built in – email fields will only let the user enter email addresses, number fields will only accept numbers, and so on. Sometimes you need more complicated validation, so you can define your own validation by extending the Validator class. -The framework comes with a predefined validator called [RequiredFields](api:SilverStripe\Forms\RequiredFields), which performs the common task of making sure particular fields are filled out. Below is the code to add validation to a contact form: +The framework comes with a predefined validator called [`RequiredFieldsValidator`](api:SilverStripe\Forms\RequiredFieldsValidator), which performs the common task of making sure particular fields are filled out. Below is the code to add validation to a contact form: ```php namespace App\PageType; use PageController; use SilverStripe\Forms\Form; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; class ContactPageController extends PageController { @@ -167,10 +167,10 @@ class ContactPageController extends PageController public function getForm() { // ... - $validator = RequiredFields::create('Name', 'Message'); + $validator = RequiredFieldsValidator::create('Name', 'Message'); return Form::create($this, 'Form', $fields, $actions, $validator); } } ``` -We've created a RequiredFields object, passing the name of the fields we want to be required. The validator we have created is then passed as the fifth argument of the form constructor. If we now try to submit the form without filling out the required fields, JavaScript validation will kick in, and the user will be presented with a message about the missing fields. If the user has JavaScript disabled, PHP validation will kick in when the form is submitted, and the user will be redirected back to the Form with messages about their missing fields. +We've created a RequiredFieldsValidator object, passing the name of the fields we want to be required. The validator we have created is then passed as the fifth argument of the form constructor. If we now try to submit the form without filling out the required fields, JavaScript validation will kick in, and the user will be presented with a message about the missing fields. If the user has JavaScript disabled, PHP validation will kick in when the form is submitted, and the user will be redirected back to the Form with messages about their missing fields. diff --git a/en/02_Developer_Guides/03_Forms/How_Tos/06_Handle_Nested_data.md b/en/02_Developer_Guides/03_Forms/How_Tos/06_Handle_Nested_data.md index c43521d83..02f364a6b 100644 --- a/en/02_Developer_Guides/03_Forms/How_Tos/06_Handle_Nested_data.md +++ b/en/02_Developer_Guides/03_Forms/How_Tos/06_Handle_Nested_data.md @@ -69,7 +69,7 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormAction; use SilverStripe\Forms\HiddenField; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyController extends Controller @@ -99,7 +99,7 @@ class MyController extends Controller FieldList::create([ FormAction::create('doSubmitForm', 'Submit'), ]), - RequiredFields::create([ + RequiredFieldsValidator::create([ 'Name', 'Teams', 'ID', @@ -149,7 +149,7 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormAction; use SilverStripe\Forms\HiddenField; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyController extends Controller @@ -177,7 +177,7 @@ class MyController extends Controller FieldList::create([ FormAction::create('doSubmitForm', 'Submit'), ]), - RequiredFields::create([ + RequiredFieldsValidator::create([ 'Name', 'HometownTeam.Name', 'ID', @@ -232,7 +232,7 @@ use SilverStripe\Forms\FieldList; use SilverStripe\Forms\Form; use SilverStripe\Forms\FormAction; use SilverStripe\Forms\HiddenField; -use SilverStripe\Forms\RequiredFields; +use SilverStripe\Forms\RequiredFieldsValidator; use SilverStripe\Forms\TextField; class MyController extends Controller @@ -262,7 +262,7 @@ class MyController extends Controller FieldList::create([ FormAction::create('doSubmitForm', 'Submit'), ]), - RequiredFields::create([ + RequiredFieldsValidator::create([ 'Name', 'MyTeams[]', 'ID', diff --git a/en/08_Changelogs/6.0.0.md b/en/08_Changelogs/6.0.0.md index eeed40fd5..0c50bd62a 100644 --- a/en/08_Changelogs/6.0.0.md +++ b/en/08_Changelogs/6.0.0.md @@ -895,6 +895,16 @@ The following classes have been changed when code was moved to the `silverstripe |`SilverStripe\ExternalLinks\Tasks\CurlLinkChecker`|[`SilverStripe\Reports\ExternalLinks\Tasks\CurlLinkChecker`](api:SilverStripe\Reports\ExternalLinks\Tasks\CurlLinkChecker)| |`SilverStripe\ExternalLinks\Tasks\LinkChecker`|[`SilverStripe\Reports\ExternalLinks\Tasks\LinkChecker`](api:SilverStripe\Reports\ExternalLinks\Tasks\LinkChecker)| +The following subclasses of [`Validator`](api:SilverStripe\Forms\Validator) have been renamed: + +|Old FQCN|New FQCN| +|---|---| +|`SilverStripe\Forms\RequiredFields`|[`SilverStripe\Forms\RequiredFieldsValidator`](api:SilverStripe\Forms\RequiredFieldsValidator)| +|`SilverStripe\UserForms\Form\UserFormsRequiredFields`|[`SilverStripe\UserForms\Form\UserFormsRequiredFieldsValidator`](api:SilverStripe\UserForms\Form\UserFormsRequiredFieldsValidator)| +|`Symbiote\AdvancedWorkflow\Forms\AWRequiredFields`|[`Symbiote\AdvancedWorkflow\Forms\AWRequiredFieldsValidator`](api:Symbiote\AdvancedWorkflow\Forms\AWRequiredFieldsValidator)| + +Note that `SilverStripe\Forms\FieldsValidator` has been removed. + ### GraphQL removed from the CMS {#graphql-removed} > [!NOTE]