class Schedule extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

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 MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
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 void
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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static void
alwaysOnOneServer(bool $value = 'true')

No description

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

No description

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

No description

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

No description

static Collection
dueEvents(Application $app)

No description

static Collection
dueEventsAt(Application $app, DateTimeInterface $time)

No description

static void
array()

<int, \Hypervel\Console\Scheduling\Event> eventsForEnvironments(array<int, string> $environments)

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

No description

static void
flushMacros()

No description

static void
flushState()

No description

static void
group(Closure $events)

No description

static bool
static bool
hasMacro(string $name)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static void
whenTaskRunsLongerThan(CarbonInterval|int|float $threshold, callable $handler)

No description

static void
withoutInterruptionPolling()

No description

at(string $time)

No description

between(string $startTime, string $endTime)

No description

cron(string $expression)

No description

daily()

No description

dailyAt(string $time)

No description

days(mixed $days)

No description

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

No description

description(string $description)

No description

environments(UnitEnum|array|string $environments)

No description

evenWhenPaused()

No description

everyFifteenMinutes()

No description

everyFifteenSeconds()

No description

everyFiveMinutes()

No description

everyFiveSeconds()

No description

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

No description

everyFourMinutes()

No description

everyMinute()

No description

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

No description

everySecond()

No description

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

No description

everyTenMinutes()

No description

everyTenSeconds()

No description

everyThirtyMinutes()

No description

everyThirtySeconds()

No description

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

No description

everyThreeMinutes()

No description

everyTwentySeconds()

No description

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

No description

everyTwoMinutes()

No description

everyTwoSeconds()

No description

fridays()

No description

hourly()

No description

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

No description

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

No description

static void
mergeAttributes(Event $event)

No description

mondays()

No description

monthly()

No description

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

No description

name(string $description)

No description

onOneServer()

No description

quarterly()

No description

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

No description

runInBackground()

No description

saturdays()

No description

skip(callable|bool $callback)

No description

sundays()

No description

thursdays()

No description

timezone(UnitEnum|string $timezone)

No description

tuesdays()

No description

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

No description

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

No description

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

No description

unlessBetween(string $startTime, string $endTime)

No description

wednesdays()

No description

weekdays()

No description

weekends()

No description

weekly()

No description

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

No description

when(callable|bool $callback)

No description

withAttributes(array $attributes)

No description

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

No description

yearly()

No description

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

No description

Details

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

Run a Closure when the facade has been resolved.

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 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

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

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

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

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 104
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

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

Parameters

Container|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 99
static void alwaysOnOneServer(bool $value = 'true')

No description

Parameters

bool $value

Return Value

void

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

No description

Parameters

callable|array|string $callback
array $parameters

Return Value

CallbackEvent

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

No description

Parameters

Command|string $command
array $parameters

Return Value

Event

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

No description

Parameters

string|int $key
array $value

Return Value

string

at line 99
static Collection dueEvents(Application $app)

No description

Parameters

Application $app

Return Value

Collection

at line 99
static Collection dueEventsAt(Application $app, DateTimeInterface $time)

No description

Parameters

Application $app
DateTimeInterface $time

Return Value

Collection

at line 99
static void array()

<int, \Hypervel\Console\Scheduling\Event> eventsForEnvironments(array<int, string> $environments)

Return Value

void

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

No description

Parameters

string $command
array $parameters
bool $isSystem

Return Value

Event

at line 99
static void flushMacros()

No description

Return Value

void

at line 99
static void flushState()

No description

Return Value

void

at line 99
static void group(Closure $events)

No description

Parameters

Closure $events

Return Value

void

at line 99
static bool hasBeenInterruptedSince(DateTimeInterface $time)

No description

Parameters

DateTimeInterface $time

Return Value

bool

at line 99
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 99
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 99
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

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

No description

Parameters

Event $event
DateTimeInterface $time

Return Value

bool

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

No description

Parameters

UnitEnum|string|null $store

Return Value

Schedule

at line 99
static void whenTaskRunsLongerThan(CarbonInterval|int|float $threshold, callable $handler)

No description

Parameters

CarbonInterval|int|float $threshold
callable $handler

Return Value

void

at line 99
static void withoutInterruptionPolling()

No description

Return Value

void

at line 99
static PendingEventAttributes at(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

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

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes cron(string $expression)

No description

Parameters

string $expression

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes daily()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes dailyAt(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes days(mixed $days)

No description

Parameters

mixed $days

Return Value

PendingEventAttributes

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

No description

Parameters

int[]|int ...$days

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes description(string $description)

No description

Parameters

string $description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes environments(UnitEnum|array|string $environments)

No description

Parameters

UnitEnum|array|string $environments

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes evenInMaintenanceMode()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes evenWhenPaused()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyFifteenMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyFifteenSeconds()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyFiveMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyFiveSeconds()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyFourMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyMinute()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everySecond()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyTenMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyTenSeconds()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyThirtyMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyThirtySeconds()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyThreeMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyTwentySeconds()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyTwoMinutes()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes everyTwoSeconds()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes fridays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes hourly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|int|int[]|string $offset

Return Value

PendingEventAttributes

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

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 99
static void mergeAttributes(Event $event)

No description

Parameters

Event $event

Return Value

void

at line 99
static PendingEventAttributes mondays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes monthly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $dayOfMonth
string $time

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes name(string $description)

No description

Parameters

string $description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes onOneServer()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes quarterly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $dayOfQuarter
string $time

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes runInBackground()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes saturdays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes skip(callable|bool $callback)

No description

Parameters

callable|bool $callback

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes sundays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes thursdays()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

UnitEnum|string $timezone

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes tuesdays()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $first
int $second

Return Value

PendingEventAttributes

at line 99
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 99
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 99
static PendingEventAttributes unlessBetween(string $startTime, string $endTime)

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes wednesdays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes weekdays()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes weekends()

No description

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes weekly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

mixed $dayOfWeek
string $time

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes when(callable|bool $callback)

No description

Parameters

callable|bool $callback

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes withAttributes(array $attributes)

No description

Parameters

array $attributes

Return Value

PendingEventAttributes

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

No description

Parameters

int $expiresAt
bool $releaseOnTerminationSignals

Return Value

PendingEventAttributes

at line 99
static PendingEventAttributes yearly()

No description

Return Value

PendingEventAttributes

at line 99
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