Class: Calendar_Day

Source Location: /Calendar-0.5.2/Day.php

Class Overview

Calendar
   |
   --Calendar_Day

Represents a Day and builds Hours.

Author(s):

Methods

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::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::getTimestamp(): Returns a timestamp from the current date / time values. Format of
Calendar::getValidator(): Returns an instance of Calendar_Validator
Calendar::isSelected(): True if the calendar subclass object is selected (e.g. today)
Calendar::isValid(): Determine whether this date is valid, with the bounds determined by
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
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 52]
Represents a Day and builds Hours.

 require_once 'Calendar'.DIRECTORY_SEPARATOR.'Day.php';

 $Day = & new Calendar_Day(2003, 10, 21); // Oct 21st 2003
 while ($Hour = & $Day->fetch()) {
    echo $Hour->thisHour().'<br />';
 }

Access: public

[ Top ]

Method Detail

Calendar_Day (Constructor) [line 83]

Calendar_Day Calendar_Day(
int
$y, int
$m, int
$d)

Constructs Calendar_Day

Access: public

Parameters:

int	`$y`	—	year e.g. 2003
int	`$m`	—	month e.g. 8
int	`$d`	—	day e.g. 15

[ Top ]

build [line 94]

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

Builds the Hours of the Day

Access: public

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

Parameters:

array $sDates — (optional) Caledar_Hour objects representing selected dates

[ Top ]

isEmpty [line 192]

boolean isEmpty(
)

Access: public

[ Top ]

isFirst [line 161]

boolean isFirst(
)

Returns true if Day object is first in a Week

Only relevant when Day is created by Calendar_Month_Weekdays::build()

Access: public

[ Top ]

isLast [line 171]

boolean isLast(
)

Returns true if Day object is last in a Week

Only relevant when Day is created by Calendar_Month_Weekdays::build()

Access: public

[ Top ]