1. class
  2. Illuminate
  3. \
  4. Console
  5. \
  6. Scheduling
  7. \
  8. PendingEventAttributes

PendingEventAttributes

class PendingEventAttributes mixin Schedule (View source)

Traits

ManagesAttributes
ManagesFrequencies

Properties

string $expression

The cron expression representing the event's frequency.

 from  ManagesAttributes
int|null $repeatSeconds

How often to repeat the event during a minute.

 from  ManagesAttributes
DateTimeZone|string $timezone

The timezone the date should be evaluated on.

 from  ManagesAttributes
string|null $user

The user the command should run as.

 from  ManagesAttributes
array $environments

The list of environments the command should run under.

 from  ManagesAttributes
bool $evenInMaintenanceMode

Indicates if the command should run in maintenance mode.

 from  ManagesAttributes
bool $withoutOverlapping

Indicates if the command should not overlap itself.

 from  ManagesAttributes
bool $onOneServer

Indicates if the command should only be allowed to run on one server for each cron expression.

 from  ManagesAttributes
int $expiresAt

The number of minutes the mutex should be valid.

 from  ManagesAttributes
bool $runInBackground

Indicates if the command should run in the background.

 from  ManagesAttributes
protected array $filters

The array of filter callbacks.

 from  ManagesAttributes
protected array $rejects

The array of reject callbacks.

 from  ManagesAttributes
string|null $description

The human readable description of the event.

 from  ManagesAttributes

Methods

$this
user(string $user)

Set which user the command should run as.

from  ManagesAttributes
$this
environments(array|mixed $environments)

Limit the environments the command should run in.

from  ManagesAttributes
$this
evenInMaintenanceMode()

State that the command should run even in maintenance mode.

from  ManagesAttributes
$this
withoutOverlapping(int $expiresAt = 1440)

Do not allow the event to overlap each other.

$this
onOneServer()

Allow the event to only run on one server for each cron expression.

from  ManagesAttributes
$this
runInBackground()

State that the command should run in the background.

from  ManagesAttributes
$this
when(Closure|bool $callback)

Register a callback to further filter the schedule.

from  ManagesAttributes
$this
skip(Closure|bool $callback)

Register a callback to further filter the schedule.

from  ManagesAttributes
$this
name(string $description)

Set the human-friendly description of the event.

from  ManagesAttributes
$this
description(string $description)

Set the human-friendly description of the event.

from  ManagesAttributes
$this
cron(string $expression)

The Cron expression representing the event's frequency.

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

Schedule the event to run between start and end time.

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

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

from  ManagesFrequencies
$this
everySecond()

Schedule the event to run every second.

from  ManagesFrequencies
$this
everyTwoSeconds()

Schedule the event to run every two seconds.

from  ManagesFrequencies
$this
everyFiveSeconds()

Schedule the event to run every five seconds.

from  ManagesFrequencies
$this
everyTenSeconds()

Schedule the event to run every ten seconds.

from  ManagesFrequencies
$this
everyFifteenSeconds()

Schedule the event to run every fifteen seconds.

from  ManagesFrequencies
$this
everyTwentySeconds()

Schedule the event to run every twenty seconds.

from  ManagesFrequencies
$this
everyThirtySeconds()

Schedule the event to run every thirty seconds.

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

Schedule the event to run multiple times per minute.

from  ManagesFrequencies
$this
everyMinute()

Schedule the event to run every minute.

from  ManagesFrequencies
$this
everyTwoMinutes()

Schedule the event to run every two minutes.

from  ManagesFrequencies
$this
everyThreeMinutes()

Schedule the event to run every three minutes.

from  ManagesFrequencies
$this
everyFourMinutes()

Schedule the event to run every four minutes.

from  ManagesFrequencies
$this
everyFiveMinutes()

Schedule the event to run every five minutes.

from  ManagesFrequencies
$this
everyTenMinutes()

Schedule the event to run every ten minutes.

from  ManagesFrequencies
$this
everyFifteenMinutes()

Schedule the event to run every fifteen minutes.

from  ManagesFrequencies
$this
everyThirtyMinutes()

Schedule the event to run every thirty minutes.

from  ManagesFrequencies
$this
hourly()

Schedule the event to run hourly.

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

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

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

Schedule the event to run every odd hour.

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

Schedule the event to run every two hours.

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

Schedule the event to run every three hours.

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

Schedule the event to run every four hours.

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

Schedule the event to run every six hours.

from  ManagesFrequencies
$this
daily()

Schedule the event to run daily.

from  ManagesFrequencies
$this
at(string $time)

Schedule the command at a given time.

from  ManagesFrequencies
$this
dailyAt(string $time)

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

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

Schedule the event to run twice daily.

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

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

from  ManagesFrequencies
$this
weekdays()

Schedule the event to run only on weekdays.

