1. class
  2. Illuminate
  3. \
  4. Validation
  5. \
  6. Rules
  7. \
  8. Date

Date

class Date implements Stringable (View source)

Traits

Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected $format

The format of the date.
protected $constraints

The constraints for the date 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.

from  Conditionable
$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.

from  Conditionable
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
Date
format(string $format)

Ensure the date has the given format.

Date
beforeToday()

Ensure the date is before today.

Date
afterToday()

Ensure the date is after today.

Date
todayOrBefore()

Ensure the date is before or equal to today.

Date
todayOrAfter()

Ensure the date is after or equal to today.

Date
before(DateTimeInterface|string $date)

Ensure the date is before the given date or date field.

Date
after(DateTimeInterface|string $date)

Ensure the date is after the given date or date field.

Date
beforeOrEqual(DateTimeInterface|string $date)

Ensure the date is on or before the specified date or date field.

Date
afterOrEqual(DateTimeInterface|string $date)

Ensure the date is on or after the given date or date field.

Date
between(DateTimeInterface|string $from, DateTimeInterface|string $to)

Ensure the date is between two dates or date fields.

Date
betweenOrEqual(DateTimeInterface|string $from, DateTimeInterface|string $to)

Ensure the date is between or equal to two dates or date fields.

Date
addRule(array|string $rules)

Add custom rules to the validation rules array.

string
formatDate(DateTimeInterface|string $date)

Format the date for the validation rule.

string
__toString()

Convert the rule to a validation string.

Details

in Conditionable at line 21
$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

in Conditionable at line 53
$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

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 28
Date format(string $format)

Ensure the date has the given format.

Parameters

string $format

Return Value

Date

at line 38
Date beforeToday()

Ensure the date is before today.

Return Value

Date

at line 46
Date afterToday()

Ensure the date is after today.

Return Value

Date

at line 54
Date todayOrBefore()

Ensure the date is before or equal to today.

Return Value

Date

at line 62
Date todayOrAfter()

Ensure the date is after or equal to today.

Return Value

Date

at line 70
Date before(DateTimeInterface|string $date)

Ensure the date is before the given date or date field.

Parameters

DateTimeInterface|string $date

Return Value

Date

at line 78
Date after(DateTimeInterface|string $date)

Ensure the date is after the given date or date field.

Parameters

DateTimeInterface|string $date

Return Value

Date

at line 86
Date beforeOrEqual(DateTimeInterface|string $date)

Ensure the date is on or before the specified date or date field.

Parameters

DateTimeInterface|string $date

Return Value

Date

at line 94
Date afterOrEqual(DateTimeInterface|string $date)

Ensure the date is on or after the given date or date field.

Parameters

DateTimeInterface|string $date

Return Value

Date

at line 102
Date between(DateTimeInterface|string $from, DateTimeInterface|string $to)

Ensure the date is between two dates or date fields.

Parameters

DateTimeInterface|string $from
DateTimeInterface|string $to

Return Value

Date

at line 110
Date betweenOrEqual(DateTimeInterface|string $from, DateTimeInterface|string $to)

Ensure the date is between or equal to two dates or date fields.

Parameters

DateTimeInterface|string $from
DateTimeInterface|string $to

Return Value

Date

at line 118
protected Date addRule(array|string $rules)

Add custom rules to the validation rules array.

Parameters

array|string $rules

Return Value

Date

at line 128
protected string formatDate(DateTimeInterface|string $date)

Format the date for the validation rule.

Parameters

DateTimeInterface|string $date

Return Value

string

at line 138
string __toString()

Convert the rule to a validation string.

Return Value

string