This module requires the Date::Calc module, which is available from
CPAN.
* 'dbname' (name of database to use, required if you wish to use a
database)
* 'dbuser' (database user, default 'nobody')
* 'dbpass' (database user password, default '')
* 'dbcalendar' (database calendar name, default '')
* 'dbclient' (database calendar client name, default '')
* 'dbhost' (database host name, default '')
# Examples:
# Create a calendar for this month.
$cal = new HTML::CalendarMonthSimple(); # not persistant
# One for a specific month/year
$cal = new HTML::CalendarMonthSimple('month'=>2,'year'=>2000); # not persistant
# One for "the current month" in 1997
$cal = new HTML::CalendarMonthSimple('year'=>1997); # not persistant
# One for a specific month/year, to use database specified
$cal = new HTML::CalendarMonthSimple('month'=>2,'year'=>2000,'dbname'=>'test','dbuser'=>postgres,'dbcalendar'=>'testcal','dbclient'=>'testClient');
* 'eventname' (name of event)
* 'eventdesc' (event description, optional)
* 'eventlink' (event link, optional)
* 'eventtime' (event time, optional)
=head2 addevent(DATE,STRING)
# Examples:
# The cell for the 15th of the month will now say something.
$cal->setcontent(15,"An Important Event!");
# Later down the program, we want the content to be boldfaced.
$foo = "<b>" . $cal->getcontent(15) . "</b>";
$cal->setcontent(15,$foo);
# Or we could get extra spiffy:
$cal->setcontent(15,"<b>" . $cal->getcontent(15) . "</b>");
# addcontent() does not clober existing content.
# Also, if you setcontent() to '', you've deleted the content.
$cal->setcontent(16,'');
$cal->addcontent(16,"<p>Hello World</p>");
$cal->addcontent(16,"<p>Hello Again</p>");
print $cal->getcontent(16); # Prints 2 sentences
# Padded and decimal numbers may be used, as well:
$cal->setcontent(3.14159,'Third of the month');
$cal->addcontent('00003.0000','Still the third');
$cal->getcontent('3'); # Gets the 2 sentences
# The second Sunday of May is some holiday or another...
$cal->addcontent('2sunday','Some Special Day') if ($cal->month() == 5);
# So is the third wednesday of this month
$cal->setcontent('3WedNEsDaY','Third Wednesday!');
# What's scheduled for the second Friday?
$cal->getcontent('2FRIDAY');
# Every Wednesday and Friday of this month...
$cal->addcontent('wednesdays','Every Wednesday!');
$cal->getcontent('Fridays');
# Examples:
print $cal->as_HTML();
print $cal->as_HTML_list('editurl'=>'editcal.cgi', 'addurl'=>'addcal.cgi');
Two optional arguments may be passed, in order to ease the integration
of adminitrative front-ends: 'editurl' (Will add a [edit] link in each
day's cell to specified url like so-
http://editurl?date=month_day_year&calid=calendarid.) 'addurl' (Will add
a [add] link in each day's cell to specified url like so-
http://addurl?date=month_day_year&calid=calendarid.)
* 'border' (size of calendar border, integer)
* 'width' (width of calendar, should be in pixels or %)
* 'bgcolor' (background color of calendar)
* 'weekdaycolor' (background color of weekday cells)
* 'weekendcolor' (background color of weekend cells)
* 'todaycolor' (background color of today's cell)
* 'bordercolor' (border color of calendar)
* 'weekdaybordercolor' (border color of weekday cells)
* 'weekendbordercolor' (border color of weekend cells)
* 'todaybordercolor' (border color of today's cell)
* 'contentcolor' (color of cell content)
* 'weekdaycontentcolor' (color of weekday cell content)
* 'weekendcontentcolor' (color of weekend cell content)
* 'todaycontentcolor' (color of today's cell content)
* 'headercolor' (background color of header cell)
* 'weekdayheadercolor' (background color of weekday header cell)
* 'weekendheadercolor' (background color of weekend header cell)
* 'header' (header text, defaults to 'Month Year' if not specified or
'')
* 'cellalignment' (alignment of text within cells, defaults to left,
other valid values include right, center)
* 'eventid' (id of specific event, required)
* 'eventname' (name of event)
* 'eventdesc' (event description)
* 'eventlink' (event link)
* 'eventtime' (event time)
Useful as a function to be used in admin tools.
If a value is not specified, the current value is returned. If a value
is specified, the border value is changed and the new value is returned.
The width value can be either an integer (e.g. 600) or a percentage
string (e.g. "80%"). Most web browsers take an integer to be the table's
width in pixels and a percentage to be the table width relative to the
screen's width. The default width is "100%".
If a value is not specified, the current value is returned. If a value
is specified, the border value is changed and the new value is returned.
# Examples:
$cal->width(600); # absolute pixel width
$cal->width("100%"); # percentage of screen size
If no value is specified, the current value is returned.
The date numbers are shown in boldface, normal size font. If you want to
change this, consider setting showdatenumbers() to 0 and using
setcontent()/addcontent() instead.
If no value is specified, the current value is returned.
Any value can be used, if you think the web browser will find it
interesting. Some useful alignments are: left, right, center, top, and
bottom,
By default, cells are aligned to the left.
The header() method allows you to set the header to whatever you like.
If no new header is specified, the current header is returned.
If the header is set to an empty string, then no header will be printed
at all. (No, you won't be stuck with a big empty cell!)
# Example:
# Set the month/year header to something snazzy.
my($y,$m) = ( $cal->year() , $cal->monthname() );
$cal->header("<center><font size=+2 color=red>$m $y</font></center>\n\n");
The bgcolor defines the color of all cells. The weekdaycolor overrides
the bgcolor for weekdays (Monday through Friday), the weekendcolor
overrides the bgcolor for weekend days (Saturday and Sunday), and the
todaycolor overrides the bgcolor for today's date. (Which may not mean a
lot if you're looking at a calendar other than the current month.)
The weekdayheadercolor overrides the bgcolor for the weekday headers
that appear at the top of the calendar if showweekdayheaders() is true,
and weekendheadercolor does the same thing for the weekend headers. The
headercolor overrides the bgcolor for the month/year header at the top
of the calendar.
The colors of the cell borders may be set: bordercolor determines the
color of the calendar grid's outside border, and is the default color of
the inner border for individual cells. The inner bordercolor may be
overridden for the various types of cells via weekdaybordercolor,
weekendbordercolor, and todaybordercolor.
Finally, the color of the cells' contents may be set with contentcolor,
weekdaycontentcolor, weekendcontentcolor, and todaycontentcolor. The
contentcolor is the default color of cell content, and the other methods
override this for the appropriate days' cells.
# Example:
$cal->bgcolor('white'); # Set the default cell color
$cal->bordercolor('green'); # Set the default border color
$cal->contentcolor('black'); # Set the default content color
$cal->headercolor('yellow'); # Set the color of the Month+Year header
$cal->weekdayheadercolor('orange'); # Set the color of weekdays' headers
$cal->weekendheadercolor('pink'); # Set the color of weekends' headers
$cal->weekendcolor('palegreen'); # Override weekends' cell color
$cal->weekendcontentcolor('blue'); # Override weekends' content color
$cal->todaycolor('red'); # Override today's cell color
$cal->todaycontentcolor('yellow'); # Override today's content color
print $cal->as_HTML; # Print a really ugly calendar!
HTML::CalendarMonthDB is based on HTML::CalendarMonthSimple by Gregor
Mosheh <stigmata@blackangel.net>. Many additions and modifications were
performed by Matt Vella (the_mcv@yahoo.com) for About.com/Primedia.
HTML::CalendarMonth was written and is copyrighted by Matthew P. Sisk
<sisk@mojotoad.com> and provided inspiration for the module's interface
and features. Frankly, the major inspiration was the difficulty and
unnecessary complexity of the interface. (Laziness is a virtue.)
HTML::CalendarMonthSimple was written by Gregor Mosheh
<stigmata@blackangel.net> None of Matt Sisk's code appears herein.
This would have been extremely difficult if not for Date::Calc. Many
thanks to Steffen Beyer <sb@engelschall.com> for a very fine set of
date-related functions!
Danny J. Sohier <danny@gel.ulaval.ca> provided many of the color
functions.
Bernie Ledwick <bl@man.fwltech.com> provided base code for the today*()
functions, and for the handling of cell borders.