from  ManagesFrequencies
$this
weekends()

Schedule the event to run only on weekends.

from  ManagesFrequencies
$this
mondays()

Schedule the event to run only on Mondays.

from  ManagesFrequencies
$this
tuesdays()

Schedule the event to run only on Tuesdays.

from  ManagesFrequencies
$this
wednesdays()

Schedule the event to run only on Wednesdays.

from  ManagesFrequencies
$this
thursdays()

Schedule the event to run only on Thursdays.

from  ManagesFrequencies
$this
fridays()

Schedule the event to run only on Fridays.

from  ManagesFrequencies
$this
saturdays()

Schedule the event to run only on Saturdays.

from  ManagesFrequencies
$this
sundays()

Schedule the event to run only on Sundays.

from  ManagesFrequencies
$this
weekly()

Schedule the event to run weekly.

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

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

from  ManagesFrequencies
$this
monthly()

Schedule the event to run monthly.

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

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

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

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

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

from  ManagesFrequencies
$this
quarterly()

Schedule the event to run quarterly.

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

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

from  ManagesFrequencies
$this
yearly()

Schedule the event to run yearly.

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

from  ManagesFrequencies
$this
days(array|mixed $days)

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

from  ManagesFrequencies
$this
timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

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

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

from  ManagesFrequencies
__construct(Schedule $schedule)

Create a new pending event attributes instance.

void
mergeAttributes(Event $event)

Merge the current attributes into the given event.

mixed
__call(string $method, array $parameters)

Proxy missing methods onto the underlying schedule.

Details

in ManagesAttributes at line 106
$this user(string $user)

Set which user the command should run as.

Parameters

string $user

Return Value

$this

in ManagesAttributes at line 119
$this environments(array|mixed $environments)

Limit the environments the command should run in.

Parameters

array|mixed $environments

Return Value

$this

in ManagesAttributes at line 131
$this evenInMaintenanceMode()

State that the command should run even in maintenance mode.

Return Value

$this

at line 28
$this withoutOverlapping(int $expiresAt = 1440)

Do not allow the event to overlap each other.

The expiration time of the underlying cache lock may be specified in minutes.

Parameters

int $expiresAt

Return Value

$this

in ManagesAttributes at line 161
$this onOneServer()

Allow the event to only run on one server for each cron expression.

Return Value

$this

in ManagesAttributes at line 173
$this runInBackground()

State that the command should run in the background.

Return Value

$this

in ManagesAttributes at line 186
$this when(Closure|bool $callback)

Register a callback to further filter the schedule.

Parameters

Closure|bool $callback

Return Value

$this

in ManagesAttributes at line 201
$this skip(Closure|bool $callback)

Register a callback to further filter the schedule.

Parameters

Closure|bool $callback

Return Value

$this

