Sitellite Application Framework
Class Tree         Index         All Elements

Class: SimpleCal

Source Location: Program_Root/Date/Calendar/Simple.php

Class Overview


A concise calendar class, useful for displaying monthly calendars in a web site or application UI.


Author(s)

Version

  • 1.0, 2004-04-26, $Id: Simple.php,v 1.1.1.1 2005/04/29 04:44:34 lux Exp $

Copyright

  • Copyright (C) 2004, Simian Systems Inc.

Methods


Inherited Variables

Inherited Methods


Class Details

[line 32]
A concise calendar class, useful for displaying monthly calendars in a web site or application UI.


1 <?php
2
3 loader_import ('saf.Date.Calendar.Simple');
4
5 $cal = new SimpleCal ($parameters['simplecal']);
6
7 $cal->addLink (5, 'Dentist Appointment', '/index/sitellite-calendar-event-action?id=3');
8 $cal->addLink (5, 'BBQ at Joe\'s', '/index/sitellite-calendar-event-action?id=5');
9 $cal->addLink (16, 'Board Meeting', '/index/sitellite-calendar-event-action?id=7');
10 $cal->addLink (21, 'Anniversary', '/index/sitellite-calendar-event-action?id=9', true);
11 $cal->addLink (26, 'Golf w/ Boss', '/index/sitellite-calendar-event-action?id=11', true);
12
13 echo $cal->render ();
14
15 ? >




Tags:

access:  public
version:  1.0, 2004-04-26, $Id: Simple.php,v 1.1.1.1 2005/04/29 04:44:34 lux Exp $
license:  http://www.sitellite.org/index/license
copyright:  Copyright (C) 2004, Simian Systems Inc.
author:  John Luxford <mailto:lux@simian.ca>


[ Top ]


Class Methods


constructor SimpleCal [line 39]

SimpleCal SimpleCal( string $mc)

Constructor method.



Tags:

access:  public


Parameters:

string   $mc  

[ Top ]

method addHTML [line 94]

void addHTML( integer $day, string $html)

Adds the specified HTML to the specified day.



Tags:

access:  public


Parameters:

integer   $day  
string   $html  

[ Top ]

method addLink [line 68]

void addLink( integer $day, string $text, mixed $link, [mixed $important = false], [mixed $alt = ''])

Sets the specified day to link to the specified link.



Tags:

access:  public


Parameters:

integer   $day  
string   $text  

[ Top ]

method isActive [line 164]

boolean isActive( integer $r, integer $c)

Determines whether the specified row and column is active.



Tags:

access:  public


Parameters:

integer   $r  
integer   $c  

[ Top ]

method isCurrent [line 192]

boolean isCurrent( integer $day)

Determines whether the specified day is the current date.



Tags:

access:  public


Parameters:

integer   $day  

[ Top ]

method isLink [line 178]

boolean isLink( string $day)

Determines whether there is a link for the specified day.



Tags:

access:  public


Parameters:

string   $day  

[ Top ]

method isWeekend [line 206]

boolean isWeekend( integer $day)

Determines whether the specified day is on a weekend.



Tags:

access:  public


Parameters:

integer   $day  

[ Top ]

method monthName [line 130]

string monthName( )

Returns the name of the current month.



Tags:

access:  public


[ Top ]

method nextDate [line 120]

string nextDate( )

Returns the next month as a $mc value.



Tags:

access:  public


[ Top ]

method nextMonth [line 151]

string nextMonth( )

Returns the name of the next month.



Tags:

access:  public


[ Top ]

method prevDate [line 110]

string prevDate( )

Returns the previous month as a $mc value.



Tags:

access:  public


[ Top ]

method prevMonth [line 140]

string prevMonth( )

Returns the name of the previous month.



Tags:

access:  public


[ Top ]

method render [line 309]

string render( )

Renders the HTML calendar.



Tags:

access:  public


[ Top ]

method weekday [line 223]

string weekday( string $day)

Returns an abbreviated week day formatted by strftime(). $day is a lowercase, English weekday abbreviation (sun, mon, tue, wed, thu, fri, or sat).



Tags:

access:  public


Parameters:

string   $day  

[ Top ]

method weekdayFri [line 293]

string weekdayFri( )

Calls weekday() with 'fri' (as in Friday).



Tags:

access:  public


[ Top ]

method weekdayMon [line 261]

string weekdayMon( )

Calls weekday() with 'mon' (as in Monday).



Tags:

access:  public


[ Top ]

method weekdaySat [line 301]

string weekdaySat( )

Calls weekday() with 'sat' (as in Saturday).



Tags:

access:  public


[ Top ]

method weekdaySun [line 253]

string weekdaySun( )

Calls weekday() with 'sun' (as in Sunday).



Tags:

access:  public


[ Top ]

method weekdayThu [line 285]

string weekdayThu( )

Calls weekday() with 'thu' (as in Thursday).



Tags:

access:  public


[ Top ]

method weekdayTue [line 269]

string weekdayTue( )

Calls weekday() with 'tue' (as in Tuesday).



Tags:

access:  public


[ Top ]

method weekdayWed [line 277]

string weekdayWed( )

Calls weekday() with 'wed' (as in Wednesday).



Tags:

access:  public


[ Top ]


Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:19:22 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2