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

Event

class Event (View source)

Traits

Macroable
ManagesAttributes
ManagesFrequencies
ReflectsClosures
Tappable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
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
string|null $command

The command string.
string $output

The location that output should be sent to.
bool $shouldAppendOutput

Indicates whether output should be appended.
protected array $beforeCallbacks

The array of callbacks to be run before the event is started.
protected array $afterCallbacks

The array of callbacks to be run after the event is finished.
EventMutex $mutex

The event mutex implementation.
Closure|null $mutexNameResolver

The mutex name resolver callback.
protected Carbon|null $lastChecked

The last time the event was checked for eligibility to run.
int|null $exitCode

The exit status code of the command.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

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

from  ManagesAttributes
$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
string
firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

from  ReflectsClosures
array
firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

from  ReflectsClosures
array
closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

from  ReflectsClosures
tap($callback = null)

Call the given Closure with this instance then return the instance.

from  Tappable
__construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null)

Create a new event instance.

string
getDefaultOutput()

Get the default output depending on the OS.

void
run(Container $container)

Run the given event.

bool
shouldSkipDueToOverlapping()

Determine if the event should skip because another process is overlapping.

bool
isRepeatable()

Determine if the event has been configured to repeat multiple times per minute.

bool
shouldRepeatNow()

Determine if the event is ready to repeat.

int
start(Container $container)

Run the command process.

int
execute(Container $container)

Run the command process.

void
finish(Container $container, int $exitCode)

Mark the command process as finished and run callbacks/cleanup.

void
callBeforeCallbacks(Container $container)

Call all of the "before" callbacks for the event.

void
callAfterCallbacks(Container $container)

Call all of the "after" callbacks for the event.

string
buildCommand()

Build the command string.

bool
isDue(Application $app)

Determine if the given event should run based on the Cron expression.

bool
runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

bool
expressionPasses()

Determine if the Cron expression passes.

bool
runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

bool
filtersPass(Application $app)

Determine if the filters pass for the event.

$this
storeOutput()

Ensure that the output is stored on disk in a log file.

$this
sendOutputTo(string $location, bool $append = false)

Send the output of the command to a given location.

$this
appendOutputTo(string $location)

Append the output of the command to a given location.

$this
emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = true)

E-mail the results of the scheduled operation.

$this
emailWrittenOutputTo(array|mixed $addresses)

E-mail the results of the scheduled operation if it produces output.

$this
emailOutputOnFailure(array|mixed $addresses)

E-mail the results of the scheduled operation if it fails.

void
ensureOutputIsBeingCaptured()

Ensure that the command output is being captured.

void
emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = true)

E-mail the output of the event to the recipients.

string
getEmailSubject()

Get the e-mail subject line for output results.

$this
pingBefore(string $url)

Register a callback to ping a given URL before the job runs.

$this
pingBeforeIf(bool $value, string $url)

Register a callback to ping a given URL before the job runs if the given condition is true.

$this
thenPing(string $url)

Register a callback to ping a given URL after the job runs.

$this
thenPingIf(bool $value, string $url)

Register a callback to ping a given URL after the job runs if the given condition is true.

$this
pingOnSuccess(string $url)

Register a callback to ping a given URL if the operation succeeds.

$this
pingOnSuccessIf(bool $value, string $url)

Register a callback to ping a given URL if the operation succeeds and if the given condition is true.

$this
pingOnFailure(string $url)

Register a callback to ping a given URL if the operation fails.

$this
pingOnFailureIf(bool $value, string $url)

Register a callback to ping a given URL if the operation fails and if the given condition is true.

Closure
pingCallback(string $url)

Get the callback that pings the given URL.

ClientInterface
getHttpClient(Container $container)

Get the Guzzle HTTP client to use to send pings.

$this
before(Closure $callback)

Register a callback to be called before the operation.

$this
after(Closure $callback)

Register a callback to be called after the operation.

$this
then(Closure $callback)

Register a callback to be called after the operation.

$this
thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output after the job runs.

$this
onSuccess(Closure $callback)

Register a callback to be called if the operation succeeds.

$this
onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output if the operation succeeds.

