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

Schedule

class Schedule

Properties

protected Event[] $events

All of the events on the schedule.
protected Mutex $mutex

The mutex implementation.

Methods

void
__construct()

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)

Add a new job callback event to the schedule.

Event
exec(string $command, array $parameters = [])

Add a new command event to the schedule.

string
compileParameters(array $parameters)

Compile parameters for a command.

array
dueEvents(Application $app)

Get all of the events on the schedule that are due.

Event[]
events()

Get all of the events on the schedule.

Details

at line 30
void __construct()

Create a new schedule instance.

Return Value

void

at line 46
CallbackEvent call(string|callable $callback, array $parameters = [])

Add a new callback event to the schedule.

Parameters

string|callable $callback
array $parameters

Return Value

CallbackEvent

at line 62
Event command(string $command, array $parameters = [])

Add a new Artisan command event to the schedule.

Parameters

string $command
array $parameters

Return Value

Event

at line 79
CallbackEvent job(object|string $job)

Add a new job callback event to the schedule.

Parameters

object|string $job

Return Value

CallbackEvent

at line 93
Event exec(string $command, array $parameters = [])

Add a new command event to the schedule.

Parameters

string $command
array $parameters

Return Value

Event

at line 110
protected string compileParameters(array $parameters)

Compile parameters for a command.

Parameters

array $parameters

Return Value

string

at line 131
array dueEvents(Application $app)

Get all of the events on the schedule that are due.

Parameters

Application $app

Return Value

array

at line 141
Event[] events()

Get all of the events on the schedule.

Return Value

Event[]