Active Calendar Project Documentation

Active Calendar Project v1.2.0 Documentation

Contents

activeCalendar() class methods
activeCalendarWeek() subclass methods
Calendar layout

About the Active Calendar Project

Active Calendar is a set of a main PHP class and subclass(es), that generate calendars (year, month or week view) as a HTML Table (XHTML-Valid).

can be static (without any links)
can optionally have navigation controls
can optionally have a date picker control
can optionally have linkable days (url or javascript)
can optionally have 'event days' with 'event links' and own layout
can optionally have 'event content' with 'links' and own layout
can optionally have a week number column with 'links' and own layout
support different GMT zones for the current date calculation
support month and day names, depending on your language
can be configured using CSS
do not require Javascript to be displayed or navigated (server side generation)
can be generated with just 2-3 lines of code

Active Calendar is based on the PHP native date functions (default) and supports optionally the ADOdb Date Library.

Using PHP native date functions: 1902 - 2037 (UNIX) and 1971 - 2037 (Windows)
Using ADOdb Date Library: 100 - 3000 and later [ limited by the computation time of adodb_mktime() ] on both UNIX and Windows. To use the ADOdb Date Library just include it in your scripts. The Active Calendar class will use the library functions automatically.

How to use the Active Calendar

activeCalendar() class methods overview (main class):
$cal = new activeCalendar([$year,$month,$day,$gmt_zone]);

Create first a new object of the class. The parameters $year, $month and $day are optional. If these parameters are not set, the current year, month and day will be passed to the program. The parameter $year should have the form "yyyy" e.g "2005" or "1996", the parameter $month should have the form "m" e.g "1" for January or "10" for October and the parameter $day should have the form "d" e.g "4" for the 4th month day or "24" for the 24th month day. So for the date e.g 7th January 2005 please set $cal = new activeCalendar("2005","1","7"). The parameter $gmt_zone is optional as well. Use this parameter to set the GMT (Greenwich Mean Time) zone for the current date calculation (e.g 9 for Osaka Japan, 2 for Athens Greece, - 5 for New York USA). If $gmt_zone is not set, the server local time will be used.

$cal->enableMonthNav([$link,$arrowBack,$arrowForw]);

Call this method, if you want the generated calendar to have month navigation controls (e.g "previous month" and "next month"). The parameter $link is optional. You can use this parameter to set the url for the calendar links (e.g "mycalendar.php" or "mycalendar.php?mode=4&item=test", if you need more complex urls). You should modify the private method mkUrl(), if you want to change the general structure of the generated links. The parameters $arrowBack and $arrowForw are optional as well: they set other month navigation controls, than the ones set in the configuration (an image link can be set too).

$cal->enableYearNav([$link,$arrowBack,$arrowForw]);

Call this method, if you want the generated calendar to have year navigation controls (e.g "previous year" and "next year"). The parameter $link is optional. You can use this parameter to set the url for the calendar links (e.g "mycalendar.php" or "mycalendar.php?mode=4&item=test", if you need more complex urls). You should modify the private method mkUrl(), if you want to change the general structure of the generated links. The parameters $arrowBack and $arrowForw are optional as well: they set other year navigation controls, than the ones set in the configuration (an image link can be set too).

$cal->enableDatePicker([$startYear,$endYear,$link,$button]);

Call this method, if you want the generated month calendar to have a date picker control. The parameters $startYear and $endYear define the range of the years, that can be selected (e.g $startYear=2000, $endYear=2010). This range is limited by the private class variables $startYear and $endYear. Please modify them according to your configuration. The parameter $link is optional. You can use this parameter to set the url for the calendar links (e.g "mycalendar.php" or "mycalendar.php?mode=4&item=test", if you need more complex urls). You should modify the private method mkUrl(), if you want to change the general structure of the generated links. The parameter $button is optional as well: it sets some other value for the date picker submit button, than the one set in the configuration.

$cal->enableDayLinks([$link,$javaScript]);

Call this method, if you want the generated calendar to have linkable dates. The parameter $link is optional. You can use this parameter to set the url for the calendar links (e.g "mycalendar.php" or "mycalendar.php?mode=4&item=test", if you need more complex urls). You should modify the private method mkUrl(), if you want to change the general structure of the generated links. The parameter $javaScript is optional as well. You can use this parameter to set a JavaScript function instead of an url for the calendar links. So if you set $cal->enableDayLinks(false,"selectDate"), this link will be created on e.g 27 May 2007: ..href="javascript:selectDate(2007,5,27)".. The content of the Javascript function 'selectDate' will not be created by the class. You should develop it according to your needs.