in ManagesAttributes at line 216
$this name(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

in ManagesAttributes at line 227
$this description(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

in ManagesFrequencies at line 16
$this cron(string $expression)

The Cron expression representing the event's frequency.

Parameters

string $expression

Return Value

$this

in ManagesFrequencies at line 30
$this between(string $startTime, string $endTime)

Schedule the event to run between start and end time.

Parameters

string $startTime
string $endTime

Return Value

$this

in ManagesFrequencies at line 42
$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

in ManagesFrequencies at line 78
$this everySecond()

Schedule the event to run every second.

Return Value

$this

in ManagesFrequencies at line 88
$this everyTwoSeconds()

Schedule the event to run every two seconds.

Return Value

$this

in ManagesFrequencies at line 98
$this everyFiveSeconds()

Schedule the event to run every five seconds.

Return Value

$this

in ManagesFrequencies at line 108
$this everyTenSeconds()

Schedule the event to run every ten seconds.

Return Value

$this

in ManagesFrequencies at line 118
$this everyFifteenSeconds()

Schedule the event to run every fifteen seconds.

Return Value

$this

in ManagesFrequencies at line 128
$this everyTwentySeconds()

Schedule the event to run every twenty seconds.

Return Value

$this

in ManagesFrequencies at line 138
$this everyThirtySeconds()

Schedule the event to run every thirty seconds.

Return Value

$this

in ManagesFrequencies at line 149
protected $this repeatEvery(int<0, 59> $seconds)

Schedule the event to run multiple times per minute.

Parameters

int<0, 59> $seconds

Return Value

$this

in ManagesFrequencies at line 165
$this everyMinute()

Schedule the event to run every minute.

Return Value

$this

in ManagesFrequencies at line 175
$this everyTwoMinutes()

Schedule the event to run every two minutes.

Return Value

$this

in ManagesFrequencies at line 185
$this everyThreeMinutes()

Schedule the event to run every three minutes.

Return Value

$this

in ManagesFrequencies at line 195
$this everyFourMinutes()

Schedule the event to run every four minutes.

Return Value

$this

in ManagesFrequencies at line 205
$this everyFiveMinutes()

Schedule the event to run every five minutes.

Return Value

$this

in ManagesFrequencies at line 215
$this everyTenMinutes()

Schedule the event to run every ten minutes.

Return Value

$this

in ManagesFrequencies at line 225
$this everyFifteenMinutes()

Schedule the event to run every fifteen minutes.

Return Value

$this

in ManagesFrequencies at line 235
$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

Return Value

$this

in ManagesFrequencies at line 245
$this hourly()

Schedule the event to run hourly.

Return Value

$this

in ManagesFrequencies at line 256
$this hourlyAt(array|string|int<0, 59>|int<0, 59>[] $offset)

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

Parameters

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

Return Value

$this

in ManagesFrequencies at line 267
$this everyOddHour(array|string|int $offset = 0)

Schedule the event to run every odd hour.

Parameters

array|string|int $offset

Return Value

$this

in ManagesFrequencies at line 278
$this everyTwoHours(array|string|int $offset = 0)

Schedule the event to run every two hours.

Parameters

array|string|int $offset

Return Value

$this

in ManagesFrequencies at line 289
$this everyThreeHours(array|string|int $offset = 0)

Schedule the event to run every three hours.

Parameters

array|string|int $offset

Return Value

$this

in ManagesFrequencies at line 300
$this everyFourHours(array|string|int $offset = 0)

Schedule the event to run every four hours.

Parameters

array|string|int $offset

Return Value

$this

in ManagesFrequencies at line 311
$this everySixHours(array|string|int $offset = 0)

Schedule the event to run every six hours.

Parameters

array|string|int $offset

Return Value

$this

in ManagesFrequencies at line 321
$this daily()

Schedule the event to run daily.

Return Value

$this

in ManagesFrequencies at line 332
$this at(string $time)

Schedule the command at a given time.

Parameters

string $time

Return Value

$this

in ManagesFrequencies at line 343
$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

in ManagesFrequencies at line 360
$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

in ManagesFrequencies at line 373
$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

in ManagesFrequencies at line 387
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

in ManagesFrequencies at line 402
$this weekdays()

Schedule the event to run only on weekdays.

Return Value

$this

in ManagesFrequencies at line 412
$this weekends()

Schedule the event to run only on weekends.

Return Value

$this

in ManagesFrequencies at line 422
$this mondays()

Schedule the event to run only on Mondays.

Return Value

$this

in ManagesFrequencies at line 432
$this tuesdays()

Schedule the event to run only on Tuesdays.

Return Value

$this

in ManagesFrequencies at line 442
$this wednesdays()

Schedule the event to run only on Wednesdays.

Return Value

$this

in ManagesFrequencies at line 452
$this thursdays()

Schedule the event to run only on Thursdays.

Return Value

$this

in ManagesFrequencies at line 462
$this fridays()

Schedule the event to run only on Fridays.

Return Value

$this

in ManagesFrequencies at line 472
$this saturdays()

Schedule the event to run only on Saturdays.

Return Value

$this

in ManagesFrequencies at line 482
$this sundays()

Schedule the event to run only on Sundays.

Return Value

$this

in ManagesFrequencies at line 492
$this weekly()

Schedule the event to run weekly.

Return Value

$this

in ManagesFrequencies at line 506
$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

in ManagesFrequencies at line 518
$this monthly()

Schedule the event to run monthly.

Return Value

$this

in ManagesFrequencies at line 532
$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

in ManagesFrequencies at line 547
$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

in ManagesFrequencies at line 562
$this lastDayOfMonth(string $time = '0:0')

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

Parameters

string $time

Return Value

$this

in ManagesFrequencies at line 574
$this quarterly()

Schedule the event to run quarterly.

Return Value

$this

in ManagesFrequencies at line 589
$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

in ManagesFrequencies at line 602
$this yearly()

Schedule the event to run yearly.

Return Value

$this

in ManagesFrequencies at line 618
$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

in ManagesFrequencies at line 632
$this days(array|mixed $days)

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

Parameters

array|mixed $days

Return Value

$this

in ManagesFrequencies at line 645
$this timezone(DateTimeZone|string $timezone)

Set the timezone the date should be evaluated on.

Parameters

DateTimeZone|string $timezone

Return Value

$this

in ManagesFrequencies at line 659
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

at line 15
__construct(Schedule $schedule)

Create a new pending event attributes instance.

Parameters

Schedule $schedule

at line 40
void mergeAttributes(Event $event)

Merge the current attributes into the given event.

Parameters

Event $event

Return Value

void

at line 89
mixed __call(string $method, array $parameters)

Proxy missing methods onto the underlying schedule.

Parameters

string $method
array $parameters

Return Value

mixed