KoolCalendar Class [PHP]

AjaxEnabledTop

bool AjaxEnabled

Get or set whether KoolCalendar use ajax feature. The ajax feature require KoolAjax to be registered. In ajax mode, date selection and month navigation will be done at server-side with the help of KoolAjax.

Default value : false

Show/Hide Code

<?php
...
	$cal->AjaxEnabled=true;//Use ajax
...
?>

Supported from version: 1.0.0.0

AjaxHandlePageTop

string AjaxHandlePage

Get or set the ajax handle page. Sometime, it is more convenient if calendar ajax-handle is seperated from your main page. By setting this property, KoolCalendar will do callback to the ajax handle page that you specified. In the ajax handle page, you setup, init and render KoolCalendar in the same way as you do with the calendar in your main page.

Show/Hide Code

<?php
...
	$cal->AjaxEnabled=true;
	$cal->AjaxHandlePage="calendar_handle.php";
...
?>

Supported from version: 1.0.0.0

AjaxLoadingImageTop

string AjaxLoadingImage

Get or set the loading image src. This image will be shown when calendar do callback.

Show/Hide Code

<?php
...
	$cal->AjaxEnabled=true;
	$cal->AjaxLoadingImage="KoolControls/KoolAjax/loading/1/gif"; // Set loading image.
...
?>

Supported from version: 1.0.0.0

ClientEventsTop

array ClientEvents

Get or set the client-side event handle.

Default value : 1

Show/Hide Code

<?php
...
	$cal->ClientEvents["OnSelect"]="Handle_OnSelect";
...
?>
 
<script type="text/javascript">
function Handle_OnSelect(sender,arg)
{
	var _selected_date = arg["Date"];
	alert(_selected_date);
}
</script>

Supported from version: 1.0.0.0

ClientModeTop

bool ClientMode

Get or set whether KoolCalendar use client mode. In client mode, the date selection and month navigation are performed at client.

Default value : false

Show/Hide Code

<?php
...
	$cal->ClientMode=true;//Use client mode 
...
?>

Supported from version: 1.0.0.0

DayNameFormatTop

string DayNameFormat

Get or set the day name format in header of KoolCalendar.

Default value : "Shortest"

Allowed values :

• "Shortest" :
• "Short" :
• "FirstLetter" :
• "FirstTwoLetters" :
• "Full" :

Show/Hide Code

<?php
...
	$cal->ShowOtherMonthsDays=false;//Not show other month days. 
...
?>

Supported from version: 1.0.0.0

EnableMultiSelectTop

bool EnableMultiSelect

Get or set whether KoolCalendar allow user to do multi-selection.

Default value : false

Show/Hide Code

<?php
...
	$cal->EnableMultiSelect=true;//Enable multi selection.
...
?>

Supported from version: 1.0.0.0

EnableQuickMonthSelectTop

bool EnableQuickMonthSelect

Get or set whether the quick month selection is enabled.

Default value : true

Show/Hide Code

<?php
...
	$cal->EnableQuickMonthSelect=false;//Disable the quick month selection.
...
?>

Supported from version: 1.0.0.0

EnableSelectTop

bool EnableSelect

Get or set whether KoolCalendar allow user to select date.

Default value : true

Show/Hide Code

<?php
...
	$cal->EnableSelect=false;//Not allow to select.
...
?>

Supported from version: 1.0.0.0

FastNavigationStepTop

int FastNavigationStep

Get or set the step numbers of fast navigation.

Default value : 3

Show/Hide Code

<?php
...
	$cal->FastNavigationStep=4;// Not showing the fast navigation buttons.
...
?>

Supported from version: 1.0.0.0

FirstDayOfWeekTop

int FirstDayOfWeek

Get or set the first day of week.

Default value : 0

Allowed values :

• 0 : Sunday
• 1 : Monday
• 2 : Tuesday
• 3 : Wednesday
• 4 : Thursday
• 5 : Friday
• 6 : Saturday

Show/Hide Code

<?php
...
	$cal->FirstDayOfWeek=1;//Monday is first day of week.
...
?>

Supported from version: 1.0.0.0

FocusedDateTop

int FocusedDate

Get or set focused date in KoolCalendar. By setting this date, we will let KoolCalendar know the month to be shown.

Show/Hide Code

<?php
...
	$cal->FocusedDate=mktime(0,0,0,12,15,2009);// Set focused date in 12/15/2009
...
?>