$cal->enableWeekNum([$title,$link,$javaScript]);

Call this method, if you want the generated calendar to contain a week number column. The optional parameter $title can be used to set the title of the generated column. The parameter $link is optional as weel. You can use this parameter to make the generated week numbers linkable and to set the url for the links (e.g "mycalendar.php" or "mycalendar.php?mode=4&item=test", if you need more complex urls). You should modify the private method mkWeekNum(), if you want to change the general structure of the generated links. The parameter $javaScript is optional as well. You can use this parameter to set a JavaScript function instead of an url for the week number links. So if you set $cal->enableWeekNum("Week",false,"selectWeek"), this link will be created on e.g 23 May 2007 (21st week): ..href="javascript:selectWeek(2007,21)".. The content of the Javascript function 'selectWeek' will not be created by the class. You should develop it according to your needs.

$cal->setMonthNames($monthNamesArray);

Call this method, if you want the class generate different names for the calendar months, than the ones set in the configuration. The parameter $monthNamesArray must be an array of 12 month names starting with January.

$cal->setDayNames($dayNamesArray);

Call this method, if you want the class generate different names for the calendar weekdays, than the ones set in the configuration. The parameter $dayNamesArray must be an array of 7 day names starting with Sunday.

$cal->setFirstWeekDay($daynum);

Call this method, if you want to set another first day of the week, than the one set in the configuration. The class currently supports only Sunday and Monday as starting week days. Set the parameter $daynum=0 for Sunday or $daynum=1 for Monday.

$cal->setEvent($year,$month,$day,[$id,$eventUrl]);

Call this method, if you want the class to create an HTML td class=$id on the date specified by the parameters $year, $month, $day. You can configure every 'event date' in your CSS, so that it would have e.g a different background color. The parameter $id is optional. If you do not set an $id, a default HTML class='event' will be generated. The parameter $eventUrl is optional as well: If you set an $eventUrl, an event specific link (..href='$eventUrl'..) will be generated on the 'event date', even if the method $cal->enableDayLinks($link) was not called.

$cal->setEventContent($year,$month,$day,$content,[$contentUrl,$id]);

Call this method, if you want the class to create a new HTML table within the date specified by the parameters $year, $month, $day. The parameter $content can be a string or an array. If $content is a string, then the new generated table will contain one row with the value of $content. If it is an array, the generated table will contain as many rows as the array length and each row will contain the value of each array item. The parameter $contentUrl is optional: If you set a $contentUrl, an event content specific link (..href='$contentUrl'..) will be generated in the 'event content' table row(s), even if the method $cal->enableDayLinks($link) was not called. The parameter $id is optional as well: if you set an $id, a HTML class='$id' will be generated for each event content (default: 'eventcontent').

$cal->showMonth([$showNoMonthDays]);

This method will generate the html string of the month calendar. You can display the calendar by "print $cal->showMonth()". This method calls several private class functions, that create each tr tag of the generated table. So if you would like to change the table structure, you could simply modifiy the order, that these private functions are called (mkMonthHead() must remain first and mkMonthFoot() must remain last though). The parameter $showNoMonthDays is optional: if it is set true, days that do not belong to the current month will be displayed in the calendar (default: false). Please note that these days will not contain any events or event contents!.

$cal->showYear([$columns,$startMonth]);

This method will generate the html string of the year calendar. You can display the calendar by "print $cal->showYear()". This method calls several private class functions, that create each tr tag of the generated table. So if you would like to change the table structure, you could simply modify the order, that these private functions are called (mkYearHead() must remain first and mkYearFoot() must remain last though). The parameter $columns is optional: it sets the number of the generated months in each row of the year calendar (default: 4). The parameter $startMonth is optional as well: it sets the starting month in the year calendar (default: January).

activeCalendarWeek() class methods overview (subclass):
$cal = new activeCalendarWeek([$year,$month,$day,$gmt_zone]);

This is the constructor of the subclass. It accepts the same parameters as the constructor of the main class activeCalendar() and creates a new class object.

$cal->enableDayLinks([$link,$javaScript]);

This method calls the same method of the parent class (see above).

$cal->enableWeekNum([$title,$link,$javaScript]);

