PHP Class When\When

Inheritance: extends when\DateTime
Exibir arquivo Open project: tplaner/when Class Usage Examples

Public Properties

Property Type Description
$RFC5545_COMPLIANT
$bydays
$byhours
$byminutes
$bymonthdays
$bymonths
$byseconds
$bysetpos
$byweeknos
$byyeardays
$count
$freq
$interval
$occurrences
$rangeLimit
$startDate
$until
$wkst

Public Methods

Method Description
__construct ( $time = "now", $timezone = NULL )
byday ( $bywdaylist, $delimiter = "," )
byhour ( $hours, $delimiter = "," )
byminute ( $minutes, $delimiter = "," )
bymonth ( $bymolist, $delimiter = "," )
bymonthday ( $bymodaylist, $delimiter = "," )
bysecond ( $seconds, $delimiter = "," )
bysetpos ( $bysplist, $delimiter = "," )
byweekno ( $bywknolist, $delimiter = "," )
byyearday ( $byyrdaylist, $delimiter = "," )
count ( $count )
freq ( $frequency )
generateOccurrences ( )
getFirstWeekStartDate ( $startDate, $wkst ) "The WKST rule part specifies the day on which the workweek starts. [.
getNextOccurrence ( $occurDate, $strictly_after = true )
getOccurrencesBetween ( $startDate, $endDate, $limit = NULL ) Get occurrences between two DateTimes, exclusive. Does not modify $this.
getPrevOccurrence ( $occurDate )
interval ( $interval )
occursAt ( $date )
occursOn ( $date )
rrule ( $rrule )
startDate ( $startDate )
until ( $endDate )
wkst ( $weekDay )

Protected Methods

Method Description
addOccurrence ( $occurrences )
createDaysList ( $days )
createItemsList ( $list, $delimiter )
generateTimeOccurrences ( $dateLooper ) not happy with this.
prepareDateElements ( $limitRange = true ) If $limitRange is true, $this->count and $this->until will be set if not already set.
prepareItemsList ( $items, $delimiter = ",", $validator = null )
prepareOccurrences ( $occurrences, $count )

Private Methods

Method Description
abbrevToDayName ( $abbrev )
countOccurrencesBefore ( $date )
findDateRangeOverlap ( $startDate, $endDate )

Method Details

__construct() public method

public __construct ( $time = "now", $timezone = NULL )

addOccurrence() protected method

protected addOccurrence ( $occurrences )

byday() public method

public byday ( $bywdaylist, $delimiter = "," )

byhour() public method

public byhour ( $hours, $delimiter = "," )

byminute() public method

public byminute ( $minutes, $delimiter = "," )

bymonth() public method

public bymonth ( $bymolist, $delimiter = "," )

bymonthday() public method

public bymonthday ( $bymodaylist, $delimiter = "," )

bysecond() public method

public bysecond ( $seconds, $delimiter = "," )

bysetpos() public method

public bysetpos ( $bysplist, $delimiter = "," )

byweekno() public method

public byweekno ( $bywknolist, $delimiter = "," )

byyearday() public method

public byyearday ( $byyrdaylist, $delimiter = "," )

count() public method

public count ( $count )

createDaysList() protected static method

protected static createDaysList ( $days )

createItemsList() protected static method

protected static createItemsList ( $list, $delimiter )

freq() public method

public freq ( $frequency )

generateOccurrences() public method

public generateOccurrences ( )

generateTimeOccurrences() protected method

not happy with this.
protected generateTimeOccurrences ( $dateLooper )

getFirstWeekStartDate() public static method

..] This is significant when a WEEKLY "RRULE" has an interval greater than 1, and a BYDAY rule part is specified." -- RFC 5545 See http://stackoverflow.com/questions/5750586/determining-occurrences-from-icalendar-rrule-that-expands
public static getFirstWeekStartDate ( $startDate, $wkst )

getNextOccurrence() public method

public getNextOccurrence ( $occurDate, $strictly_after = true )

getOccurrencesBetween() public method

Get occurrences between two DateTimes, exclusive. Does not modify $this.
public getOccurrencesBetween ( $startDate, $endDate, $limit = NULL )

getPrevOccurrence() public method

public getPrevOccurrence ( $occurDate )

interval() public method

public interval ( $interval )

occursAt() public method

public occursAt ( $date )

occursOn() public method

public occursOn ( $date )

prepareDateElements() protected method

If $limitRange is true, $this->count and $this->until will be set if not already set.
protected prepareDateElements ( $limitRange = true )

prepareItemsList() protected static method

protected static prepareItemsList ( $items, $delimiter = ",", $validator = null )

prepareOccurrences() protected method

protected prepareOccurrences ( $occurrences, $count )

rrule() public method

public rrule ( $rrule )

startDate() public method

public startDate ( $startDate )

until() public method

public until ( $endDate )

wkst() public method

public wkst ( $weekDay )

Property Details

$RFC5545_COMPLIANT public_oe property

public $RFC5545_COMPLIANT

$bydays public_oe property

public $bydays

$byhours public_oe property

public $byhours

$byminutes public_oe property

public $byminutes

$bymonthdays public_oe property

public $bymonthdays

$bymonths public_oe property

public $bymonths

$byseconds public_oe property

public $byseconds

$bysetpos public_oe property

public $bysetpos

$byweeknos public_oe property

public $byweeknos

$byyeardays public_oe property

public $byyeardays

$count public_oe property

public $count

$freq public_oe property

public $freq

$interval public_oe property

public $interval

$occurrences public_oe property

public $occurrences

$rangeLimit public_oe property

public $rangeLimit

$startDate public_oe property

public $startDate

$until public_oe property

public $until

$wkst public_oe property

public $wkst