class Event (View source)
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. | |
string | $description | The human readable description of the event. |
void | __construct(string $command) Create a new event instance. | |
void | run(Container $container) Run the given event. | |
string | buildCommand() Build the command string. | |
bool | isDue(Application $app) Determine if the given event should run based on the Cron expression. | |
bool | filtersPass(Application $app) Determine if the filters pass for the event. | |
bool | runsInEnvironment(string $environment) Determine if the event runs in the given environment. | |
bool | runsInMaintenanceMode() Determine if the event runs in maintenance mode. | |
$this | cron(string $expression) The Cron expression representing the event's frequency. | |
$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 | 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 | 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 | runInBackground() State that the command should run in background. | |
$this | timezone(DateTimeZone|string $timezone) Set the timezone the date should be evaluated on. | |
$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 | 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 | before(Closure $callback) Register a callback to be called before the operation. | |
$this | thenPing(string $url) Register a callback to ping a given URL after the job runs. | |
$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. | |
string | getExpression() Get the Cron expression for the event. |
Create a new event instance.
Run the given event.
Build the command string.
Determine if the given event should run based on the Cron expression.
Determine if the filters pass for the event.
Determine if the event runs in the given environment.
Determine if the event runs in maintenance mode.
The Cron expression representing the event's frequency.
Schedule the event to run hourly.
Schedule the event to run hourly at a given offset in the hour.
Schedule the event to run daily.
Schedule the command at a given time.
Schedule the event to run daily at a given time (10:00, 19:30, etc).
Schedule the event to run twice daily.
Schedule the event to run only on weekdays.
Schedule the event to run only on Mondays.
Schedule the event to run only on Tuesdays.
Schedule the event to run only on Wednesdays.
Schedule the event to run only on Thursdays.
Schedule the event to run only on Fridays.
Schedule the event to run only on Saturdays.
Schedule the event to run only on Sundays.
Schedule the event to run weekly.
Schedule the event to run weekly on a given day and time.
Schedule the event to run monthly.
Schedule the event to run monthly on a given day and time.
Schedule the event to run quarterly.
Schedule the event to run yearly.
Schedule the event to run every minute.
Schedule the event to run every five minutes.
Schedule the event to run every ten minutes.
Schedule the event to run every thirty minutes.
Set the days of the week the command should run on.
Schedule the event to run between start and end time.
Schedule the event to not run between start and end time.
State that the command should run in background.
Set the timezone the date should be evaluated on.
Set which user the command should run as.
Limit the environments the command should run in.
State that the command should run even in maintenance mode.
Do not allow the event to overlap each other.
Register a callback to further filter the schedule.
Register a callback to further filter the schedule.
Send the output of the command to a given location.
Append the output of the command to a given location.
E-mail the results of the scheduled operation.
E-mail the results of the scheduled operation if it produces output.
Register a callback to ping a given URL before the job runs.
Register a callback to be called before the operation.
Register a callback to ping a given URL after the job runs.
Register a callback to be called after the operation.
Register a callback to be called after the operation.
Set the human-friendly description of the event.
Set the human-friendly description of the event.
Get the summary of the event for display.
Get the Cron expression for the event.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Console/Scheduling/Event.html