Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
JS_Calendar Class Reference

Public Member Functions

 JS_Calendar ()
 
 changeSetting ($name, $value)
 
 init ()
 
 isInit ()
 
 paint ($prefix, $container_name='', $popup=false, $container_exists=false)
 

Data Fields

 $settings
 

Detailed Description

Definition at line 29 of file js_calendar.inc.

Member Function Documentation

changeSetting (   $name,
  $value 
)

Change a setting for the calendar

These settings are passed directly to the JS calendar object

public

Returns
void

Definition at line 67 of file js_calendar.inc.

init ( )

Initiaise the JS calendar if it has not already been

A global var is set to ensure this function only ever outputs content once. It can be called as many times as you want but it will only output content the first time (unless you get tricky with the global vars)

public

Returns
boolean

Definition at line 84 of file js_calendar.inc.

isInit ( )

Check if the JS Calendar has been initialised or not

public

Returns
boolean

Definition at line 108 of file js_calendar.inc.

Constructor

Definition at line 54 of file js_calendar.inc.

paint (   $prefix,
  $container_name = '',
  $popup = false,
  $container_exists = false 
)

Prints the JS calendar

Parameters
string$prefixa prefix to identify this calendar from others on the page
string$container_namethe id of the container (span, div, td etc) to hold the calendar, leave empty to use the default container
boolean$popupdisplay this calendar in a popup or not
boolean$container_existsif true, the container wont be created, it must already exist in the html this parameter is only used if $container_name is specified

public

Returns
void

Definition at line 129 of file js_calendar.inc.

Field Documentation

$settings
Initial value:
= Array(
'cssURL' => null,
'imageURL' => null,
'fadeit' => true,
'scrollit' => false,
'onDayClick' => null,
'onWeekClick' => null,
'onYearClick' => null,
'height' => 200,
'width' => 200,
'day_name_length' => 2,
'week_start' => 1,
)

Definition at line 36 of file js_calendar.inc.


The documentation for this class was generated from the following file: