Event (Console\Scheduling)
Event
class Event (View source)
Traits
Macroable |
ManagesFrequencies |
Properties
string | $command | The command string. | |
string | $expression | The cron expression representing the event's frequency. | |
DateTimeZone|string | $timezone | The timezone the date should be evaluated on. | |
string | $user | The user the command should run as. | |
array | $environments | The list of environments the command should run under. | |
bool | $evenInMaintenanceMode | Indicates if the command should run in maintenance mode. | |
bool | $withoutOverlapping | Indicates if the command should not overlap itself. | |
bool | $runInBackground | Indicates if the command should run in background. | |
string | $output | The location that output should be sent to. | |
bool | $shouldAppendOutput | Indicates whether output should be appended. | |
string | $description | The human readable description of the event. | |
Mutex | $mutex | The mutex implementation. |
Methods
static void | macro(string $name, callable $macro) Register a custom macro. | 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 | hourly() Schedule the event to run hourly. | from ManagesFrequencies |
$this | hourlyAt(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 | quarterly() Schedule the event to run quarterly. | from ManagesFrequencies |
$this | yearly() Schedule the event to run yearly. | 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 | everyThirtyMinutes() Schedule the event to run every thirty minutes. | 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 |
void | __construct(Mutex $mutex, string $command) Create a new event instance. | |
string | getDefaultOutput() Get the default output depending on the OS. | |
void | run(Container $container) Run the given event. | |
string | mutexName() Get the mutex name for the scheduled command. | |
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 | 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 | 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 = false) 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 | pingBefore(string $url) Register a callback to ping a given URL before the job runs. | |
$this | thenPing(string $url) Register a callback to ping a given URL after the job runs. | |
$this | runInBackground() State that the command should run in background. | |
$this | user(string $user) Set which user the command should run as. | |
$this | environments(array|mixed $environments) Limit the environments the command should run in. | |
$this | evenInMaintenanceMode() State that the command should run even in maintenance mode. | |
$this | withoutOverlapping() Do not allow the event to overlap each other. | |
$this | when(Closure $callback) Register a callback to further filter the schedule. | |
$this | skip(Closure $callback) Register a callback to further filter the schedule. | |
$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 | name(string $description) Set the human-friendly description of the event. | |
$this | description(string $description) Set the human-friendly description of the event. | |
string | getSummaryForDisplay() Get the summary of the event for display. | |
Carbon | nextRunDate(DateTime|string $currentTime = 'now', int $nth, bool $allowCurrentDate = false) Determine the next due date for an event. | |
string | getExpression() Get the Cron expression for the event. | |
$this | preventOverlapsUsing(Mutex $mutex) Set the mutex implementation to be used. |
Details
static void macro(string $name, callable $macro)
Register a custom macro.
static bool hasMacro(string $name)
Checks if macro is registered.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
$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 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.
void __construct(Mutex $mutex, string $command)
Create a new event instance.
string getDefaultOutput()
Get the default output depending on the OS.
void run(Container $container)
Run the given event.
string mutexName()
Get the mutex name for the scheduled command.
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 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 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 = false)
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 pingBefore(string $url)
Register a callback to ping a given URL before the job runs.
$this thenPing(string $url)
Register a callback to ping a given URL after the job runs.
$this runInBackground()
State that the command should run in background.
$this user(string $user)
Set which user the command should run as.
$this environments(array|mixed $environments)
Limit the environments the command should run in.
$this evenInMaintenanceMode()
State that the command should run even in maintenance mode.
$this withoutOverlapping()
Do not allow the event to overlap each other.
$this when(Closure $callback)
Register a callback to further filter the schedule.
$this skip(Closure $callback)
Register a callback to further filter the schedule.
$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 name(string $description)
Set the human-friendly description of the event.
$this description(string $description)
Set the human-friendly description of the event.
string getSummaryForDisplay()
Get the summary of the event for display.
Carbon nextRunDate(DateTime|string $currentTime = 'now', int $nth, bool $allowCurrentDate = false)
Determine the next due date for an event.
string getExpression()
Get the Cron expression for the event.
$this preventOverlapsUsing(Mutex $mutex)
Set the mutex implementation to be used.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Console/Scheduling/Event.html