Overview

Namespaces

  • intouch
    • ical

Classes

  • Duration
  • Factory
  • Freq
  • iCal
  • Line
  • Parser
  • Query
  • Recurrence
  • VCalendar
  • VEvent
  • VTimeZone
  • Overview
  • Namespace
  • Class
  • Tree

Class Recurrence

A wrapper for recurrence rules in iCalendar. Parses the given line and puts the recurrence rules in the correct field of this object.

See http://tools.ietf.org/html/rfc2445 for more information. Page 39 and onward contains more information on the recurrence rules themselves. Page 116 and onward contains some great examples which were often used for testing.

Namespace: intouch\ical
License: CC-BY-SA-DK
Author: Steven Oxley
Author: Michael Kahn (C) 2013
Located at ical/Recurrence.php
Methods summary
public
# __construct( intouch\ical\Line $line )

Creates an recurrence object with a passed in line. Parses the line.

Creates an recurrence object with a passed in line. Parses the line.

Parameters

$line
object
$line an intouch\ical\Line object which will be parsed to get the desired information.
protected
# parseLine( string $line )

Parses an 'RRULE' line and sets the member variables of this object. Expects a string that looks like this: 'FREQ=WEEKLY;INTERVAL=2;BYDAY=SU,TU,WE'

Parses an 'RRULE' line and sets the member variables of this object. Expects a string that looks like this: 'FREQ=WEEKLY;INTERVAL=2;BYDAY=SU,TU,WE'

Parameters

$line
string
$line the line to be parsed
public
# setUntil( mixed $ts )

Set the $until member

Set the $until member

Parameters

$ts
mixed
timestamp (int) / Valid DateTime format (string)
protected mixed
# getMember( string $member )

Retrieves the desired member variable and returns it (if it's set)

Retrieves the desired member variable and returns it (if it's set)

Parameters

$member
string
$member name of the member variable

Returns

mixed
the variable value (if set), false otherwise
public mixed
# getFreq( )

Returns the frequency - corresponds to FREQ in RFC 2445.

Returns the frequency - corresponds to FREQ in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getUntil( )

Returns when the event will go until - corresponds to UNTIL in RFC 2445.

Returns when the event will go until - corresponds to UNTIL in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getCount( )

Returns the count of the times the event will occur (should only appear if 'until' does not appear) - corresponds to COUNT in RFC 2445.

Returns the count of the times the event will occur (should only appear if 'until' does not appear) - corresponds to COUNT in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getInterval( )

Returns the interval - corresponds to INTERVAL in RFC 2445.

Returns the interval - corresponds to INTERVAL in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getBySecond( )

Returns the bysecond part of the event - corresponds to BYSECOND in RFC 2445.

Returns the bysecond part of the event - corresponds to BYSECOND in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByMinute( )

Returns the byminute information for the event - corresponds to BYMINUTE in RFC 2445.

Returns the byminute information for the event - corresponds to BYMINUTE in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByHour( )

Corresponds to BYHOUR in RFC 2445.

Corresponds to BYHOUR in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByDay( )

Corresponds to BYDAY in RFC 2445.

Corresponds to BYDAY in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByMonthDay( )

Corresponds to BYMONTHDAY in RFC 2445.

Corresponds to BYMONTHDAY in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByYearDay( )

Corresponds to BYYEARDAY in RFC 2445.

Corresponds to BYYEARDAY in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByWeekNo( )

Corresponds to BYWEEKNO in RFC 2445.

Corresponds to BYWEEKNO in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getByMonth( )

Corresponds to BYMONTH in RFC 2445.

Corresponds to BYMONTH in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getBySetPos( )

Corresponds to BYSETPOS in RFC 2445.

Corresponds to BYSETPOS in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
public mixed
# getWkst( )

Corresponds to WKST in RFC 2445.

Corresponds to WKST in RFC 2445.

Returns

mixed
string if the member has been set, false otherwise
Properties summary
public mixed $rrule
#
protected mixed $freq
#
protected mixed $until
#
protected mixed $count
#
protected mixed $interval
#
protected mixed $bysecond
#
protected mixed $byminute
#
protected mixed $byhour
#
protected mixed $byday
#
protected mixed $bymonthday
#
protected mixed $byyearday
#
protected mixed $byweekno
#
protected mixed $bymonth
#
protected mixed $bysetpos
#
protected mixed $wkst
#
protected array $listProperties array( 'bysecond', 'byminute', 'byhour', 'byday', 'bymonthday', 'byyearday', 'byweekno', 'bymonth', 'bysetpos' )
#

A list of the properties that can have comma-separated lists for values.

A list of the properties that can have comma-separated lists for values.

intouch-iCalendar API documentation generated by ApiGen 2.8.0