\ActionScheduler_Abstract_Schedule

Class ActionScheduler_Abstract_Schedule

Summary

Methods
Properties
Constants
next()
__construct()
is_recurring()
get_next()
get_date()
__sleep()
__wakeup()
No public properties found
No constants found
calculate_next()
$scheduled_timestamp
N/A
No private methods found
$scheduled_date
N/A

Properties

$scheduled_timestamp

$scheduled_timestamp : int

Timestamp equivalent of @see $this->scheduled_date

Type

normal

$scheduled_date

$scheduled_date : \DateTime

The date & time the schedule is set to run.

Type

\DateTime

Methods

next()

next(\DateTime  $after = null) : \DateTime|null

Get the date & time this schedule was created to run, or calculate when it should be run after a given date & time.

Parameters

\DateTime $after

DateTime to calculate against.

Returns

\DateTime|null

__construct()

__construct(\DateTime  $date) : mixed

Construct.

Parameters

\DateTime $date

The date & time to run the action.

Returns

mixed

is_recurring()

is_recurring() : bool

Check if a schedule should recur.

Returns

bool

get_next()

get_next(\DateTime  $after) : \DateTime|null

Get the next date & time when this schedule should run after a given date & time.

Parameters

\DateTime $after

Start timestamp.

Returns

\DateTime|null

get_date()

get_date() : \DateTime|null

Get the date & time the schedule is set to run.

Returns

\DateTime|null

__sleep()

__sleep() : array

For PHP 5.2 compat, because DateTime objects can't be serialized

Returns

array

__wakeup()

__wakeup() : mixed

Wakeup.

Returns

mixed

calculate_next()

calculate_next(\DateTime  $after) : \DateTime

Calculate when the next instance of this schedule would run based on a given date & time.

Parameters

\DateTime $after

Start timestamp.

Returns

\DateTime