trait ManagesFrequencies (View source)

Methods

$this
cron(string $expression)

The Cron expression representing the event's frequency.

$this
between(string $startTime, string $endTime)

Schedule the event to run between start and end time.

$this
unlessBetween(string $startTime, string $endTime)

Schedule the event to not run between start and end time.

$this
everySecond()

Schedule the event to run every second.

$this
everyTwoSeconds()

Schedule the event to run every two seconds.

$this
everyFiveSeconds()

Schedule the event to run every five seconds.

$this
everyTenSeconds()

Schedule the event to run every ten seconds.

$this
everyFifteenSeconds()

Schedule the event to run every fifteen seconds.

$this
everyTwentySeconds()

Schedule the event to run every twenty seconds.

$this
everyThirtySeconds()

Schedule the event to run every thirty seconds.

$this
repeatEvery(int<0, 59> $seconds)

Schedule the event to run multiple times per minute.

$this
everyMinute()

Schedule the event to run every minute.

$this
everyTwoMinutes()

Schedule the event to run every two minutes.

$this
everyThreeMinutes()

Schedule the event to run every three minutes.

$this
everyFourMinutes()

Schedule the event to run every four minutes.

$this
everyFiveMinutes()

Schedule the event to run every five minutes.

$this
everyTenMinutes()

Schedule the event to run every ten minutes.

$this
everyFifteenMinutes()

Schedule the event to run every fifteen minutes.

$this
everyThirtyMinutes()

Schedule the event to run every thirty minutes.

$this
hourly()

Schedule the event to run hourly.

$this
hourlyAt(array|string|int<0, 23>|int<0, 23>[] $offset)

Schedule the event to run hourly at a given offset in the hour.

$this
everyOddHour(array|string|int $offset = 0)

Schedule the event to run every odd hour.

$this
everyTwoHours(array|string|int $offset = 0)

Schedule the event to run every two hours.

$this
everyThreeHours(array|string|int $offset = 0)

Schedule the event to run every three hours.

$this
everyFourHours(array|string|int $offset = 0)

Schedule the event to run every four hours.

$this
everySixHours(array|string|int $offset = 0)

Schedule the event to run every six hours.

$this
daily()

Schedule the event to run daily.

$this
at(string $time)

Schedule the command at a given time.

$this
dailyAt(string $time)

Schedule the event to run daily at a given time (10:00, 19:30, etc).

$this
twiceDaily(int<0, 23> $first = 1, int<0, 23> $second = 13)

Schedule the event to run twice daily.

$this
twiceDailyAt(int<0, 23> $first = 1, int<0, 23> $second = 13, int<0, 59> $offset = 0)

Schedule the event to run twice daily at a given offset.

$this
hourBasedSchedule(array|string|int<0, 59> $minutes, array|string|int<0, 23> $hours)

Schedule the event to run at the given minutes and hours.

$this
weekdays()

Schedule the event to run only on weekdays.

$this
weekends()

Schedule the event to run only on weekends.

$this
mondays()

Schedule the event to run only on Mondays.

$this
tuesdays()

Schedule the event to run only on Tuesdays.

$this
wednesdays()

Schedule the event to run only on Wednesdays.

$this
thursdays()

Schedule the event to run only on Thursdays.

$this
fridays()

Schedule the event to run only on Fridays.

$this
saturdays()

Schedule the event to run only on Saturdays.

$this
sundays()

Schedule the event to run only on Sundays.

$this
weekly()

Schedule the event to run weekly.

$this
weeklyOn(array|mixed $dayOfWeek, string $time = '0:0')

Schedule the event to run weekly on a given day and time.

$this
monthly()

Schedule the event to run monthly.

$this
monthlyOn(int<1, 31> $dayOfMonth = 1, string $time = '0:0')

Schedule the event to run monthly on a given day and time.

$this
twiceMonthly(int<1, 31> $first = 1, int<1, 31> $second = 16, string $time = '0:0')

Schedule the event to run twice monthly at a given time.

$this
lastDayOfMonth(string $time = '0:0')

Schedule the event to run on the last day of the month.

$this
quarterly()

Schedule the event to run quarterly.

$this
quarterlyOn(int $dayOfQuarter = 1, string $time = '0:0')

Schedule the event to run quarterly on a given day and time.

$this
yearly()

Schedule the event to run yearly.

$this
yearlyOn(int $month = 1, int<1, 31>|string $dayOfMonth = 1, string $time = '0:0')

Schedule the event to run yearly on a given month, day, and time.

$this
days(array|mixed $days)

Set the days of the week the command should run on.

$this
timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

$this
spliceIntoPosition(int $position, string $value)

Splice the given value into the given position of the expression.

Details

$this cron(string $expression)

The Cron expression representing the event's frequency.

Parameters

string $expression

Return Value

$this

$this between(string $startTime, string $endTime)

Schedule the event to run between start and end time.

Parameters

string $startTime
string $endTime

Return Value

$this

$this unlessBetween(string $startTime, string $endTime)

Schedule the event to not run between start and end time.

Parameters

string $startTime
string $endTime

Return Value

$this

$this everySecond()

Schedule the event to run every second.

Return Value

$this

$this everyTwoSeconds()

Schedule the event to run every two seconds.

Return Value

$this

$this everyFiveSeconds()

Schedule the event to run every five seconds.

Return Value

$this

$this everyTenSeconds()

Schedule the event to run every ten seconds.

Return Value

$this

$this everyFifteenSeconds()

Schedule the event to run every fifteen seconds.

Return Value

$this

$this everyTwentySeconds()

Schedule the event to run every twenty seconds.

Return Value

$this

$this everyThirtySeconds()

