final class ValidationResult (View source)

Simple validation result class following the Result pattern

Methods

success(mixed $data, array $warnings = [])

Create a successful validation result

failure(string|array $errors, array $warnings = [])

Create a failed validation result

errors(array $errors, array $warnings = [])

Create a failed validation result with multiple errors

bool
isValid()

Check if validation succeeded

array
getErrors()

Get all validation error messages

string
getFirstError()

Get first error message or empty string if no errors

getData()

Get data from successful validation

bool
hasWarnings()

Check if the validation result has warnings

array
getWarnings()

Get warnings from the validation result

string
getFirstWarning()

Get first warning message or empty string if no warnings

addWarning(string $warning)

Add a warning to the validation result

addWarnings(array $warnings)

Add multiple warnings to the validation result

Details

static ValidationResult success(mixed $data, array $warnings = [])

Create a successful validation result

Parameters

mixed $data

The validated data

array $warnings

Optional warning messages for valid data

Return Value

ValidationResult

static ValidationResult failure(string|array $errors, array $warnings = [])

Create a failed validation result

Parameters

string|array $errors

Error message or array of error messages

array $warnings

Optional warning messages for invalid data

Return Value

ValidationResult

static ValidationResult errors(array $errors, array $warnings = [])

Create a failed validation result with multiple errors

Parameters

array $errors

Array of error messages

array $warnings

Optional warning messages for invalid data

Return Value

ValidationResult

bool isValid()

Check if validation succeeded

Return Value

bool

array getErrors()

Get all validation error messages

Return Value

array

string getFirstError()

Get first error message or empty string if no errors

Return Value

string

getData()

Get data from successful validation

Exceptions

RuntimeException

bool hasWarnings()

Check if the validation result has warnings

Return Value

bool

True if the result has warnings

array getWarnings()

Get warnings from the validation result

Return Value

array

The warnings array or empty array if none exist

string getFirstWarning()

Get first warning message or empty string if no warnings

Return Value

string

The first warning message

ValidationResult addWarning(string $warning)

Add a warning to the validation result

Parameters

string $warning

Warning message to add

Return Value

ValidationResult

This ValidationResult instance for method chaining

ValidationResult addWarnings(array $warnings)

Add multiple warnings to the validation result

Parameters

array $warnings

Array of warning messages to add

Return Value

ValidationResult

This ValidationResult instance for method chaining