silverstripe-framework/docs/en/02_Developer_Guides/00_Model/09_Validation.md
Michael Pritchard fdbd899766 DOC Update SilverStripe to Silverstripe CMS
- Remaining Developer Guides and Upgrading
- SilverStripe in a namespace or api has not been change
- To keep PRs easier no formatting was changed

Update merge conflics with two files

Update Silverstripe Ltd, Silverstripe Cloud and Silverstripe CMS

Silverstripe CMS Ltd > Silverstripe Ltd
Silverstripe CMS Platform > Silverstripe Cloud
Silverstripe CMS Framework > Silverstripe CMS

Resolve merge conflict

Remove Framework from Silverstripe CMS Framework

- 3 files

Change SilverStripe CMS to Silverstripe CMS
2021-07-30 13:54:15 +01:00

1.9 KiB

title summary icon
Model Validation and Constraints Validate your data at the model level check-square

Validation and Constraints

Traditionally, validation in Silverstripe CMS has been mostly handled on the controller through form validation.

While this is a useful approach, it can lead to data inconsistencies if the record is modified outside of the controller and form context.

Most validation constraints are actually data constraints which belong on the model. Silverstripe CMS provides the DataObject::validate() method for this purpose.

By default, there is no validation - objects are always valid! However, you can overload this method in your DataObject sub-classes to specify custom validation, or use the validate hook through a DataExtension.

Invalid objects won't be able to be written - a ValidationException will be thrown and no write will occur.

It is expected that you call validate() in your own application to test that an object is valid before attempting a write, and respond appropriately if it isn't.

The return value of validate() is a ValidationResult object.

use SilverStripe\ORM\DataObject;

class MyObject extends DataObject 
{

    private static $db = [
        'Country' => 'Varchar',
        'Postcode' => 'Varchar'
    ];

    public function validate() 
    {
        $result = parent::validate();

        if($this->Country == 'DE' && $this->Postcode && strlen($this->Postcode) != 5) {
            $result->addError('Need five digits for German postcodes');
        }

        return $result;
    }
}

API Documentation