This method calls the same method of the parent class (see above).

$cal->setMonthNames($monthNamesArray);

This method calls the same method of the parent class (see above).

$cal->setDayNames($dayNamesArray);

This method calls the same method of the parent class (see above).

$cal->setFirstWeekDay($daynum);

This method calls the same method of the parent class (see above).

$cal->setEvent($year,$month,$day,[$id,$eventUrl]);

This method calls the same method of the parent class (see above).

$cal->setEventContent($year,$month,$day,$content,[$contentUrl,$id]);

This method calls the same method of the parent class (see above).

$cal->showWeeks([$numberOfWeeks]);

This method will generate the html string of the week calendar. You can display the calendar by "print $cal->showWeeks()". This method calls several private class functions, that create each tr tag of the generated table. The parameter $numberOfWeeks is optional: it sets the number of the generated week rows (default: 1). The week starts on the date set in the constructor method activeCalendarWeek().

$cal->showWeeksByID([$weekID,$numberOfWeeks]);

This method will generate the html string of the week calendar. You can display the calendar by "print $cal->showWeeksByID()". This method calls several private class functions, that create each tr tag of the generated table. The parameter $weekID is optional: the week calendar starts with the week row, that has the same week number of the year as set in the $weekID (default: 1 = first week of the year). The parameter $numberOfWeeks is optional as well: it sets the number of the generated week rows (default: 1).

Calendar layout:

The layout of the generated calendar can be configured with CSS. The Active Calendar Class returns html tags with various classes, which can be used for the layout configuration. Here is a table with the classes of the html tags, generated by the Active Calendar Class and their configuration variables. To avoid conflicts with your existing CSS, the names of the generated classes can be changed in the Active Calendar class configuration.

Configuration variable HTML Class HTML TAG

$cssYearTable year table tag: calendar year

$cssYearTitle yearname td tag: calendar year title

$cssYearNav yearnavigation td tag: calendar year navigation

$cssMonthTable month table tag: calendar month

$cssMonthTitle monthname td tag: calendar month title

$cssMonthNav monthnavigation td tag: calendar month navigation

$cssWeekDay dayname td tag: calendar weekdays

$cssWeekNumTitle weeknumtitle td tag: week number title

$cssWeekNum weeknum td tag: week number

$cssWeeksTable week table tag: calendar week (subclass activeCalendarWeek)

$cssMonthWeek monthweek td tag: month row in the week calendar (subclass activeCalendarWeek)

$cssPicker datepicker td tag: date picker

$cssPickerForm datepickerform form tag: date picker form

$cssPickerMonth monthpicker select tag: month picker

$cssPickerYear yearpicker select tag: year picker

$cssPickerButton pickerbutton input (submit) tag: date picker button

$cssMonthDay monthday td tag: days, that belong to the current month

$cssNoMonthDay nomonthday td tag: days, that do not belong to the current month

$cssToday today td tag: the current day

$cssSelecDay selectedday td tag: the selected day

$cssSunday sunday td tag: all Sundays

$cssSaturday saturday td tag: all Saturdays

$cssEvent event td tag: Event day set by setEvent(). Multiple classes can be generated (e.g 'meeting')

$cssPrefixSelecEvent selected td tag: Event day set by setEvent(), when it is selected. This prefix will be added to the event class name (e.g 'selectedevent'). Multiple classes (e.g 'selectedmeeting') can be generated

$cssPrefixTodayEvent today td tag: Event day set by setEvent(), when it is the current day. This prefix will be added to the event class name (e.g 'todayevent'). Multiple classes (e.g 'todaymeeting') can be generated

$cssEventContent eventcontent table tag : Event content set by setEventContent(). Multiple classes can be generated (e.g 'meetingcontent')

Quick installation

1. Edit the configuration section in Active Calendar Class file activecalendar.php, if you want to change the default configuration. The following public variables can be modified:

********* Month names *********
[This is just the default configuration. You may set the month names by calling the method setMonthNames()]

var $jan = "Name to display for January";

var $feb = "Name to display for February";

var $mar = "Name to display for March";

var $apr = "Name to display for April";

var $may = "Name to display for May";

var $jun = "Name to display for June";

var $jul = "Name to display for July";

var $aug = "Name to display for August";

var $sep = "Name to display for September";

var $oct = "Name to display for October";

var $nov = "Name to display for November";

var $dec = "Name to display for December";

