Calendar
[ class tree: Calendar ] [ index: Calendar ] [ all elements ]

Class: Calendar_Month

Source Location: /Calendar-0.5.5/Month.php

Class Overview

Calendar
   |
   --Calendar_Month

Represents a Month and builds Days


Author(s):

Copyright:

  • 2003-2007 Harry Fuecks

Methods


Child classes:

Calendar_Month_Weeks
Represents a Month and builds Weeks
Calendar_Month_Weekdays
Represents a Month and builds Days in tabular form

Inherited Variables

Inherited Methods

Class: Calendar

Calendar::Calendar()
Constructs the Calendar
Calendar::adjust()
Adjusts the date (helper method)
Calendar::build()
Abstract method for building the children of a calendar object.
Calendar::defineFirstDayOfWeek()
Set the CALENDAR_FIRST_DAY_OF_WEEK constant to the $firstDay value if the constant is not set yet.
Calendar::fetch()
Iterator method for fetching child Calendar subclass objects (e.g. a minute from an hour object). On reaching the end of the collection, returns false and resets the collection for further iteratations.
Calendar::fetchAll()
Fetches all child from the current collection of children
Calendar::getEngine()
Returns a reference to the current Calendar_Engine being used. Useful for Calendar_Table_Helper and Calendar_Validator
Calendar::getTimestamp()
Returns a timestamp from the current date / time values. Format of timestamp depends on Calendar_Engine implementation being used
Calendar::getValidator()
Returns an instance of Calendar_Validator
Calendar::isSelected()
True if the calendar subclass object is selected (e.g. today)
Calendar::isToday()
Checks if the current Calendar object is today's date
Calendar::isValid()
Determine whether this date is valid, with the bounds determined by the Calendar_Engine. The call is passed on to Calendar_Validator::isValid
Calendar::nextDay()
Returns the value for the next day
Calendar::nextHour()
Returns the value for the next hour
Calendar::nextMinute()
Returns the value for the next minute
Calendar::nextMonth()
Returns the value for next month
Calendar::nextSecond()
Returns the value for the next second
Calendar::nextYear()
Returns the value for next year
Calendar::prevDay()
Returns the value for the previous day
Calendar::prevHour()
Returns the value for the previous hour
Calendar::prevMinute()
Returns the value for the previous minute
Calendar::prevMonth()
Returns the value for the previous month
Calendar::prevSecond()
Returns the value for the previous second
Calendar::prevYear()
Returns the value for the previous year
Calendar::setSelected()
Defines calendar object as selected (e.g. for today)
Calendar::setSelection()
Abstract method for selected data objects called from build
Calendar::setTimestamp()
Defines the calendar by a timestamp (Unix or ISO-8601), replacing values passed to the constructor
Calendar::size()
Get the number Calendar subclass objects stored in the internal collection
Calendar::thisDay()
Returns the value for this day
Calendar::thisHour()
Returns the value for this hour
Calendar::thisMinute()
Returns the value for this minute
Calendar::thisMonth()
Returns the value for this month
Calendar::thisSecond()
Returns the value for this second
Calendar::thisYear()
Returns the value for this year
Calendar::toArray()
Returns the date as an associative array (helper method)

Class Details

[line 71]
Represents a Month and builds Days

  1.  require_once 'Calendar/Month.php';
  2.  $Month = new Calendar_Month(200310)// Oct 2003
  3.  $Month->build()// Build Calendar_Day objects
  4.  while ($Day $Month->fetch()) {
  5.      echo $Day->thisDay().'<br />';
  6.  }



[ Top ]


Method Detail

Calendar_Month (Constructor)   [line 82]

Calendar_Month Calendar_Month( int $y, int $m, [int $firstDay = null])

Constructs Calendar_Month
  • Access: public

Parameters:

int   $y     year e.g. 2003
int   $m     month e.g. 5
int   $firstDay     first day of the week [optional]

[ Top ]

build   [line 97]

boolean build( [array $sDates = array()])

Builds Day objects for this Month. Creates as many Calendar_Day objects as there are days in the month
  • Access: public

Overridden in child classes as:

Calendar_Month_Weeks::build()
Builds Calendar_Week objects for the Month. Note that Calendar_Week builds Calendar_Day object in tabular form (with Calendar_Day->empty)
Calendar_Month_Weekdays::build()
Builds Day objects in tabular form, to allow display of calendar month with empty cells if the first day of the week does not fall on the first day of the month.

Overrides Calendar::build() (Abstract method for building the children of a calendar object.)

Parameters:

array   $sDates     (optional) Calendar_Day objects representing selected dates

[ Top ]


Documentation generated on Thu, 24 Jun 2010 14:00:11 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.