Docs For Class Schedule

Description

I represent a powerful class for implementing recurring schedules.

To create new Schedule instances, use one of the static instance-creation methods, NOT 'new Schedule':

Schedule::current()
Schedule::epoch()
Schedule::starting($aDateAndTime)
Schedule::startingDuration($aDateAndTime, $aDuration)
Schedule::startingEnding($startDateAndTime, $endDateAndTime)

link: http://harmoni.sourceforge.net/
author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: Schedule.class.php,v 1.4 2007/09/04 20:25:25 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/25/05

Located in /harmoni/core/Primitives/Chronology/Schedule.class.php (line 40)

SObject
   |
   --Magnitude
      |
      --Timespan
         |
         --Schedule

Method Summary

array between (object $aStart, object $anEnd)

object Schedule current ([optional $class = 'Schedule'])

Of dateAndTimes ()

object Schedule epoch ([optional $class = 'Schedule'])

array getSchedule ()

void setSchedule (array $anArrayOfDurations)

object Schedule starting (object DateAndTime $aDateAndTime, [optional $class = 'Schedule'])

object Schedule startingDuration (object DateAndTime $aDateAndTime, object Duration $aDuration, [optional $class = 'Schedule'])

object Schedule startingEnding (object DateAndTime $startDateAndTime, object DateAndTime $endDateAndTime, [optional $class = 'Schedule'])

Variables

Inherited Variables

Inherited from Timespan

Timespan::$duration
Timespan::$start

Methods

between (line 160)

Return an array of the DateAndTimes scheduled between aStart and anEnd.

return: Of DateAndTime objects
since: 5/25/05
access: public

array between (object $aStart, object $anEnd)

object $aStart
object $anEnd

current (line 67)

Answer a new object that represents now.

static:
since: 5/5/05
access: public

object Schedule current ([optional $class = 'Schedule'])

optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Redefinition of:

Timespan::current(): Answer a new object that represents now.

dateAndTimes (line 198)

Answer the DateAndTimes scheduled over the reciever's entire duration.

return: DateAndTime objects
since: 5/25/05
access: public

Of dateAndTimes ()

epoch (line 84)

Answer a Month starting on the Squeak epoch: 1 January 1901

static:
since: 5/5/05
access: public

object Schedule epoch ([optional $class = 'Schedule'])

optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Redefinition of:

Timespan::epoch(): Answer a Timespan starting on the Squeak epoch: 1 January 1901

getSchedule (line 222)

Get the schedule elements

since: 5/25/05
access: public

array getSchedule ()

setSchedule (line 211)

Set the schedule

since: 5/25/05
access: public

void setSchedule (array $anArrayOfDurations)

array $anArrayOfDurations

starting (line 102)

Create a new object starting now, with zero duration

static:
since: 5/5/05
access: public

object Schedule starting (object DateAndTime $aDateAndTime, [optional $class = 'Schedule'])

object DateAndTime $aDateAndTime
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Redefinition of:

Timespan::starting(): Create a new object starting now, with zero duration

startingDuration (line 142)

Create a new object starting now, with a given duration.

static:
since: 5/5/05
access: public

object Schedule startingDuration (object DateAndTime $aDateAndTime, object Duration $aDuration, [optional $class = 'Schedule'])

object DateAndTime $aDateAndTime
object Duration $aDuration
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Redefinition of:

Timespan::startingDuration(): Create a new object

startingEnding (line 120)

Create a new object with given start and end DateAndTimes

since: 5/11/05
access: public

object Schedule startingEnding (object DateAndTime $startDateAndTime, object DateAndTime $endDateAndTime, [optional $class = 'Schedule'])

object DateAndTime $startDateAndTime
object DateAndTime $endDateAndTime
optional $class: string $class DO NOT USE OUTSIDE OF PACKAGE. This parameter is used to get around the limitations of not being able to find the class of the object that recieved the initial method call.

Redefinition of:

Timespan::startingEnding(): Create a new object with given start and end DateAndTimes

Inherited Methods

Inherited From Timespan

Timespan::Timespan()
Timespan::asDate()
Timespan::asDateAndTime()
Timespan::asDuration()
Timespan::asMonth()
Timespan::asTime()
Timespan::asTimeStamp()
Timespan::asWeek()
Timespan::asYear()
Timespan::current()
Timespan::dates()
Timespan::day()
Timespan::dayOfMonth()
Timespan::dayOfWeek()
Timespan::dayOfWeekName()
Timespan::dayOfYear()
Timespan::daysInMonth()
Timespan::daysInYear()
Timespan::daysLeftInYear()
Timespan::duration()
Timespan::end()
Timespan::epoch()
Timespan::every()
Timespan::firstDayOfMonth()
Timespan::includes()
Timespan::includesAllOf()
Timespan::includesAnyOf()
Timespan::intersection()
Timespan::isEqualTo()
Timespan::isLeapYear()
Timespan::isLessThan()
Timespan::julianDayNumber()
Timespan::minus()
Timespan::months()
Timespan::next()
Timespan::plus()
Timespan::previous()
Timespan::printableString()
Timespan::setDuration()
Timespan::setStart()
Timespan::start()
Timespan::starting()
Timespan::startingDuration()
Timespan::startingEnding()
Timespan::startMonth()
Timespan::startMonthAbbreviation()
Timespan::startMonthIndex()
Timespan::startMonthName()
Timespan::startYear()
Timespan::to()
Timespan::union()
Timespan::weeks()
Timespan::years()

Inherited From Magnitude

Magnitude::isBetween()
Magnitude::isEqualTo()
Magnitude::isGreaterThan()
Magnitude::isGreaterThanOrEqualTo()
Magnitude::isLessThan()
Magnitude::isLessThanOrEqualTo()
Magnitude::max()
Magnitude::min()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()