Class: AliasCalendar

Source Location: /_includes/lib_calendar.php

Class Overview

Calendar
   |
   --AliasCalendar

Describes a calendar that link to aliases in a ./year/month/day format.

Author(s):

Andreas Launila

Methods

Inherited Variables

Class: Calendar

Calendar::$day
Calendar::$dayMax
Calendar::$dayMin
Calendar::$form
Calendar::$searcher
Calendar::$style
Calendar::$table
Calendar::$timestampField
Calendar::$urlRoot

Inherited Methods

Class: Calendar

Calendar::__construct(): Constructor for Calendar.
Calendar::addFieldPair(): Adds a pair of fields to the calendar. If both fields are spceified then they should be connected, i.e. their request names should be identical.
Calendar::addMonthSelection(): Adds a form selection field to the form. The selection field only contains months that include at least one day in the calendar's range.
Calendar::addYearSelection(): Adds a form selection field to the form. The selection field only contains years that include at least one day in the calendar's range.
Calendar::doDaysHaveRows(): Check if an specified interval of days have updates. Optionally constraints can be placed on the public function so that it only checks for updates of a specific type. This public function should be concidered private.
Calendar::getCalendar(): Gets the XHTML code that represent the calendar.
Calendar::getDayUrl(): Gets the url to a specified day in the calendar.
Calendar::getMonthNavigation(): Gets an XHTML compliant month navigation. The navigation allows users the move one month forward or backwards or to move to the first or last month.
Calendar::getMonthUrl(): Gets the url to a specified month in the calendar.
Calendar::getSelectedTimestamp(): Gets the calendar's selected timestamp. The timestamp has a resolution of 3600*24 seconds, i.e. days.
Calendar::getSqlSelector(): Gets the sql selector that represents the current configuration of the calendar. The selector describes what rows match the calendar selections.
Calendar::hasUserValue(): Checks if the user has selected a day or not in the calendar. If the user has not then getting results from the calendar should not be attempted.

Class Details

[line 567]
Describes a calendar that link to aliases in a ./year/month/day format.

Tags:

author:

Andreas Launila

[ Top ]

Class Methods

constructor __construct [line 579]

AliasCalendar __construct(
string
$tableToDisplay, string
$timestampField, string
$urlRoot, [string
$style = ''])

Constructor for AliasCalendar.

Tags:

access:

public

Overrides Calendar::__construct() (Constructor for Calendar.)

Parameters:

string	$tableToDisplay	The name of the table that the calendar should display.
string	$style	An optional parameter to specify custom style code to use for the calendars "style" attribute.
string	$urlRoot	The root that should be used for all urls presented by the calendar.
string	$timestampField	The name of the field in the specified table that contains the unix timestamps.

[ Top ]

method getDayUrl [line 586]

void getDayUrl(
mixed
$days)

Tags:

access:	protected
see:	com.lokorin.dfcrafters.lib.Calendar.getDayUrl($day)

Overrides Calendar::getDayUrl() (Gets the url to a specified day in the calendar.)

[ Top ]

method getMonthUrl [line 594]

void getMonthUrl(
mixed
$month, mixed
$year)

Tags:

access:	protected
see:	com.lokorin.dfcrafters.lib.Calendar.getMonthUrl($month, $year)

Overrides Calendar::getMonthUrl() (Gets the url to a specified month in the calendar.)

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:12 +0200 by phpDocumentor 1.3.0RC4