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

CallbackEvent

class CallbackEvent extends Event (View source)

Traits

Macroable
ManagesFrequencies

Properties

static protected array $macros

The registered string macros.

 from  Macroable
string $command

The command string.

 from  Event
string $expression

The cron expression representing the event's frequency.

 from  Event
DateTimeZone|string $timezone

The timezone the date should be evaluated on.

 from  Event
string $user

The user the command should run as.

 from  Event
array $environments

The list of environments the command should run under.

 from  Event
bool $evenInMaintenanceMode

Indicates if the command should run in maintenance mode.

 from  Event
bool $withoutOverlapping

Indicates if the command should not overlap itself.

 from  Event
bool $onOneServer

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

 from  Event
int $expiresAt

The amount of time the mutex should be valid.

 from  Event
bool $runInBackground

Indicates if the command should run in background.

 from  Event
protected array $filters

The array of filter callbacks.

 from  Event
protected array $rejects

The array of reject callbacks.

 from  Event
string $output

The location that output should be sent to.

 from  Event
bool $shouldAppendOutput

Indicates whether output should be appended.

 from  Event
protected array $beforeCallbacks

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

 from  Event
protected array $afterCallbacks

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

 from  Event
string $description

The human readable description of the event.

 from  Event
EventMutex $mutex

The event mutex implementation.

 from  Event
int|null $exitCode

The exit status code of the command.

 from  Event
protected string $callback

The callback to call.
protected array $parameters

The parameters to pass to the method.

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

Schedule the event to run every minute.

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|int $offset)

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

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

Schedule the event to run twice daily.

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

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

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

Schedule the event to run twice monthly.

from  ManagesFrequencies
$this
quarterly()

Schedule the event to run quarterly.

from  ManagesFrequencies
$this
yearly()

Schedule the event to run yearly.

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
void
__construct(EventMutex $mutex, string $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

Create a new event instance.

string
getDefaultOutput()

Get the default output depending on the OS.

from  Event
void
run(Container $container)

Run the given event.

string
mutexName()

Get the mutex name for the scheduled command.

void
runCommandInForeground(Container $container)

Run the command in the foreground.

from  Event
void
runCommandInBackground(Container $container)

Run the command in the background.

from  Event
void
callBeforeCallbacks(Container $container)

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

from  Event
void
callAfterCallbacks(Container $container)

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

from  Event
void
callAfterCallbacksWithExitCode(Container $container, int $exitCode)

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

from  Event
string
buildCommand()

Build the command string.

from  Event
bool
isDue(Application $app)

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

from  Event
bool
runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

from  Event
bool
expressionPasses()

Determine if the Cron expression passes.

from  Event
bool
runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

from  Event
bool
filtersPass(Application $app)

Determine if the filters pass for the event.

from  Event
$this
storeOutput()

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

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

Send the output of the command to a given location.

from  Event
$this
appendOutputTo(string $location)

Append the output of the command to a given location.

from  Event
$this
emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)

E-mail the results of the scheduled operation.

from  Event
$this
emailWrittenOutputTo(array|mixed $addresses)

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

from  Event
$this
emailOutputOnFailure(array|mixed $addresses)

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

from  Event
void
ensureOutputIsBeingCaptured()

Ensure that the command output is being captured.

from  Event
void
emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false)

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

from  Event
string
getEmailSubject()

Get the e-mail subject line for output results.

from  Event
$this
pingBefore(string $url)

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

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

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

from  Event
$this
thenPing(string $url)

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

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

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

from  Event
$this
pingOnSuccess(string $url)

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

from  Event
$this
pingOnFailure(string $url)

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

from  Event
Closure
pingCallback(string $url)

Get the callback that pings the given URL.

from  Event
$this
runInBackground()

State that the command should run in background.

from  Event
$this
user(string $user)

Set which user the command should run as.

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

Limit the environments the command should run in.

from  Event
$this
evenInMaintenanceMode()

State that the command should run even in maintenance mode.

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

$this
when(Closure|bool $callback)

Register a callback to further filter the schedule.

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

Register a callback to further filter the schedule.

from  Event
$this
before(Closure $callback)

Register a callback to be called before the operation.

from  Event
$this
after(Closure $callback)

Register a callback to be called after the operation.

from  Event
$this
then(Closure $callback)

Register a callback to be called after the operation.

from  Event
$this
onSuccess(Closure $callback)

Register a callback to be called if the operation succeeds.

from  Event
$this
onFailure(Closure $callback)

Register a callback to be called if the operation fails.

from  Event
$this
name(string $description)

Set the human-friendly description of the event.

from  Event
$this
description(string $description)