$this
onFailure(Closure $callback)

Register a callback to be called if the operation fails.

$this
onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output if the operation fails.

Closure
withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)

Get a callback that provides output.

string
getSummaryForDisplay()

Get the summary of the event for display.

Carbon
nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)

Determine the next due date for an event.

string
getExpression()

Get the Cron expression for the event.

$this
preventOverlapsUsing(EventMutex $mutex)

Set the event mutex implementation to be used.

string
mutexName()

Get the mutex name for the scheduled command.

$this
createMutexNameUsing(Closure|string $mutexName)

Set the mutex name or name resolver callback.

void
removeMutex()

Delete the mutex for the event.

static string
normalizeCommand(string $command)

Format the given command string with a normalized PHP binary path.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

in ManagesAttributes at line 145
$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

in ReflectsClosures at line 22
protected string firstClosureParameterType(Closure $closure)

Get the class name of the first parameter of the given Closure.

Parameters

Closure $closure

Return Value

string

Exceptions

ReflectionException
RuntimeException

in ReflectsClosures at line 46
protected array firstClosureParameterTypes(Closure $closure)

Get the class names of the first parameter of the given Closure, including union types.

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException
RuntimeException

in ReflectsClosures at line 81
protected array closureParameterTypes(Closure $closure)

Get the class names / types of the parameters of the given Closure.

Parameters

Closure $closure

Return Value

array

Exceptions

ReflectionException

in Tappable at line 13
tap($callback = null)

Call the given Closure with this instance then return the instance.

Parameters

$callback

at line 100
__construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null)

Create a new event instance.

Parameters

EventMutex $mutex
string $command
DateTimeZone|string|null $timezone

at line 114
string getDefaultOutput()

Get the default output depending on the OS.

Return Value

string

at line 127
void run(Container $container)

Run the given event.

Parameters

Container $container

Return Value

void

Exceptions

Throwable

at line 145
bool shouldSkipDueToOverlapping()

Determine if the event should skip because another process is overlapping.

Return Value

bool

at line 155
bool isRepeatable()

Determine if the event has been configured to repeat multiple times per minute.

Return Value

bool

at line 165
bool shouldRepeatNow()

Determine if the event is ready to repeat.

Return Value

bool

at line 179
protected int start(Container $container)

Run the command process.

Parameters

Container $container

Return Value

int

Exceptions

Throwable

at line 198
protected int execute(Container $container)

Run the command process.

Parameters

Container $container

Return Value

int

at line 216
void finish(Container $container, int $exitCode)

Mark the command process as finished and run callbacks/cleanup.

Parameters

Container $container
int $exitCode

Return Value

void

at line 233
void callBeforeCallbacks(Container $container)

Call all of the "before" callbacks for the event.

Parameters

Container $container

Return Value

void

at line 246
void callAfterCallbacks(Container $container)

Call all of the "after" callbacks for the event.

Parameters

Container $container

Return Value

void

at line 258
string buildCommand()

Build the command string.

Return Value

string

at line 269
bool isDue(Application $app)

Determine if the given event should run based on the Cron expression.

Parameters

Application $app

Return Value

bool

at line 284
bool runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

Return Value

bool

at line 294
protected bool expressionPasses()

Determine if the Cron expression passes.

Return Value

bool

at line 311
bool runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

Parameters

string $environment

Return Value

bool

at line 322
bool filtersPass(Application $app)

Determine if the filters pass for the event.

Parameters

Application $app

Return Value

bool

at line 346
$this storeOutput()

Ensure that the output is stored on disk in a log file.

Return Value

$this

at line 360
$this sendOutputTo(string $location, bool $append = false)

Send the output of the command to a given location.

Parameters

string $location
bool $append

Return Value

$this

at line 375
$this appendOutputTo(string $location)

Append the output of the command to a given location.

Parameters

string $location

Return Value

$this

at line 389
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = true)

E-mail the results of the scheduled operation.

Parameters

array|mixed $addresses
bool $onlyIfOutputExists

Return Value

$this

Exceptions

LogicException

at line 408
$this emailWrittenOutputTo(array|mixed $addresses)

