ManagesFrequencies
Table of Contents
- at() : $this
- Schedule the command at a given time.
- between() : $this
- Schedule the event to run between start and end time.
- cron() : $this
- The Cron expression representing the event's frequency.
- daily() : $this
- Schedule the event to run daily.
- dailyAt() : $this
- Schedule the event to run daily at a given time (10:00, 19:30, etc).
- days() : $this
- Set the days of the week the command should run on.
- everyFifteenMinutes() : $this
- Schedule the event to run every fifteen minutes.
- everyFiveMinutes() : $this
- Schedule the event to run every five minutes.
- everyMinute() : $this
- Schedule the event to run every minute.
- everyTenMinutes() : $this
- Schedule the event to run every ten minutes.
- everyThirtyMinutes() : $this
- Schedule the event to run every thirty minutes.
- fridays() : $this
- Schedule the event to run only on Fridays.
- hourly() : $this
- Schedule the event to run hourly.
- hourlyAt() : $this
- Schedule the event to run hourly at a given offset in the hour.
- mondays() : $this
- Schedule the event to run only on Mondays.
- monthly() : $this
- Schedule the event to run monthly.
- monthlyOn() : $this
- Schedule the event to run monthly on a given day and time.
- quarterly() : $this
- Schedule the event to run quarterly.
- saturdays() : $this
- Schedule the event to run only on Saturdays.
- sundays() : $this
- Schedule the event to run only on Sundays.
- thursdays() : $this
- Schedule the event to run only on Thursdays.
- timezone() : $this
- Set the timezone the date should be evaluated on.
- tuesdays() : $this
- Schedule the event to run only on Tuesdays.
- twiceDaily() : $this
- Schedule the event to run twice daily.
- twiceMonthly() : $this
- Schedule the event to run twice monthly.
- unlessBetween() : $this
- Schedule the event to not run between start and end time.
- wednesdays() : $this
- Schedule the event to run only on Wednesdays.
- weekdays() : $this
- Schedule the event to run only on weekdays.
- weekends() : $this
- Schedule the event to run only on weekends.
- weekly() : $this
- Schedule the event to run weekly.
- weeklyOn() : $this
- Schedule the event to run weekly on a given day and time.
- yearly() : $this
- Schedule the event to run yearly.
- spliceIntoPosition() : $this
- Splice the given value into the given position of the expression.
- inTimeInterval() : Closure
- Schedule the event to run between start and end time.
Methods
at()
Schedule the command at a given time.
public
at(string $time) : $this
Parameters
- $time : string
Return values
$this —between()
Schedule the event to run between start and end time.
public
between(string $startTime, string $endTime) : $this
Parameters
- $startTime : string
- $endTime : string
Return values
$this —cron()
The Cron expression representing the event's frequency.
public
cron(string $expression) : $this
Parameters
- $expression : string
Return values
$this —daily()
Schedule the event to run daily.
public
daily() : $this
Return values
$this —dailyAt()
Schedule the event to run daily at a given time (10:00, 19:30, etc).
public
dailyAt(string $time) : $this
Parameters
- $time : string
Return values
$this —days()
Set the days of the week the command should run on.
public
days(array<string|int, mixed>|mixed $days) : $this
Parameters
- $days : array<string|int, mixed>|mixed
Return values
$this —everyFifteenMinutes()
Schedule the event to run every fifteen minutes.
public
everyFifteenMinutes() : $this
Return values
$this —everyFiveMinutes()
Schedule the event to run every five minutes.
public
everyFiveMinutes() : $this
Return values
$this —everyMinute()
Schedule the event to run every minute.
public
everyMinute() : $this
Return values
$this —everyTenMinutes()
Schedule the event to run every ten minutes.
public
everyTenMinutes() : $this
Return values
$this —everyThirtyMinutes()
Schedule the event to run every thirty minutes.
public
everyThirtyMinutes() : $this
Return values
$this —fridays()
Schedule the event to run only on Fridays.
public
fridays() : $this
Return values
$this —hourly()
Schedule the event to run hourly.
public
hourly() : $this
Return values
$this —hourlyAt()
Schedule the event to run hourly at a given offset in the hour.
public
hourlyAt(int $offset) : $this
Parameters
- $offset : int
Return values
$this —mondays()
Schedule the event to run only on Mondays.
public
mondays() : $this
Return values
$this —monthly()
Schedule the event to run monthly.
public
monthly() : $this
Return values
$this —monthlyOn()
Schedule the event to run monthly on a given day and time.
public
monthlyOn([int $day = 1 ][, string $time = '0:0' ]) : $this
Parameters
- $day : int = 1
- $time : string = '0:0'
Return values
$this —quarterly()
Schedule the event to run quarterly.
public
quarterly() : $this
Return values
$this —saturdays()
Schedule the event to run only on Saturdays.
public
saturdays() : $this
Return values
$this —sundays()
Schedule the event to run only on Sundays.
public
sundays() : $this
Return values
$this —thursdays()
Schedule the event to run only on Thursdays.
public
thursdays() : $this
Return values
$this —timezone()
Set the timezone the date should be evaluated on.
public
timezone(DateTimeZone|string $timezone) : $this
Parameters
- $timezone : DateTimeZone|string
Return values
$this —tuesdays()
Schedule the event to run only on Tuesdays.
public
tuesdays() : $this
Return values
$this —twiceDaily()
Schedule the event to run twice daily.
public
twiceDaily([int $first = 1 ][, int $second = 13 ]) : $this
Parameters
- $first : int = 1
- $second : int = 13
Return values
$this —twiceMonthly()
Schedule the event to run twice monthly.
public
twiceMonthly([int $first = 1 ][, int $second = 16 ]) : $this
Parameters
- $first : int = 1
- $second : int = 16
Return values
$this —unlessBetween()
Schedule the event to not run between start and end time.
public
unlessBetween(string $startTime, string $endTime) : $this
Parameters
- $startTime : string
- $endTime : string
Return values
$this —wednesdays()
Schedule the event to run only on Wednesdays.
public
wednesdays() : $this
Return values
$this —weekdays()
Schedule the event to run only on weekdays.
public
weekdays() : $this
Return values
$this —weekends()
Schedule the event to run only on weekends.
public
weekends() : $this
Return values
$this —weekly()
Schedule the event to run weekly.
public
weekly() : $this
Return values
$this —weeklyOn()
Schedule the event to run weekly on a given day and time.
public
weeklyOn(int $day[, string $time = '0:0' ]) : $this
Parameters
- $day : int
- $time : string = '0:0'
Return values
$this —yearly()
Schedule the event to run yearly.
public
yearly() : $this
Return values
$this —spliceIntoPosition()
Splice the given value into the given position of the expression.
protected
spliceIntoPosition(int $position, string $value) : $this
Parameters
- $position : int
- $value : string
Return values
$this —inTimeInterval()
Schedule the event to run between start and end time.
private
inTimeInterval(string $startTime, string $endTime) : Closure
Parameters
- $startTime : string
- $endTime : string