\CronExpression_DayOfMonthField

Day of month field. Allows: * , / - ? L W

'L' stands for "last" and specifies the last day of the month.

The 'W' character is used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days.

Summary

Methods

Properties

Constants

isSatisfied()
isRange()
isIncrementsOfRanges()
isInRange()
isInIncrementsOfRanges()
isSatisfiedBy()
increment()
validate()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

getNearestWeekday()

No private properties found

N/A

File: includes/lib/action-scheduler/lib/cron-expression/CronExpression_DayOfMonthField.php
Package: Default
Class hierarchy: normal

\CronExpression_DayOfMonthField

Methods

isSatisfied()

isSatisfied(string  $dateValue, string  $value) : bool

Check to see if a field is satisfied by a value

Parameters

string	$dateValue	Date value to check
string	$value	Value to test

Returns

bool

isRange()

isRange(string  $value) : bool

Check if a value is a range

Parameters

string

$value

Value to test

Returns

bool

isIncrementsOfRanges()

isIncrementsOfRanges(string  $value) : bool

Check if a value is an increments of ranges

Parameters

string

$value

Value to test

Returns

bool

isInRange()

isInRange(string  $dateValue, string  $value) : bool

Test if a value is within a range

Parameters

string	$dateValue	Set date value
string	$value	Value to test

Returns

bool

isInIncrementsOfRanges()

isInIncrementsOfRanges(string  $dateValue, string  $value) : bool

Test if a value is within an increments of ranges (offset[-to]/step size)

Parameters

string	$dateValue	Set date value
string	$value	Value to test

Returns

bool

isSatisfiedBy()

isSatisfiedBy(\DateTime  $date, mixed  $value) : mixed

{@inheritdoc}

Parameters

\DateTime	$date
mixed	$value

Returns

mixed

increment()

increment(\DateTime  $date, mixed  $invert = false) : mixed

{@inheritdoc}

Parameters

\DateTime	$date
mixed	$invert

Returns

mixed

validate()

validate(mixed  $value) : mixed

{@inheritdoc}

Parameters

mixed

$value

Returns

mixed

getNearestWeekday()

getNearestWeekday(int  $currentYear, int  $currentMonth, int  $targetDay) : \DateTime

Get the nearest day of the week for a given day in a month

Parameters

int	$currentYear	Current year
int	$currentMonth	Current month
int	$targetDay	Target day of the month

Returns

\DateTime —

Returns the nearest date