Docs For Class Month

Class Month

Description

I am a timespan that represents a month.

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

Month::current()
Month::epoch()
Month::fromString($aString)
Month::starting($aDateAndTime)
Month::startingDuration($aDateAndTime, $aDuration)
Month::startingEnding($startDateAndTime, $endDateAndTime)
Month::withMonthYear($anIntegerOrStringMonth, $anIntYear)

link: http://harmoni.sourceforge.net/
author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: Month.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/4/05

Located in /harmoni/core/Primitives/Chronology/Month.class.php (line 42)

SObject
   |
   --Magnitude
      |
      --Timespan
         |
         --Month

Method Summary

object Month asMonth ()

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

integer daysInMonth ()

integer daysInMonthForYear (string $indexOrNameString, ingteger $yearInteger)

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

object Month fromString (string $aString, [optional $class = 'Month'])

integer index ()

integer indexOfMonth (string $aNameString)

string name ()

string nameOfMonth (integer $anInteger)

object Timespan previous ()

string printableString ()

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

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

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

object Month withMonthYear (string $anIntegerOrStringMonth, integer $anIntegerYear, [optional $class = 'Month'])

Variables

Inherited Variables

Inherited from Timespan

Timespan::$duration
Timespan::$start

Methods

asMonth (line 370)

Answer the receiver as a Month

since: 5/23/05
access: public

object Month asMonth ()

Redefinition of:

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

current (line 149)

Answer a new object that represents now.

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

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

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.

daysInMonth (line 306)

Answer the number of days

since: 5/5/05
access: public

integer daysInMonth ()

Redefinition of:

Timespan::daysInMonth(): Answer the number of days in the month represented by the receiver.

daysInMonthForYear (line 103)

Answer the days in this month on a given year.

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

integer daysInMonthForYear (string $indexOrNameString, ingteger $yearInteger)

string $indexOrNameString
ingteger $yearInteger

epoch (line 166)

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

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

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

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

fromString (line 185)

Read a month from the stream in any of the forms:

July 1998

since: 5/10/05
access: public

object Month fromString (string $aString, [optional $class = 'Month'])

string $aString
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.

index (line 317)

Answer the index of this object

since: 5/23/05
access: public

integer index ()

indexOfMonth (line 59)

Return the index of a string Month.

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

integer indexOfMonth (string $aNameString)

string $aNameString

name (line 328)

Answer the name of this object

since: 5/23/05
access: public

string name ()

nameOfMonth (line 81)

Return the name of the month at index.

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

string nameOfMonth (integer $anInteger)

integer $anInteger

previous (line 354)

Answer the previous object of our duration.

since: 5/10/05
access: public

object Timespan previous ()

Redefinition of:

Timespan::previous(): Answer the previous object of our duration.

printableString (line 339)

Answer a printable string

since: 5/23/05
access: public

string printableString ()

Redefinition of:

Timespan::printableString(): Return a printable string

starting (line 211)

Create a new object starting now, with zero duration

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

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

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

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

Override - as each month has a defined duration

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

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

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

Create a new object with given start and end DateAndTimes

since: 5/11/05
access: public

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

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

withMonthYear (line 287)

Create a Month for the given <year> and <month>.

<month> may be a number or a String with the name of the month. <year> should be with 4 digits.

since: 5/11/05
access: public

object Month withMonthYear (string $anIntegerOrStringMonth, integer $anIntegerYear, [optional $class = 'Month'])

string $anIntegerOrStringMonth
integer $anIntegerYear: Four-digit year.
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.

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:25:07 -0400 by phpDocumentor 1.3.0RC3