Add ValidationInterface to the DataObject class

[emteknetnz]

https://github.com/silverstripe/silverstripe-framework/blob/6/src/Core/Validation/ValidationInterface.php provides a standardised method signature for objects with a validate() method

So far this had been added to

• DBField
• FormField
• FieldValidator (via the subclass FieldValidationInterface)

At very least it should be added to DataObject which already effectively implements it, just with loose typing.

If feasible within a reasonable amount of it, it should also be added to as many other objects that currently have a validate($validator) or validate(): bool, which will involve some level of refactoring

Acceptance criteria

• ValidationInterface is added to DataObject
• Any other validate() methods that can be easily refactored also implement ValidationInterface

Notes

Other validate() methods:

• framework Form validationResult(): ValidationResult (could simply be renamed to validate())
• framework Locales validate($locale): bool
• framework IntlLocales validate($locale): bool
• framework Embeddable validate(): bool
• framework EmbedContainer validate(): bool
• assets Upload_Validator validate(): bool
• assets Upload validate(): bool
• graphql - multiple validate(): void

Two lots of PRs:

A) Add ValidationInterface to DataObject
B) Rename Form::validationResult() to validate()

I've deemed changing the other method validate() methods with bool and void returns types as not worth the effort

A) Add ValidationInterface to DataObject - CM5 6.0

Kitchen Sink CI

• https://github.com/creative-commoners/recipe-kitchen-sink/actions/runs/12361270217

^ test failures are existing - elemental - framework

PRs

• API Add ValidationInterface to DataObject #11513
• API Update validate signature silverstripe-assets#668
• API Update validate signature silverstripe-blog#801
• API Update validate signature silverstripe-cms#3041
• API Update validate signature silverstripe-frameworktest#220
• API Update validate signature silverstripe-subsites#622
• API Update validate signature silverstripe-userforms#1360
• API Update validate signature silverstripe-admin#1877
• DOC Update validate signature developer-docs#654

B1) Rename Form::validationResult() to validate() - CMS 5

Kitchen Sink CI

• https://github.com/creative-commoners/recipe-kitchen-sink/actions/runs/12362226685

PRs

• API Use validate method instead of validationResult #11515
• DOC Deprecate Form validationResult developer-docs#655

Assign back to Steve to do merge-up and make PRs for CMS 6.0

B2) Rename Form::validationResult() to validate() - CMS 6.0

• Add ValidationInterface to Form, and remove deprecated method

Kitchen Sink CI

• https://github.com/creative-commoners/recipe-kitchen-sink/actions/runs/12407060400

^ Failing test is unrelated

PRs

• API Add ValidationInterface to Form #11518

[GuySartorelli]

I've deemed changing the other method validate() methods with bool and void returns types as not worth the effort

Can you please explain what you mean by "the other method validate() methods with bool and void returns types" and your reasoning for why they're not worth the effort?

[GuySartorelli]

@emteknetnz please respond to the above comment

[GuySartorelli]

PRs merged. Reassigning to steve to respond to the above and to do B2

[emteknetnz]

Can you please explain what you mean by "the other method validate() methods with bool and void returns types" and your reasoning for why they're not worth the effort?

In the "Notes" section in the description I listed what I think are all off the other validate() methods that don't return a ValidationResult.

DataObject::validate() and Form::validationResult() both return ValidationResult's already, so the amount of refactoring required in pretty minimal.

However all the other validate methods that don't return a ValidationResult require significantly more refactoring, and IMO it's not worth the effort at this stage given all the other things that need doing

[emteknetnz]

Have double checked, cannot find any other instances of ->validationResult()

[GuySartorelli]

PRs merged