Properties

$minutes

$minutes : array

Minutes

Type

array

$hours

$hours : array

Hours

Type

array

$daysOfTheMonth

$daysOfTheMonth : array

Days of the month

Type

array

$months

$months : array

Months

Type

array

$daysOfTheWeek

$daysOfTheWeek : array

Days of the week

Type

array

$timezone

$timezone : string

Timezone

Type

string

$runUntil

$runUntil : integer|string

Run until property

Type

integer|string

Methods

__construct()

__construct(\Pop\Queue\Processor\Jobs\AbstractJob  $job = null, string  $timezone = null) 

Constructor

Instantiate the job schedule object

Parameters

\Pop\Queue\Processor\Jobs\AbstractJob $job
string $timezone

hasJob()

hasJob() : boolean

Has job

Returns

boolean

cron()

cron(mixed  $cronSchedule) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to custom cron schedule

min hour dom month dow


Parameters

mixed $cronSchedule

Returns

\Pop\Queue\Processor\Jobs\Schedule

getMinutes()

getMinutes() : array

Get minutes

Returns

array

getHours()

getHours() : array

Get hours

Returns

array

getDaysOfTheMonth()

getDaysOfTheMonth() : array

Get days of the month

Returns

array

getMonths()

getMonths() : array

Get months

Returns

array

getDaysOfTheWeek()

getDaysOfTheWeek() : array

Get days of the week

Returns

array

minutes()

minutes(mixed  $minutes) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to by specific minutes

Parameters

mixed $minutes

Returns

\Pop\Queue\Processor\Jobs\Schedule

hourly()

hourly(mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to hourly

Parameters

mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

daily()

daily(mixed  $hours, mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to daily

Parameters

mixed $hours
mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

dailyAt()

dailyAt(string  $time) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to daily at specific time, i.e. 14:30

Parameters

string $time

Returns

\Pop\Queue\Processor\Jobs\Schedule

weekly()

weekly(mixed  $day, mixed  $hours = null, mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to weekly

Parameters

mixed $day
mixed $hours
mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

monthly()

monthly(mixed  $day, mixed  $hours = null, mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to monthly

Parameters

mixed $day
mixed $hours
mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

quarterly()

quarterly(mixed  $hours = null, mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to quarterly

Parameters

mixed $hours
mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

yearly()

yearly(boolean  $endOfYear = false, mixed  $hours = null, mixed  $minute = null) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to yearly

Parameters

boolean $endOfYear
mixed $hours
mixed $minute

Returns

\Pop\Queue\Processor\Jobs\Schedule

between()

between(integer  $start, integer  $end) : \Pop\Queue\Processor\Jobs\Schedule

Set job schedule to between two hours

Parameters

integer $start
integer $end

Returns

\Pop\Queue\Processor\Jobs\Schedule

runUntil()

runUntil(integer|string  $runUntil) : \Pop\Queue\Processor\Jobs\Schedule

Set the run until property

Parameters

integer|string $runUntil

Returns

\Pop\Queue\Processor\Jobs\Schedule

hasRunUntil()

hasRunUntil() : boolean

Has run until

Returns

boolean

getRunUntil()

getRunUntil() : integer|string

Get run until value

Returns

integer|string

setTimezone()

setTimezone(string  $timezone) : \Pop\Queue\Processor\Jobs\Schedule

Set job timezone

Parameters

string $timezone

Returns

\Pop\Queue\Processor\Jobs\Schedule

getTimezone()

getTimezone() : string

Get job timezone

Returns

string

isDue()

isDue() : boolean

Determine if the schedule is due

Returns

boolean

isExpired()

isExpired(integer  $attempts = null) : boolean

Determine if the schedule is expired

Parameters

integer $attempts

Returns

boolean

isSatisfied()

isSatisfied(array  $values, mixed  $value) : boolean

Determine if the value satisfies the expression

Parameters

array $values
mixed $value

Returns

boolean