NAME HTML::CalendarMonthSimple - Perl Module for Generating HTML Calendars SYNOPSIS use HTML::CalendarMonthSimple; $cal = new HTML::CalendarMonthSimple('year'=>2001,'month'=>2); $cal->width('50%'); $cal->border(10); $cal->header('Text at the top of the Grid'); $cal->setcontent(14,"Valentine's Day"); $cal->setdatehref(14, 'http://localhost/'); $cal->addcontent(14,"
Don't forget to buy flowers."); $cal->addcontent(13,"Guess what's tomorrow?"); $cal->bgcolor('pink'); print $cal->as_HTML; DESCRIPTION HTML::CalendarMonthSimple is a Perl module for generating, manipulating, and printing a HTML calendar grid for a specified month. It is intended as a faster and easier-to-use alternative to HTML::CalendarMonth. This module requires the Date::Calc module, which is available from CPAN if you don't already have it. INTERFACE METHODS new(ARGUMENTS) Naturally, new() returns a newly constructed calendar object. Recognized arguments are 'year' and 'month', to specify which month's calendar will be used. If either is omitted, the current value is used. An important note is that the month and the year are NOT the standard C or Perl -- use a month in the range 1-12 and a real year, e.g. 2001. # Examples: # Create a calendar for this month. $cal = new HTML::CalendarMonthSimple(); # One for a specific month/year $cal = new HTML::CalendarMonthSimple('month'=>2,'year=>2000); # One for "the current month" in 1997 $cal = new HTML::CalendarMonthSimple('year'=>1997); year() month() monthname() These methods simply return the year/month of the calendar. monthname() returns the text name of the month, e.g. "December". setcontent(DATE,STRING) addcontent(DATE,STRING) getcontent(DATE) These methods are used to control the content of date cells within the calendar grid. The DATE argument may be a numeric date or it may be a string describing a certain occurrence of a weekday, e.g. "3MONDAY" to represent "the third Monday of the month being worked with", or it may be the plural of a weekday name, e.g. "wednesdays" to represent all occurrences of the given weekday. The weekdays are case-insensitive. # 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 = "" . $cal->getcontent(15) . ""; $cal->setcontent(15,$foo); # Or we could get extra spiffy: $cal->setcontent(15,"" . $cal->getcontent(15) . ""); # addcontent() does not clobber existing content. # Also, if you setcontent() to '', you've deleted the content. $cal->setcontent(16,''); $cal->addcontent(16,"
Hello World
"); $cal->addcontent(16,"Hello Again
"); 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'); Note: The storage for the three date types is in three separate buckets, e.g. even if the 9th of a month is the second Wednesday of that month, if you setcontent() for the 9th of the month, then you addcontent() for the '2wednesday' of that month, then getcontent(9) and getcontent('2wednesday') will each return their own content, not the combined contents! If you want to use a date or a Nweekday to fetch all the content for that date, use getallcontent() instead of getcontent(). getallcontent(DATE) This is similar to getcontent() except that it is smart enough to combine all the content for a given date with the content for that weekday. This addresses the shortcoming discussed in the getcontent()'s description. The DATE must be either a numeric date (e.g. 9) or a string describing a certain occurrence of a weekday (e.g. '2wednesday). It is not acceptable to use a plural weekday name (e.g. 'wednesdays'). # example: # getcontent() fetches individual buckets of content # assume that the 9th is the second wednesday of the month... $cal->addcontent(9,"the ninth\n"); $cal->addcontent('2wednesday',"second wednesday\n"); $cal->addcontent('wednesdays',"every wednesday\n"); print $cal->getcontent(9); # only prints the '9' bucket, not the others! # # on the other hand, getallcontent() is smart enough to combine the three content buckets... # both of these will print the same thing: "the ninth\nsecond wednesday\nevery wednesday\n" print $cal->getallcontent(9); print $cal->getcontent('2wednesday'); as_HTML() This method returns a string containing the HTML table for the month. # Example: print $cal->as_HTML(); It's okay to continue modifying the calendar after calling as_HTML(). My guess is that you'd want to call as_HTML() again to print the further-modified calendar, but that's your business... setdatehref(DATE,URL_STRING) getdatehref(DATE) These methods are used to control the content of date cells within the calendar grid. # Example: # The date number in the cell for the 15th of the month will # be a link to the sourceforge website $cal->setdatehref(15,"http://sourceforge.net/"); # Example: # You want to add to an URL $cal->setdatehref(15, $getdatehref(15)."projects/perl/"); contentfontsize([STRING]) contentfontsize() sets the font size for the contents of the cell, overriding the browser's default. Can be expressed as an absolute (1 .. 6) or relative (-3 .. +3) size. border([INTEGER]) This specifies the value of the border attribute to thecells. The effect in most web browsers is that they will be boldfaced and centered. If set to 0, the weekday headers will be in | cells and in normal text. For both functions, if no value is specified, the current value is returned. cellalignment([STRING]) vcellalignment([STRING]) cellalignment() sets the value of the align attribute to the | tag for each day's cell. This controls how text will be
horizontally centered/aligned within the cells. vcellalignment() does the same for vertical alignment. By default, content
is aligned horizontally "left" and vertically "top"
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.
header([STRING])
By default, the current month and year are displayed at the top of the calendar grid. This is called the "header".
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(" |
---|