1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Schedule

Schedule

class Schedule extends Facade (View source)

Properties

static protected Application|null $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 MockInterface
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
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 $name)

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 Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|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 CallbackEvent
call(string|callable $callback, array $parameters = [])

No description

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

No description

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

No description

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

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 Event[]
events()

No description

static Schedule
useCache(string $store)

No description

static void
macro(string $name, object|callable $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 PendingEventAttributes
withoutOverlapping(int $expiresAt = 1440)

No description

static void
mergeAttributes(Event $event)

No description

static PendingEventAttributes
user(string $user)

No description

static PendingEventAttributes
environments(array|mixed $environments)

No description

static PendingEventAttributes
evenInMaintenanceMode()

No description

static PendingEventAttributes
onOneServer()

No description

static PendingEventAttributes
runInBackground()

No description

static PendingEventAttributes
when(Closure|bool $callback)

No description

static PendingEventAttributes
skip(Closure|bool $callback)

No description

static PendingEventAttributes
cron(string $expression)

No description

static PendingEventAttributes
between(string $startTime, string $endTime)

No description

static PendingEventAttributes
unlessBetween(string $startTime, string $endTime)

No description

static PendingEventAttributes
everySecond()

No description

static PendingEventAttributes
everyTwoSeconds()

No description

static PendingEventAttributes
everyFiveSeconds()

No description

static PendingEventAttributes
everyTenSeconds()

No description

static PendingEventAttributes
everyFifteenSeconds()

No description

static PendingEventAttributes
everyTwentySeconds()

No description

static PendingEventAttributes
everyThirtySeconds()

No description

static PendingEventAttributes
everyMinute()

No description

static PendingEventAttributes
everyTwoMinutes()

No description

static PendingEventAttributes
everyThreeMinutes()

No description

static PendingEventAttributes
everyFourMinutes()

No description

static PendingEventAttributes
everyFiveMinutes()

No description

static PendingEventAttributes
everyTenMinutes()

No description

static PendingEventAttributes
everyFifteenMinutes()

No description

static PendingEventAttributes
everyThirtyMinutes()

No description

static PendingEventAttributes
hourly()

No description

static PendingEventAttributes
hourlyAt(array|string|int $offset)

No description

static PendingEventAttributes
everyOddHour(array|string|int $offset)

No description

static PendingEventAttributes
everyTwoHours(array|string|int $offset)

No description

static PendingEventAttributes
everyThreeHours(array|string|int $offset)

No description

static PendingEventAttributes
everyFourHours(array|string|int $offset)

No description

static PendingEventAttributes
everySixHours(array|string|int $offset)

No description

static PendingEventAttributes
daily()

No description

static PendingEventAttributes
at(string $time)

No description

static PendingEventAttributes
dailyAt(string $time)

No description

static PendingEventAttributes
twiceDaily(int $first = 1, int $second = 13)

No description

static PendingEventAttributes
twiceDailyAt(int $first = 1, int $second = 13, int $offset)

No description

static PendingEventAttributes
weekdays()

No description

static PendingEventAttributes
weekends()

No description

static PendingEventAttributes
mondays()

No description

static PendingEventAttributes
tuesdays()

No description

static PendingEventAttributes
wednesdays()

No description

static PendingEventAttributes
thursdays()

No description

static PendingEventAttributes
fridays()

No description

static PendingEventAttributes
saturdays()

No description

static PendingEventAttributes
sundays()

No description

static PendingEventAttributes
weekly()

No description

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

No description

static PendingEventAttributes
monthly()

No description

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

No description

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

No description

static PendingEventAttributes
lastDayOfMonth(string $time = '0:0')

No description

static PendingEventAttributes
quarterly()

No description

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

No description

static PendingEventAttributes
yearly()

No description

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

No description

static PendingEventAttributes
days(array|mixed $days)

No description

static PendingEventAttributes
timezone(DateTimeZone|string $timezone)

No description

Details

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

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 63
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 79
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 95
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 111
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 127
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 141
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 153
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 193
static bool isFake()

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

Return Value

bool

in Facade at line 206
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 93
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 250
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 260
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 270
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 325
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 336
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

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

No description

Parameters

string|callable $callback
array $parameters

Return Value

CallbackEvent

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

No description

Parameters

string $command
array $parameters

Return Value

Event

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

No description

Parameters

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

Return Value

CallbackEvent

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

No description

Parameters

string $command
array $parameters

Return Value

Event

at line 86
static void group(Closure $events)

No description

Parameters

Closure $events

Return Value

void

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

No description

Parameters

string|int $key
array $value

Return Value

string

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

No description

Parameters

Event $event
DateTimeInterface $time

Return Value

bool

at line 86
static Collection dueEvents(Application $app)

No description

Parameters

Application $app

Return Value

Collection

at line 86
static Event[] events()

No description

Return Value

Event[]

at line 86
static Schedule useCache(string $store)

No description

Parameters

string $store

Return Value

Schedule

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 86
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 86
static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 86
static PendingEventAttributes withoutOverlapping(int $expiresAt = 1440)

No description

Parameters

int $expiresAt

Return Value

PendingEventAttributes

at line 86
static void mergeAttributes(Event $event)

No description

Parameters

Event $event

Return Value

void

at line 86
static PendingEventAttributes user(string $user)

No description

Parameters

string $user

Return Value

PendingEventAttributes

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

No description

Parameters

array|mixed $environments

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes evenInMaintenanceMode()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes onOneServer()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes runInBackground()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

Closure|bool $callback

Return Value

PendingEventAttributes

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

No description

Parameters

Closure|bool $callback

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes cron(string $expression)

No description

Parameters

string $expression

Return Value

PendingEventAttributes

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

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

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

No description

Parameters

string $startTime
string $endTime

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everySecond()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTwoSeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFiveSeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTenSeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFifteenSeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTwentySeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyThirtySeconds()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyMinute()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTwoMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyThreeMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFourMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFiveMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTenMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFifteenMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyThirtyMinutes()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes hourly()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes hourlyAt(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyOddHour(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyTwoHours(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyThreeHours(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everyFourHours(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes everySixHours(array|string|int $offset)

No description

Parameters

array|string|int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes daily()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes at(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes dailyAt(string $time)

No description

Parameters

string $time

Return Value

PendingEventAttributes

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

No description

Parameters

int $first
int $second

Return Value

PendingEventAttributes

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

No description

Parameters

int $first
int $second
int $offset

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes weekdays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes weekends()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes mondays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes tuesdays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes wednesdays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes thursdays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes fridays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes saturdays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes sundays()

No description

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes weekly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

array|mixed $dayOfWeek
string $time

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes monthly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $dayOfMonth
string $time

Return Value

PendingEventAttributes

at line 86
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 86
static PendingEventAttributes lastDayOfMonth(string $time = '0:0')

No description

Parameters

string $time

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes quarterly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $dayOfQuarter
string $time

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes yearly()

No description

Return Value

PendingEventAttributes

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

No description

Parameters

int $month
int|string $dayOfMonth
string $time

Return Value

PendingEventAttributes

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

No description

Parameters

array|mixed $days

Return Value

PendingEventAttributes

at line 86
static PendingEventAttributes timezone(DateTimeZone|string $timezone)

No description

Parameters

DateTimeZone|string $timezone

Return Value

PendingEventAttributes