Set the human-friendly description of the event.

from  Event
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.

from  Event
string
getExpression()

Get the Cron expression for the event.

from  Event
$this
preventOverlapsUsing(EventMutex $mutex)

Set the event mutex implementation to be used.

from  Event
void
removeMutex()

Clear the mutex for the event.

Details

in Macroable at line 26
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 40
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 60
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 74
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 100
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

The Cron expression representing the event's frequency.

Parameters

string $expression

Return Value

$this

in ManagesFrequencies 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

in ManagesFrequencies 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

in ManagesFrequencies at line 79
$this everyMinute()

Schedule the event to run every minute.

Return Value

$this

in ManagesFrequencies at line 89
$this everyFiveMinutes()

Schedule the event to run every five minutes.

Return Value

$this

in ManagesFrequencies at line 99
$this everyTenMinutes()

Schedule the event to run every ten minutes.

Return Value

$this

in ManagesFrequencies at line 109
$this everyFifteenMinutes()

Schedule the event to run every fifteen minutes.

Return Value

$this

in ManagesFrequencies at line 119
$this everyThirtyMinutes()

Schedule the event to run every thirty minutes.

Return Value

$this

in ManagesFrequencies at line 129
$this hourly()

Schedule the event to run hourly.

Return Value

$this

in ManagesFrequencies at line 140
$this hourlyAt(array|int $offset)

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

Parameters

array|int $offset

Return Value

$this

in ManagesFrequencies at line 152
$this daily()

Schedule the event to run daily.

Return Value

$this

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

Schedule the command at a given time.

Parameters

string $time

Return Value

$this

in ManagesFrequencies at line 175
$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 190
$this twiceDaily(int $first = 1, int $second = 13)

Schedule the event to run twice daily.

Parameters

int $first
int $second

Return Value

$this

in ManagesFrequencies at line 203
$this weekdays()

Schedule the event to run only on weekdays.

Return Value

$this

in ManagesFrequencies at line 213
$this weekends()

Schedule the event to run only on weekends.

Return Value

$this

in ManagesFrequencies at line 223
$this mondays()

Schedule the event to run only on Mondays.

Return Value

$this

in ManagesFrequencies at line 233
$this tuesdays()

Schedule the event to run only on Tuesdays.

Return Value

$this

in ManagesFrequencies at line 243
$this wednesdays()

Schedule the event to run only on Wednesdays.

Return Value

$this

in ManagesFrequencies at line 253
$this thursdays()

Schedule the event to run only on Thursdays.

Return Value

$this

in ManagesFrequencies at line 263
$this fridays()

Schedule the event to run only on Fridays.

Return Value

$this

in ManagesFrequencies at line 273
$this saturdays()

Schedule the event to run only on Saturdays.

Return Value

$this

in ManagesFrequencies at line 283
$this sundays()

Schedule the event to run only on Sundays.

Return Value

$this

in ManagesFrequencies at line 293
$this weekly()

Schedule the event to run weekly.

Return Value

$this

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

in ManagesFrequencies at line 319
$this monthly()

Schedule the event to run monthly.

Return Value

$this

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

in ManagesFrequencies at line 347
$this twiceMonthly(int $first = 1, int $second = 16)

Schedule the event to run twice monthly.

Parameters

int $first
int $second

Return Value

$this

in ManagesFrequencies at line 361
$this quarterly()

Schedule the event to run quarterly.

Return Value

$this

in ManagesFrequencies at line 374
$this yearly()

Schedule the event to run yearly.

Return Value

$this

in ManagesFrequencies at line 388
$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 401
$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 415
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 37
void __construct(EventMutex $mutex, string $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

Create a new event instance.

Parameters

EventMutex $mutex
string $callback
array $parameters
DateTimeZone|string|null $timezone

Return Value

void

Exceptions

InvalidArgumentException

in Event at line 178
string getDefaultOutput()

Get the default output depending on the OS.

Return Value

string

at line 59
void run(Container $container)

Run the given event.

Parameters

Container $container

Return Value

void

Exceptions

Exception

at line 151
string mutexName()

Get the mutex name for the scheduled command.

Return Value

string

in Event at line 217
protected void runCommandInForeground(Container $container)

Run the command in the foreground.

Parameters

Container $container

Return Value

void

in Event at line 232
protected void runCommandInBackground(Container $container)

Run the command in the background.

Parameters

Container $container

Return Value

void

in Event at line 245
void callBeforeCallbacks(Container $container)

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

Parameters

Container $container

Return Value

void

in Event at line 258
void callAfterCallbacks(Container $container)

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

Parameters

Container $container

Return Value

void

in Event at line 272
void callAfterCallbacksWithExitCode(Container $container, int $exitCode)

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

Parameters

Container $container
int $exitCode

Return Value

void

in Event at line 284
string buildCommand()

Build the command string.

Return Value

string

in Event at line 295
bool isDue(Application $app)

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

Parameters

Application $app

Return Value

bool

in Event at line 310
bool runsInMaintenanceMode()

Determine if the event runs in maintenance mode.

Return Value

bool

in Event at line 320
protected bool expressionPasses()

Determine if the Cron expression passes.

Return Value

bool

in Event at line 337
bool runsInEnvironment(string $environment)

Determine if the event runs in the given environment.

Parameters

string $environment

Return Value

bool

in Event at line 348
bool filtersPass(Application $app)

Determine if the filters pass for the event.

Parameters

Application $app

Return Value

bool

in Event at line 370
$this storeOutput()

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

Return Value

$this

in Event at line 384
$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

in Event at line 399
$this appendOutputTo(string $location)

Append the output of the command to a given location.

Parameters

string $location

Return Value

$this

in Event at line 413
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)