E-mail the results of the scheduled operation if it produces output.

Parameters

array|mixed $addresses

Return Value

$this

Exceptions

LogicException

at line 419
$this emailOutputOnFailure(array|mixed $addresses)

E-mail the results of the scheduled operation if it fails.

Parameters

array|mixed $addresses

Return Value

$this

at line 435
protected void ensureOutputIsBeingCaptured()

Ensure that the command output is being captured.

Return Value

void

at line 450
protected void emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = true)

E-mail the output of the event to the recipients.

Parameters

Mailer $mailer
array $addresses
bool $onlyIfOutputExists

Return Value

void

at line 468
protected string getEmailSubject()

Get the e-mail subject line for output results.

Return Value

string

at line 483
$this pingBefore(string $url)

Register a callback to ping a given URL before the job runs.

Parameters

string $url

Return Value

$this

at line 495
$this pingBeforeIf(bool $value, string $url)

Register a callback to ping a given URL before the job runs if the given condition is true.

Parameters

bool $value
string $url

Return Value

$this

at line 506
$this thenPing(string $url)

Register a callback to ping a given URL after the job runs.

Parameters

string $url

Return Value

$this

at line 518
$this thenPingIf(bool $value, string $url)

Register a callback to ping a given URL after the job runs if the given condition is true.

Parameters

bool $value
string $url

Return Value

$this

at line 529
$this pingOnSuccess(string $url)

Register a callback to ping a given URL if the operation succeeds.

Parameters

string $url

Return Value

$this

at line 541
$this pingOnSuccessIf(bool $value, string $url)

Register a callback to ping a given URL if the operation succeeds and if the given condition is true.

Parameters

bool $value
string $url

Return Value

$this

at line 552
$this pingOnFailure(string $url)

Register a callback to ping a given URL if the operation fails.

Parameters

string $url

Return Value

$this

at line 564
$this pingOnFailureIf(bool $value, string $url)

Register a callback to ping a given URL if the operation fails and if the given condition is true.

Parameters

bool $value
string $url

Return Value

$this

at line 575
protected Closure pingCallback(string $url)

Get the callback that pings the given URL.

Parameters

string $url

Return Value

Closure

at line 592
protected ClientInterface getHttpClient(Container $container)

Get the Guzzle HTTP client to use to send pings.

Parameters

Container $container

Return Value

ClientInterface

at line 611
$this before(Closure $callback)

Register a callback to be called before the operation.

Parameters

Closure $callback

Return Value

$this

at line 624
$this after(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

at line 635
$this then(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

at line 655
$this thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output after the job runs.

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

$this

at line 668
$this onSuccess(Closure $callback)

Register a callback to be called if the operation succeeds.

Parameters

Closure $callback

Return Value

$this

at line 690
$this onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output if the operation succeeds.

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

$this

at line 703
$this onFailure(Closure $callback)

Register a callback to be called if the operation fails.

Parameters

Closure $callback

Return Value

$this

at line 725
$this onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Register a callback that uses the output if the operation fails.

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

$this

at line 739
protected Closure withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)

Get a callback that provides output.

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

Closure

at line 755
string getSummaryForDisplay()

Get the summary of the event for display.

Return Value

string

at line 772
Carbon nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)

Determine the next due date for an event.

Parameters

DateTimeInterface|string $currentTime
int $nth
bool $allowCurrentDate

Return Value

Carbon

at line 783
string getExpression()

Get the Cron expression for the event.

Return Value

string

at line 794
$this preventOverlapsUsing(EventMutex $mutex)

Set the event mutex implementation to be used.

Parameters

EventMutex $mutex

Return Value

$this

at line 806
string mutexName()

Get the mutex name for the scheduled command.

Return Value

string

at line 824
$this createMutexNameUsing(Closure|string $mutexName)

Set the mutex name or name resolver callback.

Parameters

Closure|string $mutexName

Return Value

$this

at line 836
protected void removeMutex()

Delete the mutex for the event.

Return Value

void

at line 849
static string normalizeCommand(string $command)

Format the given command string with a normalized PHP binary path.

Parameters

string $command

Return Value

string