Docs For Class Week

Class Week

Description

I am a Timespan that represents a Week.

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

Week::current()
Week::epoch()
Week::starting($aDateAndTime)
Week::startingDuration($aDateAndTime, $aDuration)
Week::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: Week.class.php,v 1.5 2007/09/04 20:25:25 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/4/05

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

SObject
   |
   --Magnitude
      |
      --Timespan
         |
         --Week

Method Summary

object Week asWeek ()

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

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

integer indexOfDay (string $aNameString)

string nameOfDay (integer $anInteger)

string startDay ()

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

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

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

Variables

Inherited Variables

Inherited from Timespan

Timespan::$duration
Timespan::$start

Methods

asWeek (line 234)

Answer the receiver as a Week

since: 5/23/05
access: public

object Week asWeek ()

Redefinition of:

Timespan::asWeek(): Answer this instance converted.

current (line 124)

Answer a new object that represents now.

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

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

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.

epoch (line 141)

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

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

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

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

indexOfDay (line 56)

Return the index of a string Day.

since: 5/4/05
access: public

integer indexOfDay (string $aNameString)

string $aNameString

nameOfDay (line 77)

Return the name of the day at index.

since: 5/4/05
access: public

string nameOfDay (integer $anInteger)

integer $anInteger

startDay (line 96)

Answer the day at the start of the week

since: 5/20/05
access: public

string startDay ()

starting (line 159)

Create a new object starting now, with zero duration

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

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

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 200)

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

Override - as each Week has a defined duration

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

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

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 177)

Create a new object with given start and end DateAndTimes

since: 5/11/05
access: public

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

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()

Documentation generated on Wed, 19 Sep 2007 10:27:56 -0400 by phpDocumentor 1.3.0RC3