CalendarView Class Reference

Inherits FacetFilterable.

Public Member Functions
	CalendarView ($events, $id=null)
	getID ()
	addHandler ($class, $handler)
	getHandler ($event)
	addFacetTaggingHandler ($handler)
	Adds a row tagging handler. More...
	summary ($event)
	details ($event, $param=null)
	filterEvents ($events, $currentDay)
	rewriteQueryString ($year, $month)
	calculateMonthRange ()
	drawMiniCalendar ()
	createEventDialog ()
	drawMonth ()
	writeScript ()
	header ($alt=event_display)
	formatEventListLink ($link, $dLink, $currentDay, $eventBubbleID, $idx)
	drawEventList ()

Public Attributes
	$current_day
	$events
	$id
	The HTML tag id for the calendar view. More...
	$month
	$year
	$handlerMap = array()
	$calendarLink = "/calendar"
	$listLink = "/event_list"
	$listDialog = ""
	$detailLink = "/event_detail"
	$yearParam = "year"
	$monthParam = "month"
	$maxEventsPerDay = null
	The maximum number of events to display per day on monthly view. More...
	$tagRowCallbacks
	Array of callbacks for adding extra attributes to each row. More...

Detailed Description

Definition at line 227 of file calendar_view.inc.

Member Function Documentation

addFacetTaggingHandler()

CalendarView::addFacetTaggingHandler

(

$handler

)

Adds a row tagging handler.

This function will receive the data item for each row and can add custom attributes to the row tag.

Definition at line 315 of file calendar_view.inc.

     {
          $this->tagRowCallbacks[] = $handler;
     }

addHandler()

CalendarView::addHandler	(		$class,
			$handler
	)

Parameters

String	$class	composite event class or data item class name
obj	$handler	instance of a class inherits from either StandardEventHandler or EventHandler

Definition at line 272 of file calendar_view.inc.

     {
          $this->handlerMap[$class] = $handler;
     }

calculateMonthRange()

CalendarView::calculateMonthRange

(

)

Definition at line 364 of file calendar_view.inc.

     {    
          if ($this->year < 2005 || $this->year > 2038 || $this->month < 1 || $this->month > 12)
          {
               die("Date out of range");
          }
          
          $this->startStr = sprintf("%d-%02d-01", $this->year, $this->month);
          $this->start = strtotime($this->startStr);
          
          $this->dayOfWeek = date("w", $this->start);
          $this->daysInMonth = getMonthDays($this->month, $this->year);
          
          $this->prevMonth = $this->month - 1;
          $this->prevYear = $this->year;
          
          if ($this->prevMonth <= 0)
          {
               $this->prevYear--;
               $this->prevMonth = 12;
          }
          
          $this->nextMonth = $this->month + 1;
          $this->nextYear = $this->year;
          if ($this->nextMonth > 12)
 
          {
               $this->nextMonth = 1;
               $this->nextYear++;
          }
 
          $this->endStr = sprintf("%d-%02d-01", $this->nextYear, $this->nextMonth);
 
          $this->prevLink = $this->rewriteQueryString($this->prevYear, $this->prevMonth);
          $this->nextLink = $this->rewriteQueryString($this->nextYear, $this->nextMonth); 
     }

CalendarView()

CalendarView::CalendarView	(		$events,
			$id = null
	)

Definition at line 244 of file calendar_view.inc.

     {
          $this->events = $events;
          $this->id = $id;
          $this->month = date("n");
          $this->year = date("Y");
          $this->tagRowCallbacks = array();
          $this->addHandler(Event, new StandardEventHandler());
          ComponentManager::fireEvent("RegisterCalendarEventHandlers", $this);
          
          $max = Settings::getValue("calendar", "max_events_per_day");
          if($max)
          {
               $this->maxEventsPerDay = $max;
          }
     }

createEventDialog()

CalendarView::createEventDialog

(

)

Definition at line 497 of file calendar_view.inc.

     {
     }

details()

CalendarView::details	(		$event,
			$param = null
	)

Definition at line 325 of file calendar_view.inc.

     {
          return $this->getHandler($event)->details($event, $param);
     }

drawEventList()

CalendarView::drawEventList

(

)