******** Weekday names ********
[This is just the default configuration. You may set the day names by calling the method setDayNames()]

var $sun = "Name to display for Sunday";

var $mon = "Name to display for Monday";

var $tue = "Name to display for Tuesday";

var $wed = "Name to display for Wednesday";

var $thu = "Name to display for Thursday";

var $fri = "Name to display for Friday";

var $sat = "Name to display for Saturday";

****** Navigation controls ******
[This is just the default configuration. You may set the controls by calling the methods enableYearNav(), enableMonthNav() and enableDatePicker()]

var $yearNavBack = "Previus year control (it could be an image link e.g.:<img src=\"leftarrow.gif\">";

var $yearNavForw = "Next year control (it could be an image link e.g.:<img src=\"rightarrow.gif\">";

var $monthNavBack = "Previus month control (it could be an image link e.g.:<img src=\"leftarrow.gif\">";

var $monthNavForw = "Next month control (it could be an image link e.g.:<img src=\"rightarrow.gif\">";

var $selBtn = "Date picker button value";

****** Day links variables ******

var $yearID = "Name of the year GET VARIABLE for the links";

var $monthID = "Name of the month GET VARIABLE for the links";

var $dayID = "Name of the day GET VARIABLE for the links";

var $weekID = "Name of the week number GET VARIABLE for the links";

******** Monthview display ********

var $monthYearDivider = "Divider between month and year in the month`s title e.g '/'";

var $startOnSun = "True: first day of week is Sunday, False: first day of week is Monday";

var $crSunClass = "True: creates a HTML class 'sunday' on every Sunday";

var $crSatClass = "True: creates a HTML class 'saturday' on every Saturday";

******** Yearview display ********

var $rowCount = "Number of months in a row in yearview";
[This is just the default configuration. You may set the number of months in a row by calling the method showYear()]

You should leave the other variables in the class file unchanged.

2. Upload the Active Calendar files activecalendar.php and activecalendarweek.php on your server and include them in your scripts.

The layout of the generated calendar can be configured with CSS. The Active Calendar Class returns html tags with various classes, which can be used for the layout configuration. Here is a table with the classes of the html tags, generated by the Active Calendar Class and their configuration variables. To avoid conflicts with your existing CSS, the names of the generated classes can be changed in the Active Calendar class configuration.
Configuration variable	HTML Class	HTML TAG
$cssYearTable	year	table tag: calendar year
$cssYearTitle	yearname	td tag: calendar year title
$cssYearNav	yearnavigation	td tag: calendar year navigation
$cssMonthTable	month	table tag: calendar month
$cssMonthTitle	monthname	td tag: calendar month title
$cssMonthNav	monthnavigation	td tag: calendar month navigation
$cssWeekDay	dayname	td tag: calendar weekdays
$cssWeekNumTitle	weeknumtitle	td tag: week number title
$cssWeekNum	weeknum	td tag: week number
$cssWeeksTable	week	table tag: calendar week (subclass activeCalendarWeek)
$cssMonthWeek	monthweek	td tag: month row in the week calendar (subclass activeCalendarWeek)
$cssPicker	datepicker	td tag: date picker
$cssPickerForm	datepickerform	form tag: date picker form
$cssPickerMonth	monthpicker	select tag: month picker
$cssPickerYear	yearpicker	select tag: year picker
$cssPickerButton	pickerbutton	input (submit) tag: date picker button
$cssMonthDay	monthday	td tag: days, that belong to the current month
$cssNoMonthDay	nomonthday	td tag: days, that do not belong to the current month
$cssToday	today	td tag: the current day
$cssSelecDay	selectedday	td tag: the selected day
$cssSunday	sunday	td tag: all Sundays
$cssSaturday	saturday	td tag: all Saturdays
$cssEvent	event	td tag: Event day set by setEvent(). Multiple classes can be generated (e.g 'meeting')
$cssPrefixSelecEvent	selected	td tag: Event day set by setEvent(), when it is selected. This prefix will be added to the event class name (e.g 'selectedevent'). Multiple classes (e.g 'selectedmeeting') can be generated
$cssPrefixTodayEvent	today	td tag: Event day set by setEvent(), when it is the current day. This prefix will be added to the event class name (e.g 'todayevent'). Multiple classes (e.g 'todaymeeting') can be generated
$cssEventContent	eventcontent	table tag : Event content set by setEventContent(). Multiple classes can be generated (e.g 'meetingcontent')