Documentation

FreeBusyGeneratorTest extends TestCase
in package
Uses PHPUnitAssertions

Table of Contents

assertFreeBusyReport()  : mixed
This function takes a list of objects (icalendar objects), and turns them into a freebusy report.
assertVObjectEqualsVObject()  : mixed
This method tests whether two vcards or icalendar objects are semantically identical.
testAllDay()  : mixed
Testing an all-day event.
testAllDay2()  : mixed
testAllDayReferenceTimeZone()  : mixed
testCancelled()  : mixed
Testing STATUS:CANCELLED.
testDuration()  : mixed
Testing an event that uses DURATION.
testFloatingTime()  : mixed
testFloatingTimeReferenceTimeZone()  : mixed
testGeneratorBaseObject()  : mixed
testInvalidArg()  : mixed
testNoDuration()  : mixed
Testing an event that has no end or duration.
testNoValidInstances()  : mixed
testObject()  : mixed
Testing feeding the freebusy generator an object instead of a string.
testOpaque()  : mixed
Testing TRANSP:OPAQUE.
testOutsideTimeRange()  : mixed
Testing an event that falls outside of the report time-range.
testOutsideTimeRange2()  : mixed
Testing an event that falls outside of the report time-range.
testSimple()  : mixed
testSource()  : mixed
testTentative()  : mixed
Testing STATUS:TENTATIVE.
testTransparent()  : mixed
Testing TRANSP:TRANSPARENT.
testVAvailabilityIrrelevant()  : mixed
This VAVAILABILITY object does not overlap at all with the freebusy report, so it should be ignored.
testVAvailabilityOfficeHours()  : mixed
This VAVAILABILITY object has a 9am-5pm AVAILABLE object for office hours.
testVAvailabilityOfficeHoursVacation()  : mixed
This test has the same office hours, but has a vacation blocked off for the relevant time, using a higher priority. (lower number).
testVAvailabilityOfficeHoursVacation2()  : mixed
This test has the same input as the last, except somebody mixed up the PRIORITY values.
testVAvailabilitySimple()  : mixed
This VAVAILABILITY object overlaps with the time-range, but we're just busy the entire time.
testVFreeBusy()  : mixed
Testing feeding VFREEBUSY objects instead of VEVENT.
testYearlyRecurrence()  : mixed
testYearlyRecurrenceDuration()  : mixed

Methods

assertFreeBusyReport()

This function takes a list of objects (icalendar objects), and turns them into a freebusy report.

public assertFreeBusyReport(string $expected, array<string|int, mixed> $input[, string|null $timeZone = null ][, string $vavailability = null ]) : mixed

Then it takes the expected output and compares it to what we actually got.

It only generates the freebusy report for the following time-range: 2011-01-01 11:00:00 until 2011-01-03 11:11:11

Parameters
$expected : string
$input : array<string|int, mixed>
$timeZone : string|null = null
$vavailability : string = null
Return values
mixed —

assertVObjectEqualsVObject()

This method tests whether two vcards or icalendar objects are semantically identical.

public assertVObjectEqualsVObject(resource|string|Component $expected, resource|string|Component $actual[, string $message = '' ]) : mixed

It supports objects being supplied as strings, streams or Sabre\VObject\Component instances.

PRODID is removed from both objects as this is often changes and would just get in the way.

CALSCALE will automatically get removed if it's set to GREGORIAN.

Any property that has the value ANY will be treated as a wildcard.

Parameters
$expected : resource|string|Component
$actual : resource|string|Component
$message : string = ''
Return values
mixed —

testAllDayReferenceTimeZone()

public testAllDayReferenceTimeZone() : mixed
Return values
mixed —

testCancelled()

Testing STATUS:CANCELLED.

public testCancelled() : mixed
Return values
mixed —

testDuration()

Testing an event that uses DURATION.

public testDuration() : mixed
Return values
mixed —

testFloatingTimeReferenceTimeZone()

public testFloatingTimeReferenceTimeZone() : mixed
Return values
mixed —

testNoDuration()

Testing an event that has no end or duration.

public testNoDuration() : mixed
Return values
mixed —

testObject()

Testing feeding the freebusy generator an object instead of a string.

public testObject() : mixed
Return values
mixed —

testOutsideTimeRange()

Testing an event that falls outside of the report time-range.

public testOutsideTimeRange() : mixed
Return values
mixed —

testOutsideTimeRange2()

Testing an event that falls outside of the report time-range.

public testOutsideTimeRange2() : mixed
Return values
mixed —

testTentative()

Testing STATUS:TENTATIVE.

public testTentative() : mixed
Return values
mixed —

testTransparent()

Testing TRANSP:TRANSPARENT.

public testTransparent() : mixed
Return values
mixed —

testVAvailabilityIrrelevant()

This VAVAILABILITY object does not overlap at all with the freebusy report, so it should be ignored.

public testVAvailabilityIrrelevant() : mixed
Return values
mixed —

testVAvailabilityOfficeHours()

This VAVAILABILITY object has a 9am-5pm AVAILABLE object for office hours.

public testVAvailabilityOfficeHours() : mixed
Return values
mixed —

testVAvailabilityOfficeHoursVacation()

This test has the same office hours, but has a vacation blocked off for the relevant time, using a higher priority. (lower number).

public testVAvailabilityOfficeHoursVacation() : mixed
Return values
mixed —

testVAvailabilityOfficeHoursVacation2()

This test has the same input as the last, except somebody mixed up the PRIORITY values.

public testVAvailabilityOfficeHoursVacation2() : mixed

The end-result is that the vacation VAVAILABILITY is completely ignored.

Return values
mixed —

testVAvailabilitySimple()

This VAVAILABILITY object overlaps with the time-range, but we're just busy the entire time.

public testVAvailabilitySimple() : mixed
Return values
mixed —

testVFreeBusy()

Testing feeding VFREEBUSY objects instead of VEVENT.

public testVFreeBusy() : mixed
Return values
mixed —

testYearlyRecurrenceDuration()

public testYearlyRecurrenceDuration() : mixed
Return values
mixed —

Search results