Docs For Class calendar

Description

Calendar class to perform the majority of ILance calendar functions within ILance.

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.calendar.inc.php (line 23)

Variable Summary

mixed $day

mixed $endDay

mixed $month

mixed $monthNameBrief

mixed $monthNameFull

mixed $startDay

mixed $year

Method Summary

void addEvent (string $day, string $title, [string $link = ''])

void display ()

void dspDayCell (string $day)

void dspDayCellInfo (string $day)

void dspDayCells ()

void dspDayNames ()

object generate_calendar (integer $yr, integer $mo, $da)

void getBriefMonthName ()

void getDaysEvents (string $day)

void getEndTime ()

void getFullMonthName ()

void getStartTime ()

void getYear ()

void setDayNameFormat (string $f)

void setMonth ( $month)

void setTableWidth ( $w)

void setYear ( $year)

Variables

mixed $day (line 27)

mixed $endDay (line 31)

mixed $month (line 26)

mixed $monthNameBrief (line 29)

mixed $monthNameFull (line 28)

mixed $startDay (line 30)

mixed $year (line 25)

Methods

addEvent (line 280)

Adds an event on the calendar for a specific day

void addEvent (string $day, string $title, [string $link = ''])

string $day: day
string $title: title
string $link: link

display (line 144)

Returns markup for displaying the calendar.

void display ()

dspDayCell (line 229)

Function to output the contents for a given day

void dspDayCell (string $day)

string $day: day

dspDayCellInfo (line 246)

Function to display cell information for a paricular day on the calendar

void dspDayCellInfo (string $day)

string $day: day

dspDayCells (line 177)

Displays all day cells for the month

void dspDayCells ()

dspDayNames (line 158)

Displays the row of day names.

void dspDayNames ()

generate_calendar (line 41)

Function to generate the calendar HTML widget

object generate_calendar (integer $yr, integer $mo, $da)

integer $yr: year
integer $mo: month
$da

getBriefMonthName (line 102)

Function to get the brief month name

void getBriefMonthName ()

getDaysEvents (line 290)

Returns an array of the events on a day.

void getDaysEvents (string $day)

string $day: day

getEndTime (line 78)

Function to get the end time of the calendar

void getEndTime ()

getFullMonthName (line 94)

Function to get the full month name

void getFullMonthName ()

getStartTime (line 70)

Function to get the start time of the calendar

void getStartTime ()

getYear (line 86)

Function to get the year of the calendar

void getYear ()

setDayNameFormat (line 136)

Function to set the day-name format on the calendar (any valid strftime format for display weekday names).

void setDayNameFormat (string $f)

string $f: Example: %a - abbreviated, %A - full, %u as number with 1==Monday

setMonth (line 126)

Function to set the month on the calendar

void setMonth ( $month)

$month

setTableWidth (line 110)

Function to set the calendar table width

void setTableWidth ( $w)

$w

setYear (line 118)

Function to set the year on the calendar

void setYear ( $year)

$year