Supported from version: 1.0.0.0

HeightTop

string Height

Get or set the height of KoolCalendar.

Show/Hide Code

<?php
...
	$cal->Height="300px";
...
?>

Supported from version: 1.0.0.0

idTop

string id

Get or set the id for KoolCalendar. This id will be use as variable name of KoolCalendar at client-side.

Show/Hide Code

<?php		
	$cal->id="cal";//We usuall use the same id name with server-side for better reference. 
?>

Supported from version: 1.0.0.0

LocalizationTop

Localization Localization

Set the localization of KoolCalendar.

Show/Hide Code

<?php
...
	$cal->Localization->Load("KoolControls/KoolCalendar/localization/en.xml");
...
?>

Supported from version: 1.0.0.0

MonthLayoutTop

string MonthLayout

Get or set the layout of month.

Default value : "7x6"

Allowed values :

• "7x6" : Display in 7x6 table
• "14x3" : Display in 14x3 table
• "21x2" : Display in 21x2 table

Show/Hide Code

<?php
...
	$cal->MonthLayout="14x3";
...
?>

Supported from version: 1.0.0.0

MultiViewColumnsTop

int MultiViewColumns

Get or set the number of columns of KoolCalendar in multiview mode.

Default value : 1

Show/Hide Code

<?php
...
	$cal->MultiViewColumns=2; // KoolCalendar shows 2 columns.
...
?>

Supported from version: 1.0.0.0

MultiViewRowsTop

int MultiViewRows

Get or set the number of rows of KoolCalendar in multiview mode.

Default value : 1

Show/Hide Code

<?php
...
	$cal->MultiViewRows=2;//KoolCalendar shows 2 rows.
...
?>

Supported from version: 1.0.0.0

NavigateAnimationTop

Animation NavigateAnimation

Get or set the settings of navigation animation.

Show/Hide Code

<?php
...
	$cal->NavigateAnimation->Type="Linear";// Linear animation.
	$cal->NavigateAnimation->Duration=200;// 200ms
...
?>

Supported from version: 1.0.0.0

OrientationTop

string Orientation

Get or set the rendering orientation of month.

Allowed values :

• "Horizontal" : Render month days horizontally.
• "Vertical" : Render month days vertically.

Show/Hide Code

<?php
...
	$cal->Orientation="Vertical";
...
?>

Supported from version: 1.0.0.0

RangeMaxDateTop

int RangeMaxDate

Get or set max date in KoolCalendar. User may not able to select the date after the RangeMaxDate.

Show/Hide Code

<?php
...
	//Set the date range from 12/15/2009 to 6/15/2010
	$cal->RangeMinDate=mktime(0,0,0,12,15,2009);
	$cal->RangeMaxDate=mktime(0,0,0,6,15,2010);	
...
?>

Supported from version: 1.0.0.0

RangeMinDateTop

int RangeMinDate

Get or set min date in KoolCalendar. User may not able to select the date prior to RangeMinDate.

Show/Hide Code

<?php
...
	//Set the date range from 12/15/2009 to 6/15/2010
	$cal->RangeMinDate=mktime(0,0,0,12,15,2009);
	$cal->RangeMaxDate=mktime(0,0,0,6,15,2010);	
...
?>

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

Get or set the path to folder which contains KoolCalendar script.

Show/Hide Code

<?php				
	$cal = new KoolCalendar("cal");
	$cal->scriptFolder = "KoolControls/KoolCalendar";
?>

Supported from version: 1.0.0.0

SelectedDatesTop

array SelectedDates

Get or set the selected dates in KoolCalendar. The information of selected dates will be accessed or set after calendar is initiated.

Show/Hide Code

<?php
...
	$cal->Init();
	...
	//Get the selected dates.
	for($i=0;$i<count($cal->SelectedDates);$i++)
	{
		echo $cal->SelectedDates[$i];
	}
 
	...
	//To set the selected dates, you can do as follow:
	$cal->SelectedDates = array(mktime(0,0,0,12,15,2009),mktime(0,0,0,11,7,2009));	
...
?>

Supported from version: 1.0.0.0

ShowColumnHeaderTop

bool ShowColumnHeader

Get or set whether KoolCalendar show column header.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowColumnHeader=false;//Not show column header.
...
?>

Supported from version: 1.0.0.0

ShowDayCellToolTipsTop

bool ShowDayCellToolTips

