class Schedule extends Facade

Properties

static protected $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static 
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

from  Facade
static 
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static CallbackEvent
call(callable|array|string $callback, array $parameters = '[]')

No description

static Event
command(Command|string $command, array $parameters = '[]')

No description

static CallbackEvent
job(object|string $job, UnitEnum|string|null $queue = 'null', UnitEnum|string|null $connection = 'null')

No description

static Event
exec(string $command, array $parameters = '[]', bool $isSystem = 'true')

No description

static void
group(Closure $events)

No description

static string
compileArrayInput(string|int $key, array $value)

No description

static bool
serverShouldRun(Event $event, DateTimeInterface $time)

No description

static Collection
dueEvents(Application $app)

No description

static array
events()

No description

static Schedule
useCache(UnitEnum|string|null $store)

No description

static void
macro(string $name, callable|object $macro)

No description

static void
mixin(object $mixin, bool $replace = 'true')

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

static mixed
macroCall(string $method, array $parameters)

No description

static void
withoutInterruptionPolling()

No description

withoutOverlapping(int $expiresAt = '1440', bool $releaseOnTerminationSignals = 'true')

No description

static void
mergeAttributes(Event $event)

No description

user(string $user)

No description

environments(array|mixed $environments)

No description

evenWhenPaused()

No description

onOneServer()

No description

runInBackground()

No description

when(Closure|bool $callback)

No description

skip(Closure|bool $callback)

No description

name(string $description)

No description

description(string $description)

No description

withAttributes(array $attributes)

No description

cron(string $expression)

No description

between(string $startTime, string $endTime)

No description

unlessBetween(string $startTime, string $endTime)

No description

everySecond()

No description

everyTwoSeconds()

No description

everyFiveSeconds()

No description

everyTenSeconds()

No description

everyFifteenSeconds()

No description

everyTwentySeconds()

No description

everyThirtySeconds()

No description

everyMinute()

No description

everyTwoMinutes()

No description

everyThreeMinutes()

No description

everyFourMinutes()

No description

everyFiveMinutes()

No description

everyTenMinutes()

No description

everyFifteenMinutes()

No description

everyThirtyMinutes()

No description

hourly()

No description

hourlyAt(array|int|int[]|string $offset)

No description

everyOddHour(array|string|int $offset = '0')

No description

everyTwoHours(array|string|int $offset = '0')

No description

everyThreeHours(array|string|int $offset = '0')

No description

everyFourHours(array|string|int $offset = '0')

No description

everySixHours(array|string|int $offset = '0')

No description

daily()

No description

at(string $time)

No description

dailyAt(string $time)

No description

twiceDaily(int $first = '1', int $second = '13')

No description

twiceDailyAt(int $first = '1', int $second = '13', int $offset = '0')

No description

weekdays()

No description

weekends()

No description

mondays()

No description

tuesdays()

No description

wednesdays()

No description

thursdays()

No description

fridays()

No description

saturdays()

No description

sundays()

No description

weekly()

No description

weeklyOn(array|mixed $dayOfWeek, string $time = '\'0:0\'')

No description

monthly()

No description

monthlyOn(int $dayOfMonth = '1', string $time = '\'0:0\'')

No description

twiceMonthly(int $first = '1', int $second = '16', string $time = '\'0:0\'')

No description

lastDayOfMonth(string $time = '\'0:0\'')

No description

daysOfMonth(int[]|int ...$days)

No description

quarterly()

No description

quarterlyOn(int $dayOfQuarter = '1', string $time = '\'0:0\'')

No description

yearly()

No description

yearlyOn(int $month = '1', string|int $dayOfMonth = '1', string $time = '\'0:0\'')

No description

days(array|mixed $days)

No description

timezone(UnitEnum|string $timezone)

No description

Details

in Facade at line 55
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

in Facade at line 196
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 96
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 223
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 257
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

Tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

mixed $app

Return Value

void

in Facade at line 347
static __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

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

No description

Parameters

callable|array|string $callback
array $parameters

Return Value

CallbackEvent

at line 94
static Event command(Command|string $command, array $parameters = '[]')

No description

Parameters

Command|string $command
array $parameters

Return Value

Event

at line 94
static CallbackEvent job(object|string $job, UnitEnum|string|null $queue = 'null', UnitEnum|string|null $connection = 'null')

No description

Parameters

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

Return Value

CallbackEvent

