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

Schedule

class Schedule mixin PendingEventAttributes (View source)

Traits

Macroable

Constants

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

Properties

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.
protected array<string,bool> $mutexCache

The cache of mutex results.
protected PendingEventAttributes|null $attributes

The attributes to pass to the event.
protected PendingEventAttributes> $groupStack

The schedule group attributes stack.

Methods

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 void
flushMacros()

Flush the existing macros.

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 into the schedule instance.

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
dispatchUniqueJobToQueue(object $job, string|null $queue, string|null $connection)

Dispatch the given unique 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.

void
group(Closure $events)

Create new schedule group.

void
mergePendingAttributes(Event $event)

Merge the current group attributes with the given event.

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.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 457
mixed __call(string $method, array $parameters)

Dynamically handle calls into the schedule instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 109
void __construct(DateTimeZone|string|null $timezone = null)

Create a new schedule instance.

Parameters

DateTimeZone|string|null $timezone

Return Value

void

Exceptions

RuntimeException

at line 137
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 155
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 178
CallbackEvent job(object|string $job, string|null $queue = null, string|null $connection = null)

Add a new job callback event to the schedule.

Parameters

object|string $job
string|null $queue
string|null $connection

Return Value

CallbackEvent

at line 209
protected void dispatchToQueue(object $job, string|null $queue, string|null $connection)

Dispatch the given job to the queue.

Parameters

object $job
string|null $queue
string|null $connection

Return Value

void

Exceptions

RuntimeException

at line 240
protected void dispatchUniqueJobToQueue(object $job, string|null $queue, string|null $connection)

Dispatch the given unique job to the queue.

Parameters

object $job
string|null $queue
string|null $connection

Return Value

void

Exceptions

RuntimeException

at line 261
protected void dispatchNow(object $job)

Dispatch the given job right now.

Parameters

object $job

Return Value

void

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

Add a new command event to the schedule.

Parameters

string $command
array $parameters

Return Value

Event

at line 294
void group(Closure $events)

Create new schedule group.

Parameters

Closure $events

Return Value

void

Exceptions

RuntimeException

at line 313
protected void mergePendingAttributes(Event $event)

Merge the current group attributes with the given event.

Parameters

Event $event

Return Value

void

at line 334
protected string compileParameters(array $parameters)

Compile parameters for a command.

Parameters

array $parameters

Return Value

string

at line 356
string compileArrayInput(string|int $key, array $value)

Compile array input for a command.

Parameters

string|int $key
array $value

Return Value

string

at line 382
bool serverShouldRun(Event $event, DateTimeInterface $time)

Determine if the server is allowed to run this event.

Parameters

Event $event
DateTimeInterface $time

Return Value

bool

at line 393
Collection dueEvents(Application $app)

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

Parameters

Application $app

Return Value

Collection

at line 403
Event[] events()

Get all of the events on the schedule.

Return Value

Event[]

at line 414
$this useCache(string $store)

Specify the cache store that should be used to store mutexes.

Parameters

string $store

Return Value

$this

at line 434
protected Dispatcher getDispatcher()

Get the job dispatcher, if available.

Return Value

Dispatcher

Exceptions

RuntimeException