Assert

About 4 min

Assert

Assert provides a fluent interface for validating values against various criteria.

This class implements a builder pattern for constructing validation chains, allowing you to validate values against multiple criteria in a readable and maintainable way.

The class supports two validation modes:

Immediate mode (default): Throws exceptions as soon as a validation fails
Lazy mode: Collects all validation errors before throwing an exception

Example usage:

// Immediate validation mode
Assert::that($email)->string()->email();

// Lazy validation mode
Assert::that($user)
    ->lazy()
    ->notEmpty()
    ->object()
    ->verify();

// Numeric validation
Assert::that($age)
    ->integer()
    ->between(18, 100);

Properties

value

private mixed $value

errors

private array $errors

lazy

private bool $lazy

Methods

__construct

Creates a new Assert instance with the given value to validate.

private __construct(mixed $value, bool $lazy): void

Parameters

Parameter	Type	Description
`$value`	`mixed`	The value to validate
`$lazy`	`bool`	Whether to use lazy validation

that

Static factory method to create a new Assert instance for validating a value.

public that(mixed $value): self

This is the main entry point for starting a validation chain.

Parameters

Parameter	Type	Description
`$value`	`mixed`	The value to validate

lazy

Enables lazy validation mode where validation errors are collected rather than

public lazy(): self

throwing exceptions immediately. All errors can be checked at once using verify().

notEmpty

Validates that the value is not empty. Empty values include '', null, [], 0, '0', and false.

public notEmpty(string $message = 'Value is empty'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

string

Validates that the value is a string type.

public string(string $message = 'Value is not a string'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

integer

Validates that the value is an integer type.

public integer(string $message = 'Value is not an integer'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

float

Validates that the value is a float type.

public float(string $message = 'Value is not a float'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

boolean

Validates that the value is a boolean type.

public boolean(string $message = 'Value is not a boolean'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

numeric

Validates that the value is numeric (can be both string numerics and actual numbers).

public numeric(string $message = 'Value is not numeric'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

notNumeric

Validates that the value is not numeric (neither string numerics nor actual numbers).

public notNumeric(string $message = 'Value is numeric'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

scalar

Validates that the value is a scalar type (integer, float, string or boolean).

public scalar(string $message = 'Value is not a scalar'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

email

Validates that the value is a valid email address using PHP's filter_var function.

public email(string $message = 'Value is not a valid email address'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

url

Validates that the value is a valid URL using PHP's filter_var function.

public url(string $message = 'Value is not a valid URL'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

ip

Validates that the value is a valid IP address (IPv4 or IPv6).

public ip(string $message = 'Value is not a valid IP address'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

ipv4

Validates that the value is a valid IPv4 address.

public ipv4(string $message = 'Value is not a valid IPv4 address'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

ipv6

Validates that the value is a valid IPv6 address.

public ipv6(string $message = 'Value is not a valid IPv6 address'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

min

Validates that the numeric value is greater than or equal to the specified minimum.

public min(int $min, string $message = 'Value is less than minimum value'): self

Parameters

Parameter	Type	Description
`$min`	`int`	The minimum allowed value
`$message`	`string`	Custom error message when validation fails

max

Validates that the numeric value is less than or equal to the specified maximum.

public max(int $max, string $message = 'Value is greater than maximum value'): self

Parameters

Parameter	Type	Description
`$max`	`int`	The maximum allowed value
`$message`	`string`	Custom error message when validation fails

maxLength

Validates that the string length is not greater than the specified maximum.

public maxLength(int $max, string $message = 'Value length is greater than maximum length'): self

Parameters

Parameter	Type	Description
`$max`	`int`	The maximum allowed length
`$message`	`string`	Custom error message when validation fails

minLength

Validates that the string length is not less than the specified minimum.

public minLength(int $min, string $message = 'Value length is less than minimum length'): self

Parameters

Parameter	Type	Description
`$min`	`int`	The minimum allowed length
`$message`	`string`	Custom error message when validation fails

matchesRegex

Validates that the value matches the given regular expression pattern.

public matchesRegex(string $pattern, string $message = 'Value does not match pattern'): self

Parameters

Parameter	Type	Description
`$pattern`	`string`	The regular expression pattern to match against
`$message`	`string`	Custom error message when validation fails

between

Validates that the numeric value falls within the specified range (inclusive).

public between(int $min, int $max, string $message = 'Value is not between minimum and maximum values'): self

Parameters

Parameter	Type	Description
`$min`	`int`	The minimum allowed value
`$max`	`int`	The maximum allowed value
`$message`	`string`	Custom error message when validation fails

Validates that the value is an array.

public (string $message = 'Value is not an array'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

in

Validates that the value exists in the given array of allowed values.

public in(array $values, string $message = 'Value is not in the list of allowed values'): self

Parameters

Parameter	Type	Description
`$values`	`array`	Array of allowed values
`$message`	`string`	Custom error message when validation fails

notIn

Validates that the value does not exist in the given array of disallowed values.

public notIn(array $values, string $message = 'Value is in the list of disallowed values'): self

Parameters

Parameter	Type	Description
`$values`	`array`	Array of disallowed values
`$message`	`string`	Custom error message when validation fails

object

Validates that the value is an object.

public object(string $message = 'Value is not an object'): self

Parameters

Parameter	Type	Description
`$message`	`string`	Custom error message when validation fails

verify

Verifies all validations and throws a ValidationException if any errors occurred

public verify(): bool

during lazy validation. If not in lazy mode, this method will always return true as exceptions are thrown immediately upon validation failure.

except

Internal method to handle validation failures. Either throws an exception immediately

private except(string $message): void

or collects the error message for lazy validation.

Parameters

Parameter	Type	Description
`$message`	`string`	The error message to handle

Generated by Hazaar API Doc Generator