E-mail the results of the scheduled operation.

Parameters

array|mixed $addresses
bool $onlyIfOutputExists

Return Value

$this

Exceptions

LogicException

in Event at line 432
$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

in Event at line 443
$this emailOutputOnFailure(array|mixed $addresses)

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

Parameters

array|mixed $addresses

Return Value

$this

in Event at line 459
protected void ensureOutputIsBeingCaptured()

Ensure that the command output is being captured.

Return Value

void

in Event at line 474
protected void emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false)

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

Parameters

Mailer $mailer
array $addresses
bool $onlyIfOutputExists

Return Value

void

in Event at line 492
protected string getEmailSubject()

Get the e-mail subject line for output results.

Return Value

string

in Event at line 507
$this pingBefore(string $url)

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

Parameters

string $url

Return Value

$this

in Event at line 519
$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

in Event at line 530
$this thenPing(string $url)

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

Parameters

string $url

Return Value

$this

in Event at line 542
$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

in Event at line 553
$this pingOnSuccess(string $url)

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

Parameters

string $url

Return Value

$this

in Event at line 564
$this pingOnFailure(string $url)

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

Parameters

string $url

Return Value

$this

in Event at line 575
protected Closure pingCallback(string $url)

Get the callback that pings the given URL.

Parameters

string $url

Return Value

Closure

in Event at line 591
$this runInBackground()

State that the command should run in background.

Return Value

$this

in Event at line 604
$this user(string $user)

Set which user the command should run as.

Parameters

string $user

Return Value

$this

in Event at line 617
$this environments(array|mixed $environments)

Limit the environments the command should run in.

Parameters

array|mixed $environments

Return Value

$this

in Event at line 629
$this evenInMaintenanceMode()

State that the command should run even in maintenance mode.

Return Value

$this

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

Do not allow the event to overlap each other.

Parameters

int $expiresAt

Return Value

$this

Exceptions

LogicException

at line 133
$this onOneServer()

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

Return Value

$this

Exceptions

LogicException

in Event at line 673
$this when(Closure|bool $callback)

Register a callback to further filter the schedule.

Parameters

Closure|bool $callback

Return Value

$this

in Event at line 688
$this skip(Closure|bool $callback)

Register a callback to further filter the schedule.

Parameters

Closure|bool $callback

Return Value

$this

in Event at line 703
$this before(Closure $callback)

Register a callback to be called before the operation.

Parameters

Closure $callback

Return Value

$this

in Event at line 716
$this after(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

in Event at line 727
$this then(Closure $callback)

Register a callback to be called after the operation.

Parameters

Closure $callback

Return Value

$this

in Event at line 740
$this onSuccess(Closure $callback)

Register a callback to be called if the operation succeeds.

Parameters

Closure $callback

Return Value

$this

in Event at line 755
$this onFailure(Closure $callback)

Register a callback to be called if the operation fails.

Parameters

Closure $callback

Return Value

$this

in Event at line 770
$this name(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

in Event at line 781
$this description(string $description)

Set the human-friendly description of the event.

Parameters

string $description

Return Value

$this

at line 161
string getSummaryForDisplay()

Get the summary of the event for display.

Return Value

string

in Event at line 810
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

in Event at line 822
string getExpression()

Get the Cron expression for the event.

Return Value

string

in Event at line 833
$this preventOverlapsUsing(EventMutex $mutex)

Set the event mutex implementation to be used.

Parameters

EventMutex $mutex

Return Value

$this

at line 94
protected void removeMutex()

Clear the mutex for the event.

Return Value

void