class Dimensions implements Stringable (View source)

Traits

Properties

protected array $constraints

The constraints for the dimensions rule.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

void
__construct(array $constraints = [])

Create a new dimensions rule instance.

$this
width(int $value)

Set the "width" constraint.

$this
height(int $value)

Set the "height" constraint.

$this
minWidth(int $value)

Set the "min width" constraint.

$this
minHeight(int $value)

Set the "min height" constraint.

$this
maxWidth(int $value)

Set the "max width" constraint.

$this
maxHeight(int $value)

Set the "max height" constraint.

$this
ratio(float $value)

Set the "ratio" constraint.

$this
minRatio(float $value)

Set the minimum aspect ratio.

$this
maxRatio(float $value)

Set the maximum aspect ratio.

$this
ratioBetween(float $min, float $max)

Set the aspect ratio range.

string
__toString()

Convert the rule to a validation string.

Details

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

void __construct(array $constraints = [])

Create a new dimensions rule instance.

Parameters

array $constraints

Return Value

void

$this width(int $value)

Set the "width" constraint.

Parameters

int $value

Return Value

$this

$this height(int $value)

Set the "height" constraint.

Parameters

int $value

Return Value

$this

$this minWidth(int $value)

Set the "min width" constraint.

Parameters

int $value

Return Value

$this

$this minHeight(int $value)

Set the "min height" constraint.

Parameters

int $value

Return Value

$this

$this maxWidth(int $value)

Set the "max width" constraint.

Parameters

int $value

Return Value

$this

$this maxHeight(int $value)

Set the "max height" constraint.

Parameters

int $value

Return Value

$this

$this ratio(float $value)

Set the "ratio" constraint.

Parameters

float $value

Return Value

$this

$this minRatio(float $value)

Set the minimum aspect ratio.

Parameters

float $value

Return Value

$this

$this maxRatio(float $value)

Set the maximum aspect ratio.

Parameters

float $value

Return Value

$this

$this ratioBetween(float $min, float $max)

Set the aspect ratio range.

Parameters

float $min
float $max

Return Value

$this

string __toString()

Convert the rule to a validation string.

Return Value

string