Schedule
in package
Table of Contents
- $events : array<string|int, Event>
- All of the events on the schedule.
- $mutex : Mutex
- The mutex implementation.
- __construct() : void
- Create a new schedule instance.
- call() : CallbackEvent
- Add a new callback event to the schedule.
- command() : Event
- Add a new Artisan command event to the schedule.
- dueEvents() : Collection
- Get all of the events on the schedule that are due.
- events() : array<string|int, Event>
- Get all of the events on the schedule.
- exec() : Event
- Add a new command event to the schedule.
- job() : CallbackEvent
- Add a new job callback event to the schedule.
- compileParameters() : string
- Compile parameters for a command.
Properties
$events
All of the events on the schedule.
protected
array<string|int, Event>
$events
= []
$mutex
The mutex implementation.
protected
Mutex
$mutex
Methods
__construct()
Create a new schedule instance.
public
__construct() : void
Return values
void —call()
Add a new callback event to the schedule.
public
call(string|callable $callback[, array<string|int, mixed> $parameters = [] ]) : CallbackEvent
Parameters
- $callback : string|callable
- $parameters : array<string|int, mixed> = []
Return values
CallbackEvent —command()
Add a new Artisan command event to the schedule.
public
command(string $command[, array<string|int, mixed> $parameters = [] ]) : Event
Parameters
- $command : string
- $parameters : array<string|int, mixed> = []
Return values
Event —dueEvents()
Get all of the events on the schedule that are due.
public
dueEvents(Application $app) : Collection
Parameters
- $app : Application
Return values
Collection —events()
Get all of the events on the schedule.
public
events() : array<string|int, Event>
Return values
array<string|int, Event> —exec()
Add a new command event to the schedule.
public
exec(string $command[, array<string|int, mixed> $parameters = [] ]) : Event
Parameters
- $command : string
- $parameters : array<string|int, mixed> = []
Return values
Event —job()
Add a new job callback event to the schedule.
public
job(object|string $job[, string|null $queue = null ]) : CallbackEvent
Parameters
- $job : object|string
- $queue : string|null = null
Return values
CallbackEvent —compileParameters()
Compile parameters for a command.
protected
compileParameters(array<string|int, mixed> $parameters) : string
Parameters
- $parameters : array<string|int, mixed>