Schedule

class Schedule (View source)

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.
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.

Details

void __construct()

Create a new schedule instance.

Return Value

void

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

Add a new callback event to the schedule.

Parameters

string|callable $callback
array $parameters

Return Value

CallbackEvent

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

Add a new Artisan command event to the schedule.

Parameters

string $command
array $parameters

Return Value

Event

CallbackEvent job(object|string $job)

Add a new job callback event to the schedule.

Parameters

object|string $job

Return Value

CallbackEvent

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

Add a new command event to the schedule.

Parameters

string $command
array $parameters

Return Value

Event

protected string compileParameters(array $parameters)

Compile parameters for a command.

Parameters

array $parameters

Return Value

string

Collection dueEvents(Application $app)

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

Parameters

Application $app

Return Value

Collection

Event[] events()

Get all of the events on the schedule.

Return Value

Event[]

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Console/Scheduling/Schedule.html