class ValidationException extends Exception (View source)

Exception thrown by {@link DataObject}::write if validation fails. By throwing an exception rather than a user error, the exception can be caught in unit tests and as such can be used as a successful test.

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(ValidationResult|string $result = null, int $code = 0)

Construct a new ValidationException with an optional ValidationResult object

getResult()

Retrieves the ValidationResult related to this error

Details

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(ValidationResult|string $result = null, int $code = 0)

Construct a new ValidationException with an optional ValidationResult object

Parameters

ValidationResult|string $result

The ValidationResult containing the failed result, or error message to build error from

int $code

The error code number

ValidationResult getResult()

Retrieves the ValidationResult related to this error

Return Value

ValidationResult