Skip Navigation

UNL_UCBCN_Frontend API Documentation

Developers, developers, developers, devel…

Class UNL_UCBCN_Frontend_MonthWidget

Description
Description | Vars (details) | Methods (details)

Class defines a month widget, basically a table with 30 boxes representing the days in the month. Days which have events will be selected.

Located in /UNL/UCBCN/Frontend/MonthWidget.php (line 28) 

UNL_UCBCN
   |
   --UNL_UCBCN_Frontend_MonthWidget
Variable Summary
Description | Vars (details) | Methods (details)
UNL_UCBCN_Calendar $calendar
string $caption
int $month
string $tbody
string $thead
int $year
Method Summary
Description | Vars (details) | Methods (details)
UNL_UCBCN_Frontend_MonthWidget __construct (int $y, int $m, [UNL_UCBCN_Calendar $calendar = null])
an dailyEventCount (Calendar_Month $month)
array findOngoingEvents (Calendar_Month $month)
string getCacheKey ()
void preRun ([bool $cache_hit = false])
void run ()
Variables
Description | Vars (details) | Methods (details)
UNL_UCBCN_Calendar $calendar (line 36)

Calendar UNL_UCBCN_Calendar Object

  • access: public
string $caption (line 57)

Caption for the month widget.

  • access: public
int $month (line 50)

Month for this month widget.

  • access: public
string $tbody (line 71)

Body for the table

  • access: public
string $thead (line 64)

Header for the table

  • access: public
int $year (line 43)

Year for this month widget

  • access: public
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 81)

This function constructs the month widget and populates the heading, caption, footer and body for the MonthWidget.

  • access: public
UNL_UCBCN_Frontend_MonthWidget __construct (int $y, int $m, [UNL_UCBCN_Calendar $calendar = null])
  • int $y: Year
  • int $m: Month
  • UNL_UCBCN_Calendar $calendar: Calendar to prepare a month widget for.
dailyEventCount (line 195)

Determines the days of this month with events.

  • return: array with values representing the days with events.
  • access: public
an dailyEventCount (Calendar_Month $month)
  • Calendar_Month $month: Month to find events in.
findOngoingEvents (line 222)

This function finds ongoing events for the given month.

  • access: public
array findOngoingEvents (Calendar_Month $month)
  • Calendar_Month $month: Month to find ongoing events for.
getCacheKey (line 93)

Returns a string identifying this month widget.

  • return: A string of the form monthwidget_2006-05-12_1
  • access: public
string getCacheKey ()
preRun (line 109)

Runs before any output is sent or object is built.

  • access: public
void preRun ([bool $cache_hit = false])
  • bool $cache_hit: True if cached output is ready to be sent, or false.
run (line 120)

This function populates the month widget... checks for each day of this month whether the day has events.

  • access: public
void run ()

Documentation generated on Wed, 12 Aug 2009 13:00:47 -0500 by phpDocumentor 1.4.2