• Inicio
• Recurr
• Rule

PHP Class Recurr\Rule

http://www.ietf.org/rfc/rfc2445.txt Information, not contained in the built/parsed RRULE, necessary to determine the various recurrence instance start time and dates are derived from the DTSTART property (default: \DateTime()). For example, "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information would be the same as what is specified for DTSTART. BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time which is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH tag is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH tag is not present) to 2. If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated. Here is an example of evaluating multiple BYxxx rule parts. FREQ=YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU;BYHOUR=8,9;BYMINUTE=30 First, the "INTERVAL=2" would be applied to "FREQ=YEARLY" to arrive at "every other year". Then, "BYMONTH=1" would be applied to arrive at "every January, every other year". Then, "BYDAY=SU" would be applied to arrive at "every Sunday in January, every other year". Then, "BYHOUR=8,9" would be applied to arrive at "every Sunday in January at 8 AM and 9 AM, every other year". Then, "BYMINUTE=30" would be applied to arrive at "every Sunday in January at 8:30 AM and 9:30 AM, every other year". Then, lacking information from RRULE, the second is derived from DTSTART, to end up in "every Sunday in January at 8:30:00 AM and 9:30:00 AM, every other year". Similarly, if the BYMINUTE, BYHOUR, BYDAY, BYMONTHDAY or BYMONTH rule part were missing, the appropriate minute, hour, day or month would have been retrieved from the "DTSTART" property. Example: The following is a rule which specifies 10 meetings which occur every other day: FREQ=DAILY;COUNT=10;INTERVAL=2 Mostrar archivo Open project: simshaun/recurr Class Usage Examples

Public Properties

Property	Type	Description
$freqs

Protected Properties

Property	Type	Description
$byDay	array
$byHour	array
$byMinute	array
$byMonth	array
$byMonthDay	array
$bySecond	array
$bySetPosition	integer
$byWeekNumber	array
$byYearDay	array
$count	integer | null
$days	array
$endDate	DateTime | null
$exDates	array
$freq	string
$interval	integer
$isExplicitInterval	boolean
$isStartDateFromDtstart	boolean
$rDates	array
$startDate	DateTime | null
$timezone	string
$until	DateTime | null
$weekStart	string
$weekStartDefined

Public Methods

Method	Description
__construct ( string $rrule = null, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null )	Construct a new Rule.
createFromArray ( array $rrule, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null ) : Rule	Create a Rule object based on a RRULE array.
createFromString ( string $rrule, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null ) : Rule	Create a Rule object based on a RRULE string.
getByDay ( ) : array	Get an array of days of the week (SU, MO, TU, .
getByDayTransformedToWeekdays ( ) : array	Get an array of Weekdays
getByHour ( ) : array	Get an array of hours of the day.
getByMinute ( ) : array	Get an array of minutes within an hour.
getByMonth ( ) : array	Get an array of months of the year.
getByMonthDay ( ) : array	Get an array of days of the month.
getBySecond ( ) : array	Get an array of seconds within a minute.
getBySetPosition ( ) : array	Get the array of values which corresponds to the nth occurrence within the set of events specified by the rule.
getByWeekNumber ( ) : array	Get an array of ordinals specifying weeks of the year.
getByYearDay ( ) : array	Get an array of days of the year.
getCount ( ) : integer | null	Get the number of occurrences at which the recurrence is range-bound.
getEndDate ( ) : DateTime
getExDates ( ) : recurr\DateExclusion[]	Get the array of dates that will not be included in a recurrence set.
getFreq ( ) : integer	Get the type of recurrence rule (as integer).
getFreqAsText ( ) : string	Get the type of recurrence rule (as text).
getInterval ( ) : integer	Get the interval that represents how often the recurrence rule repeats.
getRDates ( ) : recurr\DateInclusion[]	Get the array of dates that will be included in a recurrence set.
getStartDate ( ) : DateTime
getString ( $timezoneType = self::TZ_FLOAT ) : string	Get the RRULE as a string
getTimezone ( ) : null | string	Get timezone to use for \DateTime() objects that are UTC.
getUntil ( ) : DateTime | null	Get the \DateTime that the recurrence lasts until.
getWeekStart ( ) : string	Get the day on which the workweek starts.
getWeekStartAsNum ( ) : integer	Get the day on which the workweek starts, as an integer from 0-6, 0 being Monday and 6 being Sunday.
hasByMonth ( )
loadFromArray ( $parts ) : Rule	Populate the object based on a RRULE array.
loadFromString ( string $rrule ) : Rule	Populate the object based on a RRULE string.
setByDay ( array $byDay )	This rule specifies an array of days of the week;
setByHour ( array $byHour )	This rule specifies an array of hours of the day.
setByMinute ( array $byMinute )	This rule specifies an array of minutes within an hour.
setByMonth ( array $byMonth )	This rule specifies an array of months of the year.
setByMonthDay ( array $byMonthDay )	This rule specifies an array of days of the month.
setBySecond ( array $bySecond )	This rule specifies an array of seconds within a minute.
setBySetPosition ( array $bySetPosition )	This rule specifies an array of values which corresponds to the nth occurrence within the set of events specified by the rule. Valid values are 1 to 366 or -366 to -1. It MUST only be used in conjunction with another BYxxx rule part.
setByWeekNumber ( array $byWeekNumber )	This rule specifies an array of ordinals specifying weeks of the year.
setByYearDay ( array $byYearDay )	This rule specifies an array of days of the year.
setCount ( integer $count )	The count defines the number of occurrences at which to range-bound the recurrence. The DTSTART counts as the first occurrence.
setEndDate ( DateTime | null $endDate )	This date specifies the last possible instance in the recurrence set.
setExDates ( array $exDates )	This rule specifies an array of exception dates that will not be included in a recurrence set.
setFreq ( string $freq )	Identifies the type of recurrence rule.
setInterval ( integer $interval )	The interval represents how often the recurrence rule repeats.
setRDates ( array $rDates )	This rule specifies an array of dates that will be included in a recurrence set.
setStartDate ( DateTime | null $startDate, boolean | null $includeInString = null )	This date specifies the first instance in the recurrence set.
setTimezone ( string $timezone )
setUntil ( DateTime $until )	Define a \DateTime value which bounds the recurrence rule in an inclusive manner. If the value specified is synchronized with the specified recurrence, this DateTime becomes the last instance of the recurrence. If not present, and a COUNT is also not present, the RRULE is considered to repeat forever.
setWeekStart ( string $weekStart )	This rule specifies the day on which the workweek starts.

Private Methods

Method	Description
convertZtoUtc ( DateTime $date ) : DateTime	DateTime::setTimezone fails if the timezone does not have an ID.

Method Details

Property Details