Home

Functions

• libicalrecurrenceNew
• libicalrecurrenceHasNext
• [libicalrecurrenceNext] (#libicalrecurrencenext)
• [libicalrecurrenceAdvanceTo] (#libicalrecurrenceadvanceto)
• [libicalrecurrenceIsInfinite] (#libicalrecurrenceisinfinite)
• [libicalrecurrenceLast] (#libicalrecurrencelast)
• [libicalrecurrenceReset] (#libicalrecurrencereset)

libicalrecurrenceNew

Creates a libicalrecurrence object to evaluate the recurrence set generated by the passed parameters

Parameters:

• startDate (date) - The start date of the recurrence
• rrule (string) - The recurrence rule (check here for the format of this parameter)
• rdate (string) - List of date/time to be included to the recurrence set (check here for the format of this parameter)
• exdate (string) - List of date/time to be excluded from the recurrence set (check here for the format of this parameter)

Returns:

A libicalrecurrence object to evaluate the recurrence set

<cfset dtStart = createDateTime(2015, 7, 20, 0, 0, 0) />
<cfset rcRule = "FREQ=DAILY;BYDAY=MO,TU,WE,TH,FR;UNTIL=20150726T235959" />
<cfset iterator = libicalrecurrenceNew(startDate = dtStart, rrule = rcRule) />

libicalrecurrenceHasNext

Checks whether there are more dates in a recurrence set

Parameters:

• recurrence (libicalrecurrence object) - The libicalrecurrence object to be checked for more dates

Returns:

true if more dates to be queried in the recurrence set, false otherwise

libicalrecurrenceNext

Retrieves the next date in a recurrence set

Parameters:

• recurrence (libicalrecurrence object) - The libicalrecurrence object for which the next date is to be queried

Returns:

The next date in the recurrence set

libicalrecurrenceAdvanceTo

Skips all dates in a recurrence set before the given date

Parameters:

• recurrence (libicalrecurrence object) - The libicalrecurrence object for which the next date is to be queried
• newDate (date) - The date to which this recurrence is to be moved forward

libicalrecurrenceIsInfinite

Indicates whether a recurrence set is infinite

Parameters:

• recurrence (libicalrecurrence object) - The libicalrecurrence object to be checked

Returns:

true if the recurrence set is infinite, false otherwise

libicalrecurrenceLast

Retrieves the last date in a recurrence set

• recurrence (libicalrecurrence object) - The libicalrecurrence object for which the last date is to be queried

Returns:

The last date in the recurrence set

libicalrecurrenceReset

Resets the recurrence set at its first occurrence date

• recurrence (libicalrecurrence object) - The libicalrecurrence object to be reset