Schedule the event to run every thirty seconds.

Return Value

$this

protected $this repeatEvery(int<0, 59> $seconds)

Schedule the event to run multiple times per minute.

Parameters

int<0, 59> $seconds

Return Value

$this

$this everyMinute()

Schedule the event to run every minute.

Return Value

$this

$this everyTwoMinutes()

Schedule the event to run every two minutes.

Return Value

$this

$this everyThreeMinutes()

Schedule the event to run every three minutes.

Return Value

$this

$this everyFourMinutes()

Schedule the event to run every four minutes.

Return Value

$this

$this everyFiveMinutes()

Schedule the event to run every five minutes.

Return Value

$this

$this everyTenMinutes()

Schedule the event to run every ten minutes.

Return Value

$this

$this everyFifteenMinutes()

Schedule the event to run every fifteen minutes.

Return Value

$this

$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

Return Value

$this

$this hourly()

Schedule the event to run hourly.

Return Value

$this

$this hourlyAt(array|string|int<0, 23>|int<0, 23>[] $offset)

Schedule the event to run hourly at a given offset in the hour.

Parameters

array|string|int<0, 23>|int<0, 23>[] $offset

Return Value

$this

$this everyOddHour(array|string|int $offset = 0)

Schedule the event to run every odd hour.

Parameters

array|string|int $offset

Return Value

$this

$this everyTwoHours(array|string|int $offset = 0)

Schedule the event to run every two hours.

Parameters

array|string|int $offset

Return Value

$this

$this everyThreeHours(array|string|int $offset = 0)

Schedule the event to run every three hours.

Parameters

array|string|int $offset

Return Value

$this

$this everyFourHours(array|string|int $offset = 0)

Schedule the event to run every four hours.

Parameters

array|string|int $offset

Return Value

$this

$this everySixHours(array|string|int $offset = 0)

Schedule the event to run every six hours.

Parameters

array|string|int $offset

Return Value

$this

$this daily()

Schedule the event to run daily.

Return Value

$this

$this at(string $time)

Schedule the command at a given time.

Parameters

string $time

Return Value

$this

$this dailyAt(string $time)

Schedule the event to run daily at a given time (10:00, 19:30, etc).

Parameters

string $time

Return Value

$this

$this twiceDaily(int<0, 23> $first = 1, int<0, 23> $second = 13)

Schedule the event to run twice daily.

Parameters

int<0, 23> $first
int<0, 23> $second

Return Value

$this

$this twiceDailyAt(int<0, 23> $first = 1, int<0, 23> $second = 13, int<0, 59> $offset = 0)

Schedule the event to run twice daily at a given offset.

Parameters

int<0, 23> $first
int<0, 23> $second
int<0, 59> $offset

Return Value

$this

protected $this hourBasedSchedule(array|string|int<0, 59> $minutes, array|string|int<0, 23> $hours)

Schedule the event to run at the given minutes and hours.

Parameters

array|string|int<0, 59> $minutes
array|string|int<0, 23> $hours

Return Value

$this

$this weekdays()

Schedule the event to run only on weekdays.

Return Value

$this

$this weekends()

Schedule the event to run only on weekends.

Return Value

$this

$this mondays()

Schedule the event to run only on Mondays.

Return Value

$this

$this tuesdays()

Schedule the event to run only on Tuesdays.

Return Value

$this

$this wednesdays()

Schedule the event to run only on Wednesdays.

Return Value

$this

$this thursdays()

Schedule the event to run only on Thursdays.

Return Value

$this

$this fridays()

Schedule the event to run only on Fridays.

Return Value

$this

$this saturdays()

Schedule the event to run only on Saturdays.

Return Value

$this

$this sundays()

Schedule the event to run only on Sundays.

Return Value

$this

$this weekly()

Schedule the event to run weekly.

Return Value

$this

$this weeklyOn(array|mixed $dayOfWeek, string $time = '0:0')

Schedule the event to run weekly on a given day and time.

Parameters

array|mixed $dayOfWeek
string $time

Return Value

$this

$this monthly()

Schedule the event to run monthly.

Return Value

$this

$this monthlyOn(int<1, 31> $dayOfMonth = 1, string $time = '0:0')

Schedule the event to run monthly on a given day and time.

Parameters

int<1, 31> $dayOfMonth
string $time

Return Value

$this

$this twiceMonthly(int<1, 31> $first = 1, int<1, 31> $second = 16, string $time = '0:0')

Schedule the event to run twice monthly at a given time.

Parameters

int<1, 31> $first
int<1, 31> $second
string $time

Return Value

$this

$this lastDayOfMonth(string $time = '0:0')

Schedule the event to run on the last day of the month.

Parameters

string $time

Return Value

$this

$this quarterly()

Schedule the event to run quarterly.

Return Value

$this

$this quarterlyOn(int $dayOfQuarter = 1, string $time = '0:0')

Schedule the event to run quarterly on a given day and time.

Parameters

int $dayOfQuarter
string $time

Return Value

$this

$this yearly()

Schedule the event to run yearly.

Return Value

$this

$this yearlyOn(int $month = 1, int<1, 31>|string $dayOfMonth = 1, string $time = '0:0')

Schedule the event to run yearly on a given month, day, and time.

Parameters

int $month
int<1, 31>|string $dayOfMonth
string $time

Return Value

$this

$this days(array|mixed $days)

Set the days of the week the command should run on.

Parameters

array|mixed $days

Return Value

$this

$this timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

Parameters

DateTimeZone|string $timezone

Return Value

$this

protected $this spliceIntoPosition(int $position, string $value)

Splice the given value into the given position of the expression.

Parameters

int $position
string $value

Return Value

$this