at line 94
static Event exec(string $command, array $parameters = '[]', bool $isSystem = 'true')

No description

Parameters

string $command
array $parameters
bool $isSystem

Return Value

Event

at line 94
static void group(Closure $events)

No description

Parameters

Closure $events

Return Value

void

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

No description

Parameters

string|int $key
array $value

Return Value

string

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

No description

Parameters

Event $event
DateTimeInterface $time

Return Value

bool

at line 94
static Collection dueEvents(Application $app)

No description

Parameters

Application $app

Return Value

Collection

at line 94
static array events()

No description

Return Value

array

at line 94
static Schedule useCache(UnitEnum|string|null $store)

No description

Parameters

UnitEnum|string|null $store

Return Value

Schedule

at line 94
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 94
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 94
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 94
static void flushMacros()

No description

Return Value

void

at line 94
static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 94
static void withoutInterruptionPolling()

No description

Return Value

void

at line 94
static PendingEventAttributes withoutOverlapping(int $expiresAt = '1440', bool $releaseOnTerminationSignals = 'true')

No description

Parameters

int $expiresAt
bool $releaseOnTerminationSignals

Return Value

PendingEventAttributes

at line 94
static void mergeAttributes(Event $event)

No description

Parameters

Event $event

Return Value

void

at line 94
static PendingEventAttributes user(string $user)

No description

Parameters

string $user

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes environments(array|mixed $environments)

No description

Parameters

array|mixed $environments

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes evenInMaintenanceMode()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes evenWhenPaused()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes onOneServer()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes runInBackground()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes when(Closure|bool $callback)

No description

Parameters

Closure|bool $callback

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes skip(Closure|bool $callback)

No description

Parameters

Closure|bool $callback

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes name(string $description)

No description

Parameters

string $description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes description(string $description)

No description

Parameters

string $description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes withAttributes(array $attributes)

No description

Parameters

array $attributes

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes cron(string $expression)

No description

Parameters

string $expression

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes between(string $startTime, string $endTime)

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes unlessBetween(string $startTime, string $endTime)

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everySecond()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTwoSeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFiveSeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTenSeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFifteenSeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTwentySeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyThirtySeconds()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyMinute()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTwoMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyThreeMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFourMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFiveMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTenMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFifteenMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyThirtyMinutes()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes hourly()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes hourlyAt(array|int|int[]|string $offset)

No description

Parameters

array|int|int[]|string $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyOddHour(array|string|int $offset = '0')

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyTwoHours(array|string|int $offset = '0')

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyThreeHours(array|string|int $offset = '0')

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everyFourHours(array|string|int $offset = '0')

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes everySixHours(array|string|int $offset = '0')

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes daily()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes at(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes dailyAt(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes twiceDaily(int $first = '1', int $second = '13')

No description

Parameters

int $first
int $second

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes twiceDailyAt(int $first = '1', int $second = '13', int $offset = '0')

No description

Parameters

int $first
int $second
int $offset

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes weekdays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes weekends()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes mondays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes tuesdays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes wednesdays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes thursdays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes fridays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes saturdays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes sundays()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes weekly()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes weeklyOn(array|mixed $dayOfWeek, string $time = '\'0:0\'')

No description

Parameters

array|mixed $dayOfWeek
string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes monthly()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes monthlyOn(int $dayOfMonth = '1', string $time = '\'0:0\'')

No description

Parameters

int $dayOfMonth
string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes twiceMonthly(int $first = '1', int $second = '16', string $time = '\'0:0\'')

No description

Parameters

int $first
int $second
string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes lastDayOfMonth(string $time = '\'0:0\'')

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes daysOfMonth(int[]|int ...$days)

No description

Parameters

int[]|int ...$days

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes quarterly()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes quarterlyOn(int $dayOfQuarter = '1', string $time = '\'0:0\'')

No description

Parameters

int $dayOfQuarter
string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes yearly()

No description

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes yearlyOn(int $month = '1', string|int $dayOfMonth = '1', string $time = '\'0:0\'')

No description

Parameters

int $month
string|int $dayOfMonth
string $time

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes days(array|mixed $days)

No description

Parameters

array|mixed $days

Return Value

PendingEventAttributes

at line 94
static PendingEventAttributes timezone(UnitEnum|string $timezone)

No description

Parameters

UnitEnum|string $timezone

Return Value

PendingEventAttributes