class Schedule (View source)
| Macroable |
| SUNDAY |
| MONDAY |
| TUESDAY |
| WEDNESDAY |
| THURSDAY |
| FRIDAY |
| SATURDAY |
| static protected array | $macros | The registered string macros. | from Macroable |
| protected Event[] | $events | All of the events on the schedule. | |
| protected EventMutex | $eventMutex | The event mutex implementation. | |
| protected SchedulingMutex | $schedulingMutex | The scheduling mutex implementation. | |
| protected DateTimeZone|string | $timezone | The timezone the date should be evaluated on. | |
| protected Dispatcher | $dispatcher | The job dispatcher implementation. |
| 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 |
| void | __construct(DateTimeZone|string|null $timezone = null) Create a new schedule instance. | |
| CallbackEvent | call(string|callable $callback, array $parameters = []) Add a new callback event to the schedule. | |
| Event | command(string $command, array $parameters = []) Add a new Artisan command event to the schedule. | |
| CallbackEvent | job(object|string $job, string|null $queue = null, string|null $connection = null) Add a new job callback event to the schedule. | |
| void | dispatchToQueue(object $job, string|null $queue, string|null $connection) Dispatch the given job to the queue. | |
| void | dispatchNow(object $job) Dispatch the given job right now. | |
| Event | exec(string $command, array $parameters = []) Add a new command event to the schedule. | |
| string | compileParameters(array $parameters) Compile parameters for a command. | |
| string | compileArrayInput(string|int $key, array $value) Compile array input for a command. | |
| bool | serverShouldRun(Event $event, DateTimeInterface $time) Determine if the server is allowed to run this event. | |
| Collection | dueEvents(Application $app) Get all of the events on the schedule that are due. | |
| Event[] | events() Get all of the events on the schedule. | |
| $this | useCache(string $store) Specify the cache store that should be used to store mutexes. | |
| Dispatcher | getDispatcher() Get the job dispatcher, if available. |
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new schedule instance.
Add a new callback event to the schedule.
Add a new Artisan command event to the schedule.
Add a new job callback event to the schedule.
Dispatch the given job to the queue.
Dispatch the given job right now.
Add a new command event to the schedule.
Compile parameters for a command.
Compile array input for a command.
Determine if the server is allowed to run this event.
Get all of the events on the schedule that are due.
Get all of the events on the schedule.
Specify the cache store that should be used to store mutexes.
Get the job dispatcher, if available.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Console/Scheduling/Schedule.html