rooty/php-rrule
1
0
Fork 0
mirror of https://github.com/rlanvin/php-rrule.git synced 2025-02-26 15:54:14 +01:00
Code Issues Releases Activity

Add comments

Browse Source
This commit is contained in:
rlanvin 2017-01-06 16:03:00 +02:00
parent 442f90cc72
commit 472462e0bb
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/RRule.php
View File

@ -77,12 +77,12 @@ function is_leap_year($year)
* *
* Some useful terms to understand the algorithms and variables naming: * Some useful terms to understand the algorithms and variables naming:
* *
* - yearday = day of the year, from 0 to 365 (on leap years) - date('z') * - "yearday" = day of the year, from 0 to 365 (on leap years) - `date('z')`
* - weekday = day of the week (ISO-8601), from 1 (MO) to 7 (SU) - date('N') * - "weekday" = day of the week (ISO-8601), from 1 (MO) to 7 (SU) - `date('N')`
* - monthday = day of the month, from 1 to 31 * - "monthday" = day of the month, from 1 to 31
* - wkst = week start, the weekday (1 to 7) which is the first day of week. * - "wkst" = week start, the weekday (1 to 7) which is the first day of week.
* Default is Monday (1). In some countries it's Sunday (7). * Default is Monday (1). In some countries it's Sunday (7).
* - weekno = number of the week in the year (ISO-8601) * - "weekno" = number of the week in the year (ISO-8601)
* *
* CAREFUL with this bug: https://bugs.php.net/bug.php?id=62476 * CAREFUL with this bug: https://bugs.php.net/bug.php?id=62476
* *
@ -100,7 +100,12 @@ class RRule implements RRuleInterface
const YEARLY = 1; const YEARLY = 1;
/** /**
* @var array frequency names * Frequency names.
* Used internally for conversion but public if a reference list is needed.
*
* @todo should probably be protected, with a static getter instead.
*
* @var array The name as the key
*/ */
public static $frequencies = array( public static $frequencies = array(
'SECONDLY' => self::SECONDLY, 'SECONDLY' => self::SECONDLY,
@ -113,7 +118,12 @@ class RRule implements RRuleInterface
); );
/** /**
* @var array weekdays numbered from 1 (ISO-8601 or date('N')) * Weekdays numbered from 1 (ISO-8601 or `date('N')`).
* Used internally but public if a reference list is needed.
*
* @todo should probably be protected, with a static getter instead.
*
* @var array The name as the key
*/ */
public static $week_days = array( public static $week_days = array(
'MO' => 1, 'MO' => 1,