Definition at line 671 of file calendar_view.inc.

     {
          $this->createEventDialog();
          
          $this->calculateMonthRange();
          
          $this->header(calendar_display);
 
          if (count($this->events) > 0)
          {
               foreach($this->events as $event)
               {
                    $handler = $this->getHandler($event);
                    $content .= $handler->details($event);
                    $content .= "<br>";
               }
               echo $content;
          }
          else
          {
?>
<p><i>No events have been scheduled for this month.</i></p>
<?
          }
     }

drawMiniCalendar()

CalendarView::drawMiniCalendar

(

)

Definition at line 401 of file calendar_view.inc.

     {
          $this->createEventDialog();
          
          global $script;
          $script .= <<<ENDSCRIPT
<script type="text/javascript" src="/components/calendar/js/calendar.js"></script>
ENDSCRIPT;
          
          $this->calculateMonthRange();
          
          $bubbles = ""; 
 
?>
<div id="minicalendar">
<table>
 <tr>
 <td colspan="7" class="month"><a class="calendar_nav" href="<?echo $this->prevLink?>">&lt;</a>&nbsp; <?echo date("F Y", $this->start)?>&nbsp; <a class="calendar_nav" href="<?echo $this->nextLink?>">&gt;</a> </td>
  </tr>
 <tr>
  <th width="14%">Su</th>
  <th width="14%">Mo</th>
  <th width="14%">Tu</th>
  <th width="14%">We</th>
  <th width="14%">Th</th>
  <th width="14%">Fr</th>
  <th width="14%">Sa</th>
 </tr>
 <tr>
<?
          for($c = 0; $c < $this->dayOfWeek; ++$c)
          {
?><td class="empty">&nbsp;</td><?
          }
          
          $today = date("Y-m-d");
          
          for($i = 1; $i <= $this->daysInMonth; ++$i)
          {
               
               $currentDay = sprintf("%d-%02d-%02d", $this->year, $this->month, $i);
               $eventsToday = $this->filterEvents($this->events, $currentDay);
 
               if (count($eventsToday) > 0)
               {
                    $class = "event";
                    $event = $eventsToday[0];
                    $eventBubbleID = "event_bubble_".str_replace("-", "_", $currentDay);
                    $dayTitle = date("F jS Y", strtotime($currentDay));
                    
                    $link = $this->formatEventListLink($this->listLink, $this->listDialog, $currentDay, $eventBubbleID, $i);
                    
                    $bubbles .= 
                    "<div id='$eventBubbleID' class='event_bubble'>
                         <div class='event_bubble_content'>
                         <h4>{$dayTitle}</h4>";
                    
                    foreach($eventsToday as $event)
                    {
                         $handler = $this->getHandler($event);
                         $bubbles .= $handler->summary($event);
                    }
                         
                    $bubbles .=
                    "    </div>
                     <div class='event_bubble_bottom'>&nbsp;</div></div>";
               }
               else
               {
                    $class = (($c % 7) == 0 || ($c % 7) == 6) ? "weekend" : "weekday";
                    $link = $i;
               }
               
               if ($currentDay == $today) $class="today";
?>
 <td class="<?echo $class ?>" ><?echo $link ?></td>
<?
                ++$c;
                if (($c % 7) == 0) echo "</tr><tr>";
          }
          
          while ($c % 7)
          {
 
?><td class="empty">&nbsp;</td>
<?
               $c++;
          }
?>
</tr>
</table>
</div>
<?echo $bubbles?>
<?   
     }

drawMonth()

CalendarView::drawMonth

(

)