Get or set whether KoolCalendar show tooltip when mouse hovers the day.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowDayCellToolTips=false;//Not show tooltip.
...
?>

Supported from version: 1.0.0.0

ShowFastNavigationTop

bool ShowFastNavigation

Get or set where KoolCalendar show fast navigation buttons.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowFastNavigation=false;// Not showing the fast navigation buttons.
...
?>

Supported from version: 1.0.0.0

ShowNavigationTop

bool ShowNavigation

Get or set where KoolCalendar show navigation buttons.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowNavigation=false;// Not showing the navigation buttons.
...
?>

Supported from version: 1.0.0.0

ShowOtherMonthsDaysTop

bool ShowOtherMonthsDays

Get or set whether KoolCalendar show other month days in month table.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowOtherMonthsDays=false;//Not show other month days. 
...
?>

Supported from version: 1.0.0.0

ShowRowHeaderTop

bool ShowRowHeader

Get or set whether KoolCalendar show row header.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowRowHeader=false;//Not show row header.
...
?>

Supported from version: 1.0.0.0

ShowTodayTop

bool ShowToday

Get or set whether KoolCalendar highlight today date.

Default value : true

Show/Hide Code

<?php
...
	$cal->ShowToday=false;//Not show today
...
?>

Supported from version: 1.0.0.0

ShowViewSelectorTop

bool ShowViewSelector

Get or set whether KoolCalendar show the view selector.

Default value : false

Show/Hide Code

<?php
...
	$cal->ShowViewSelector=false;//Not show other month days. 
...
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolCalendar

Show/Hide Code

<?php 
	$cal->styleFolder="KoolControls/KoolCalendar/styles/default";//Use the "default" style 
?>

Supported from version: 1.0.0.0

UseColumnHeadersAsSelectorsTop

bool UseColumnHeadersAsSelectors

Get or set whether KoolCalendar use column header as date selector.

Default value : true

Show/Hide Code

<?php
...
	$cal->UseColumnHeadersAsSelectors=false;//Not column header as selector.
...
?>

Supported from version: 1.0.0.0

UseRowHeadersAsSelectorsTop

bool UseRowHeadersAsSelectors

Get or set whether KoolCalendar use row header as date selector.

Default value : true

Show/Hide Code

<?php
...
	$cal->UseRowHeadersAsSelectors=false;//Not use header as date selector.
...
?>

Supported from version: 1.0.0.0

ViewSelectorTextTop

string ViewSelectorText

Get or set the text of view selector.

Default value : "x"

Show/Hide Code

<?php
...
	$cal->ViewSelectorText="s";// change "x" selector to "s" 
...
?>

Supported from version: 1.0.0.0

WidthTop

string Width

Get or set the width of KoolCalendar.

Show/Hide Code

<?php
...
	$cal->Width="300px";
...
?>

Supported from version: 1.0.0.0

InitTop

void Init()

Initiate calendar. This function should be called before calendar Render() function.

Show/Hide Code

<?php
	$cal = new KoolCalendar("cal");
	...
	$cal->Init();
	...
	echo $cal->Render(); 
?>

Supported from version: 1.0.0.0

AddSpecialDateTop

void AddSpecialDate(int $date, [bool $disable], [string $css_class], [string $tooltip])

Add special dates to calendar.

Show/Hide Code

<?php
	...
	$cal->AddSpecialDate(mktime(0,0,0,11,5,2010),false,"cssRed","This is my birthday!");
	// Make the date May 11th, 2010:
	//	- Selectable, not disabled.
	//	- The cssRed class is applied. The cssRed class may contain css rules to make the date distinguished.
	//	- The date will have tooltip "This is my birthday!" when user hover the date.
	...
?>

Supported from version: 1.1.0.0

RenderTop

void Render()

Render the KoolCalendar

Show/Hide Code

<body>
	<?php echo 	$cal->Render(); ?>
</body>

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolCalendar.

Show/Hide Code

<head>
    <?php echo $cal->RegisterScript(); ?>
</head>

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolCalendar

Show/Hide Code

<head>
    <?php echo  $cal->RegisterCSS();?>
</head>

Supported from version: 1.0.0.0

RenderCalendarTop

string RenderCalendar()

Return html content of KoolCalendar body

Show/Hide Code

<body>
    <?php echo $cal->RenderCalendar();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolCalendar

Show/Hide Code

<script type="text/javascript">
    <?php echo $cal->StartupScript();?>
</script>

Supported from version: 1.0.0.0