Documentation

RruleService
in package

Table of Contents

Methods

calculateNextRun()  : Carbon|null
Parse a recurrence rule and calculate the next run date
createSimpleRule()  : string
Create a simple RRULE from frequency and interval
validate()  : bool
Validate an RRULE string

Methods

calculateNextRun()

Parse a recurrence rule and calculate the next run date

public calculateNextRun(string $rrule[, Carbon|null $startDate = null ]) : Carbon|null
Parameters
$rrule : string
$startDate : Carbon|null = null
Return values
Carbon|null

createSimpleRule()

Create a simple RRULE from frequency and interval

public createSimpleRule(string $freq[, int $interval = 1 ][, Carbon|null $startDate = null ]) : string
Parameters
$freq : string

FREQ value (DAILY, WEEKLY, MONTHLY, YEARLY)

$interval : int = 1

Interval between occurrences

$startDate : Carbon|null = null

Start date for the rule

Return values
string

validate()

Validate an RRULE string

public validate(string $rrule) : bool
Parameters
$rrule : string
Return values
bool

        
On this page

Search results