Definition at line 501 of file calendar_view.inc.

     {
          $this->createEventDialog();
          
          $this->calculateMonthRange();
?>        
<div id="fullcalendar">
<table id=<?php echo $this->id ?>>
 <tr>
  <td class="month" colspan="7"><?echo date("F Y", $this->start)?> <a class="calendar_nav" href="<?echo $this->prevLink?>"><img src="/components/calendar/images/calendar_arrow_l.png" alt="left" width="22" height="22" border="0"></a> <a class="calendar_nav" href="<?echo $this->nextLink?>"><img src="/components/calendar/images/calendar_arrow_r.png" alt="right" width="22" height="22" border="0"></a> </td>
 </tr>
 <tr>
  <th width="14.28%">Su</th>
  <th width="14.28%">Mo</th>
  <th width="14.28%">Tu</th>
  <th width="14.28%">We</th>
  <th width="14.28%">Th</th>
  <th width="14.28%">Fr</th>
  <th width="14.28%">Sa</th>
 </tr>
 <tr>
<?
          for($c = 0; $c < $this->dayOfWeek; ++$c)
          {
?><td class="empty">&nbsp;</td><?
          }
          
          $today = date("Y-m-d");
          
          for($i = 1; $i <= $this->daysInMonth; ++$i)
          {
               
               $currentDay = sprintf("%d-%02d-%02d", $this->year, $this->month, $i);
               $eventsToday = $this->filterEvents($this->events, $currentDay);
               $content = "";
               
               if (count($eventsToday) > 0)
               {
                    $class = "event";
                    foreach($eventsToday as $event)
                    {
                         $handler = $this->getHandler($event);
                         $content .= $handler->formatSummary($event, $this->tagRowCallbacks);
                    }
 
                    $link = $i;
               }
               else
               {
                    $class = (($c % 7) == 0 || ($c % 7) == 6) ? "weekend" : "weekday";
                    $link = $i;
               }
               
               if ($currentDay == $today) $class="today";
?>
 <td class="<?echo $class ?>" data-day="<?php echo $i ?>"><?echo $link ?><? echo $content?></td>
<?
                ++$c;
                if (($c % 7) == 0) echo "</tr><tr>";
          }
          
          while ($c % 7)
          {
 
?><td class="empty">&nbsp;</td>
<?
               $c++;
          }
?>
</tr>
</table>
</div>         
<?
     }

filterEvents()

CalendarView::filterEvents	(		$events,
			$currentDay
	)

Definition at line 330 of file calendar_view.inc.

     {
          $ret = array();
 
          foreach($events as $event)
          {
               $handler = $this->getHandler($event);
               if ($handler AND $handler->filter($event, $currentDay))
               {
                    $ret[] = $event;
               }
               // If not found - function getHandler outputs trace
          }
          
          return $ret;
     }    

formatEventListLink()

CalendarView::formatEventListLink	(		$link,
			$dLink,
			$currentDay,
			$eventBubbleID,
			$idx
	)

Definition at line 647 of file calendar_view.inc.

     {
          if($link)
          {
               $link .= (preg_match("/\?/", $link)) ? "&" : "?";
               $link .= "date=$currentDay";
          }
          else
               $link = "#";
          
          if($dLink)
          {
               if(preg_match("/[\‍(.*?\‍)]$/", $dLink))
                    $dLink = preg_replace("/[\‍(.*?\‍)]$/", ", '$currentDay')", $dLink);
               else
                    $dLink .= "('$currentDay')";
               $onclick = "onclick=\"$dLink; return false;\"";
          }
          
          return "<a class='eventlink' href=\"{$link}\" $onclick; 
          onmouseover='showEventBubble(\"$eventBubbleID\", this);' onmouseout='hideEventBubble(\"$eventBubbleID\");'>{$idx}</a>";
     }

getHandler()

CalendarView::getHandler

(

$event

)

Definition at line 288 of file calendar_view.inc.

     {
          if(get_class($event) == "Event" && $event->composite_class)
          {
               $event_class = $event->composite_class;
          }
          else
          {
               $event_class = get_class($event);
          }
     
          if(array_key_exists($event_class, $this->handlerMap))
          {
               $handler = $this->handlerMap[$event_class];
          }
          else
          {
               $handler = new StandardEventHandler();
          }
               
          return $handler;    
     }

getID()

CalendarView::getID

(

)

Definition at line 261 of file calendar_view.inc.

     {
          return $this->id;
     }

header()

CalendarView::header

(

$alt = event_display

)

