1. trait
  2. Illuminate
  3. \
  4. Console
  5. \
  6. Scheduling
  7. \
  8. ManagesFrequencies

ManagesFrequencies

trait ManagesFrequencies

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
hourly()

Schedule the event to run hourly.

$this
hourlyAt(int $offset)

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

$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 $first = 1, int $second = 13)

Schedule the event to run twice daily.

$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(int $day, 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 $day = 1, string $time = '0:0')

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

$this
twiceMonthly(int $first = 1, int $second = 16)

Schedule the event to run twice monthly.

$this
quarterly()

Schedule the event to run quarterly.

$this
yearly()

Schedule the event to run yearly.

$this
everyMinute()

Schedule the event to run every minute.

$this
everyFiveMinutes()

Schedule the event to run every five minutes.

$this
everyTenMinutes()

Schedule the event to run every ten minutes.

$this
everyThirtyMinutes()

Schedule the event to run every thirty minutes.

$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

at line 15
$this cron(string $expression)

The Cron expression representing the event's frequency.

Parameters

string $expression

Return Value

$this

at line 29
$this between(string $startTime, string $endTime)

Schedule the event to run between start and end time.

Parameters

string $startTime
string $endTime

Return Value

$this

at line 41
$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

at line 69
$this hourly()

Schedule the event to run hourly.

Return Value

$this

at line 80
$this hourlyAt(int $offset)

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

Parameters

int $offset

Return Value

$this

at line 90
$this daily()

Schedule the event to run daily.

Return Value

$this

at line 102
$this at(string $time)

Schedule the command at a given time.

Parameters

string $time

Return Value

$this

at line 113
$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

at line 128
$this twiceDaily(int $first = 1, int $second = 13)

Schedule the event to run twice daily.

Parameters

int $first
int $second

Return Value

$this

at line 141
$this weekdays()

Schedule the event to run only on weekdays.

Return Value

$this

at line 151
$this weekends()

Schedule the event to run only on weekends.

Return Value

$this

at line 161
$this mondays()

Schedule the event to run only on Mondays.

Return Value

$this

at line 171
$this tuesdays()

Schedule the event to run only on Tuesdays.

Return Value

$this

at line 181
$this wednesdays()

Schedule the event to run only on Wednesdays.

Return Value

$this

at line 191
$this thursdays()

Schedule the event to run only on Thursdays.

Return Value

$this

at line 201
$this fridays()

Schedule the event to run only on Fridays.

Return Value

$this

at line 211
$this saturdays()

Schedule the event to run only on Saturdays.

Return Value

$this

at line 221
$this sundays()

Schedule the event to run only on Sundays.

Return Value

$this

at line 231
$this weekly()

Schedule the event to run weekly.

Return Value

$this

at line 245
$this weeklyOn(int $day, string $time = '0:0')

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

Parameters

int $day
string $time

Return Value

$this

at line 257
$this monthly()

Schedule the event to run monthly.

Return Value

$this

at line 271
$this monthlyOn(int $day = 1, string $time = '0:0')

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

Parameters

int $day
string $time

Return Value

$this

at line 285
$this twiceMonthly(int $first = 1, int $second = 16)

Schedule the event to run twice monthly.

Parameters

int $first
int $second

Return Value

$this

at line 299
$this quarterly()

Schedule the event to run quarterly.

Return Value

$this

at line 312
$this yearly()

Schedule the event to run yearly.

Return Value

$this

at line 325
$this everyMinute()

Schedule the event to run every minute.

Return Value

$this

at line 335
$this everyFiveMinutes()

Schedule the event to run every five minutes.

Return Value

$this

at line 345
$this everyTenMinutes()

Schedule the event to run every ten minutes.

Return Value

$this

at line 355
$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

Return Value

$this

at line 366
$this days(array|mixed $days)

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

Parameters

array|mixed $days

Return Value

$this

at line 379
$this timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

Parameters

DateTimeZone|string $timezone

Return Value

$this

at line 393
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