AbstractCron
in package
Tags
Table of Contents
- $action : string
- $id : string
- Unprefixed cron ID.
- $interval : string
- Interval ID, like 'daily' or 'mpa_pending_payment'.
- $prefixedId : string
- Prefixed cron ID.
- $priority : int
- Do action / run priority.
- __construct() : mixed
- getAction() : string
- getId() : string
- getInterval() : string
- getNextScheduleTime() : int|false
- getTimeToNextSchedule() : int
- isScheduled() : bool
- reschedule() : bool
- An alias of schedule().
- run() : mixed
- schedule() : bool
- scheduleAt() : bool
- unschedule() : bool
- addHooks() : mixed
Properties
$action
protected
string
$action
= ''
Tags
$id
Unprefixed cron ID.
protected
string
$id
= ''
Tags
$interval
Interval ID, like 'daily' or 'mpa_pending_payment'.
protected
string
$interval
= ''
Tags
$prefixedId
Prefixed cron ID.
protected
string
$prefixedId
= ''
Tags
$priority
Do action / run priority.
protected
int
$priority
= 10
Tags
Methods
__construct()
public
__construct(string $cronId[, string $interval = 'daily' ][, mixed $priority = 10 ]) : mixed
Parameters
- $cronId : string
- $interval : string = 'daily'
-
Cron interval ID.
- $priority : mixed = 10
Tags
Return values
mixed —getAction()
public
getAction() : string
Tags
Return values
string —getId()
public
getId() : string
Tags
Return values
string —getInterval()
public
getInterval() : string
Tags
Return values
string —getNextScheduleTime()
public
getNextScheduleTime() : int|false
Tags
Return values
int|false —False if the cron is not scheduled.
getTimeToNextSchedule()
public
getTimeToNextSchedule() : int
Tags
Return values
int —Time to the next schedule (seconds).
isScheduled()
public
isScheduled() : bool
Tags
Return values
bool —reschedule()
An alias of schedule().
public
reschedule() : bool
Tags
Return values
bool —run()
public
abstract run() : mixed
Tags
Return values
mixed —schedule()
public
schedule() : bool
Tags
Return values
bool —scheduleAt()
public
scheduleAt(int $timestamp) : bool
Parameters
- $timestamp : int
Tags
Return values
bool —unschedule()
public
unschedule() : bool
Tags
Return values
bool —addHooks()
protected
addHooks() : mixed