Definition at line 601 of file calendar_view.inc.

     {
          $link = $this->rewriteQueryString($this->year, $this->month, $alt);
          $altTitle = ($alt == event_display) ? "List of Events" : "Calendar";
?>        
<table style='width: 100%' class="layout">
 <tr>
  <td><p><a href="<? echo $link ?>">View <? echo $altTitle ?></a></p></td>
  <td align="right">
   <form method="get" action="">
    <?php
    $calendar_id = htmlSafe(checkNumeric($_GET["calendar_id"]));
    if($calendar_id)
    {
          echo "<input id='calendar_id' type='hidden' name='calendar_id' value='$calendar_id'/>\n";
    }
     ?>
    <select name="month">
<?
     for($i = 1; $i <= 12; ++$i)
     {
          $monthName = date("F", strtotime("$i/1/2007"));
          option($i, $monthName, $i == $this->month);
     }
?>
    </select>&nbsp;<select name="year">
<?
     $endYear = date("Y") + 2;
     for($i = 2006; $i <= $endYear; ++$i)
     {
          option($i, $i, (int)$this->year);
     }
?>
    </select>
    <input type="submit" class="button" value=" GO "/>
   </form>
  </td>
 </tr>
</table>
<?
          
     }

rewriteQueryString()

CalendarView::rewriteQueryString	(		$year,
			$month
	)

Definition at line 347 of file calendar_view.inc.

     {
          global $isAdmin;
          
          $qs = $_SERVER['QUERY_STRING'];
          
          $identifier = $_REQUEST["identifier"];
          
          if ($isAdmin) $identifier = "/admin/$identifier";
          
          $qs = preg_replace("/identifier=[\\w_]+&*/", "", $qs);
          $qs = preg_replace("/{$this->yearParam}=\\d+&*/", "", $qs);
          $qs = preg_replace("/{$this->monthParam}=\\d+&*/", "", $qs);
               
          return "$identifier".appendToQueryString($qs, "{$this->yearParam}=$year&{$this->monthParam}=$month");
     }

summary()

CalendarView::summary

(

$event

)

Definition at line 320 of file calendar_view.inc.

     {
          return $this->getHandler($event)->summary($event);
     }

writeScript()

CalendarView::writeScript

(

)

Definition at line 576 of file calendar_view.inc.

     {
          if(!count($this->tagRowCallbacks) || !$this->maxEventsPerDay) return;
     
          $options = "{}";
          if($this->maxEventsPerDay)
          {
               $options = "{per_day: {$this->maxEventsPerDay}}";
          }
 
          ob_start();
          ?>
          <script type="text/javascript" src="/components/calendar/js/filtering_calendar.js"></script>
          <script type="text/javascript">
          window.addEvent('domready', function()
          {
               var <?echo $this->id?> = new FilteringCalendar('<?echo $this->id ?>', <?php echo $options ?>);
          });
          </script>
     <?
               $script = ob_get_contents();
               ob_end_clean();
               return $script;
     }

Member Data Documentation

$calendarLink

CalendarView::$calendarLink = "/calendar"

Definition at line 235 of file calendar_view.inc.

$current_day

CalendarView::$current_day

Definition at line 229 of file calendar_view.inc.

$detailLink

CalendarView::$detailLink = "/event_detail"

Definition at line 238 of file calendar_view.inc.

$events

CalendarView::$events

Definition at line 230 of file calendar_view.inc.

$handlerMap

CalendarView::$handlerMap = array()

Definition at line 234 of file calendar_view.inc.

$id

CalendarView::$id

The HTML tag id for the calendar view.

Definition at line 231 of file calendar_view.inc.

$listDialog

CalendarView::$listDialog = ""

Definition at line 237 of file calendar_view.inc.

$listLink

CalendarView::$listLink = "/event_list"

Definition at line 236 of file calendar_view.inc.

$maxEventsPerDay

CalendarView::$maxEventsPerDay = null

The maximum number of events to display per day on monthly view.

Definition at line 241 of file calendar_view.inc.

$month

CalendarView::$month

Definition at line 232 of file calendar_view.inc.

$monthParam

CalendarView::$monthParam = "month"

Definition at line 240 of file calendar_view.inc.

$tagRowCallbacks

CalendarView::$tagRowCallbacks

Array of callbacks for adding extra attributes to each row.

Definition at line 242 of file calendar_view.inc.

$year

CalendarView::$year

Definition at line 233 of file calendar_view.inc.

$yearParam

CalendarView::$yearParam = "year"

Definition at line 239 of file calendar_view.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/calendar/calendar_view.inc