PHP Interface RRule\RRuleInterface

Inheritance: extends Iterator, extends ArrayAccess, extends Countable
显示文件 Open project: rlanvin/php-rrule

Public Methods

Method Description
getOccurrences ( ) : array Return all the occurrences in an array of \DateTime.
getOccurrencesBetween ( mixed $begin, mixed $end ) : array Return all the ocurrences after a date, before a date, or between two dates.
isFinite ( ) : boolean Return true if the rrule has an end condition, false otherwise
isInfinite ( ) : boolean Return true if the rrule has no end condition (infite)
occursAt ( mixed $date ) : boolean Return true if $date is an occurrence.

Method Details

getOccurrences() public method

Return all the occurrences in an array of \DateTime.
public getOccurrences ( ) : array
return array An array of \DateTime objects

getOccurrencesBetween() public method

Return all the ocurrences after a date, before a date, or between two dates.
public getOccurrencesBetween ( mixed $begin, mixed $end ) : array
$begin mixed Can be null to return all occurrences before $end
$end mixed Can be null to return all occurrences after $begin
return array An array of \DateTime objects

isFinite() public method

Return true if the rrule has an end condition, false otherwise
public isFinite ( ) : boolean
return boolean

isInfinite() public method

Return true if the rrule has no end condition (infite)
public isInfinite ( ) : boolean
return boolean

occursAt() public method

Return true if $date is an occurrence.
public occursAt ( mixed $date ) : boolean
$date mixed
return boolean