ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ilCalendarDayGUI Class Reference

Presentation day view. More...

+ Collaboration diagram for ilCalendarDayGUI:

Public Member Functions

 __construct (ilDate $seed_date)
 Constructor.
 executeCommand ()
 Execute command.

Protected Member Functions

 show ()
 fill data section
 showFulldayAppointment ($a_app)
 show fullday appointment
 showAppointment ($a_app)
 show appointment
 parseInfoIntoRaster ($daily_apps, $morning_aggr, $evening_aggr, $raster)
 calculate overlapping hours
 calculateColspan ($hours)
 calculate colspan

Protected Attributes

 $seed = null
 $seed_info = array()
 $user_settings = null
 $lng
 $ctrl
 $tabs_gui
 $tpl
 $num_appointments = 1
 $timezone = 'UTC'

Detailed Description

Presentation day view.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

ilCalendarDayGUI: ilCalendarAppointmentGUI

Definition at line 40 of file class.ilCalendarDayGUI.php.

Constructor & Destructor Documentation

ilCalendarDayGUI::__construct ( ilDate  $seed_date)

Constructor.

public

Parameters

Definition at line 62 of file class.ilCalendarDayGUI.php.

References $ilCtrl, $ilUser, $lng, $tpl, ilCalendarUserSettings\_getInstanceByUserId(), ilDate\get(), and IL_CAL_FKT_GETDATE.

{
global $ilCtrl, $lng, $ilUser,$ilTabs,$tpl;
$this->seed = $seed_date;
$this->seed_info = $this->seed->get(IL_CAL_FKT_GETDATE);
$this->tpl = $tpl;
$this->lng = $lng;
$this->ctrl = $ilCtrl;
$this->tabs_gui = $ilTabs;
$this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($ilUser->getId());
$this->app_colors = new ilCalendarAppointmentColors($ilUser->getId());
$this->timezone = $ilUser->getTimeZone();
}

+ Here is the call graph for this function:

Member Function Documentation

ilCalendarDayGUI::calculateColspan (   $hours)
protected

calculate colspan

protected

Parameters
@return

Definition at line 585 of file class.ilCalendarDayGUI.php.

References $ilUser.

Referenced by show().

{
global $ilUser;
$colspan = 1;
foreach($hours as $hour)
{
$colspan = max($colspan,$hour['apps_num'] + 1);
}
// screen reader: always two cols (time and event col)
if ($ilUser->prefs["screen_reader_optimization"])
{
$colspan = 2;
}
return max($colspan,2);
}

+ Here is the caller graph for this function:

ilCalendarDayGUI::executeCommand ( )

Execute command.

public

Definition at line 86 of file class.ilCalendarDayGUI.php.

References $_GET, $_REQUEST, $_SESSION, $cmd, $ilCtrl, $tpl, and IL_CAL_DATE.

{
global $ilCtrl,$tpl;
$next_class = $ilCtrl->getNextClass();
switch($next_class)
{
case 'ilcalendarappointmentgui':
$this->ctrl->setReturn($this,'');
$this->tabs_gui->setSubTabActive($_SESSION['cal_last_tab']);
// initial date for new calendar appointments
$idate = new ilDate($_REQUEST['idate'], IL_CAL_DATE);
include_once('./Services/Calendar/classes/class.ilCalendarAppointmentGUI.php');
$app = new ilCalendarAppointmentGUI($this->seed,$idate,(int) $_GET['app_id']);
$this->ctrl->forwardCommand($app);
break;
default:
$cmd = $this->ctrl->getCmd("show");
$this->$cmd();
$tpl->setContent($this->tpl->get());
break;
}
return true;
}
ilCalendarDayGUI::parseInfoIntoRaster (   $daily_apps,
  $morning_aggr,
  $evening_aggr,
  $raster 
)
protected

calculate overlapping hours

protected

Returns
array hours

Definition at line 451 of file class.ilCalendarDayGUI.php.

References $ilUser, ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by show().

{
$hours = array();
for($i = $morning_aggr;$i <= $evening_aggr;$i+=$raster)
{
$hours[$i]['apps_start'] = array();
$hours[$i]['apps_num'] = 0;
switch($this->user_settings->getTimeFormat())
{
case ilCalendarSettings::TIME_FORMAT_24:
if ($morning_aggr > 0 && $i == $morning_aggr)
{
$hours[$i]['txt'] = sprintf('%02d:00',0)."-".
sprintf('%02d:00',ceil(($i+1)/60));
}
else
{
$hours[$i]['txt'].= sprintf('%02d:%02d',floor($i/60),$i%60);
}
if ($evening_aggr < 23*60 && $i == $evening_aggr)
{
$hours[$i]['txt'].= "-".sprintf('%02d:00',23);
}
break;
case ilCalendarSettings::TIME_FORMAT_12:
if ($morning_aggr > 0 && $i == $morning_aggr)
{
$hours[$i]['txt'] = date('h a',mktime(0,0,0,1,1,2000))."-";
}
$hours[$i]['txt'] = date('h a',mktime(floor($i/60),$i%60,0,1,1,2000));
if ($evening_aggr < 23*60 && $i == $evening_aggr)
{
$hours[$i]['txt'].= "-".date('h a',mktime(23,0,0,1,1,2000));
}
break;
}
}
foreach($daily_apps as $app)
{
global $ilUser;
// fullday appointment are not relavant
if($app['fullday'])
{
continue;
}
// start hour for this day
if($app['start_info']['mday'] != $this->seed_info['mday'])
{
$start = 0;
}
else
{
$start = $app['start_info']['hours']*60+$app['start_info']['minutes'];
}
// end hour for this day
if($app['end_info']['mday'] != $this->seed_info['mday'])
{
$end = 23*60;
}
elseif($app['start_info']['hours'] == $app['end_info']['hours'])
{
$end = $start+$raster;
}
else
{
$end = $app['end_info']['hours']*60+$app['end_info']['minutes'];
}
// set end to next hour for screen readers
if ($ilUser->prefs["screen_reader_optimization"])
{
$end = $start+$raster;
}
if ($start < $morning_aggr)
{
$start = $morning_aggr;
}
if ($end <= $morning_aggr)
{
$end = $morning_aggr+$raster;
}
if ($start > $evening_aggr)
{
$start = $evening_aggr;
}
if ($end > $evening_aggr+$raster)
{
$end = $evening_aggr+$raster;
}
if ($end <= $start)
{
$end = $start+$raster;
}
// map start and end to raster
$start = floor($start/$raster)*$raster;
$end = ceil($end/$raster)*$raster;
$first = true;
for($i = $start;$i < $end;$i+=$raster)
{
if($first)
{
if (!$ilUser->prefs["screen_reader_optimization"])
{
$app['rowspan'] = ceil(($end - $start)/$raster);
}
else // screen readers get always a rowspan of 1
{
$app['rowspan'] = 1;
}
$hours[$i]['apps_start'][] = $app;
$first = false;
}
$hours[$i]['apps_num']++;
}
}
return $hours;
}

+ Here is the caller graph for this function:

ilCalendarDayGUI::show ( )
protected

fill data section

protected

Definition at line 120 of file class.ilCalendarDayGUI.php.

References $_GET, $ilUser, $lng, ilCalendarSettings\_getInstance(), ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), calculateColspan(), ilDateTime\DAY, ilUtil\getImagePath(), IL_CAL_DATE, ilYuiUtil\initDragDrop(), ilYuiUtil\initPanel(), parseInfoIntoRaster(), showAppointment(), showFulldayAppointment(), and ilCalendarSchedule\TYPE_DAY.

{
global $lng, $ilUser;
// config
$raster = 15;
if($this->user_settings->getDayStart())
{
// push starting point to last "slot" of hour BEFORE morning aggregation
$morning_aggr = ($this->user_settings->getDayStart()-1)*60+(60-$raster);
}
else
{
$morning_aggr = 0;
}
$evening_aggr = $this->user_settings->getDayEnd()*60;
$this->tpl = new ilTemplate('tpl.day_view.html',true,true,'Services/Calendar');
include_once('./Services/YUI/classes/class.ilYuiUtil.php');
ilYuiUtil::initDragDrop();
ilYuiUtil::initPanel();
if(isset($_GET["bkid"]))
{
$user_id = $_GET["bkid"];
$no_add = true;
}
elseif($ilUser->getId() == ANONYMOUS_USER_ID)
{
$user_id = $ilUser->getId();
$no_add = true;
}
else
{
$user_id = $ilUser->getId();
$no_add = false;
}
include_once('Services/Calendar/classes/class.ilCalendarSchedule.php');
$this->scheduler = new ilCalendarSchedule($this->seed,ilCalendarSchedule::TYPE_DAY,$user_id);
$this->scheduler->addSubitemCalendars(true);
$this->scheduler->calculate();
$daily_apps = $this->scheduler->getByDay($this->seed,$this->timezone);
$hours = $this->parseInfoIntoRaster($daily_apps,
$morning_aggr,
$evening_aggr,
$raster
);
$colspan = $this->calculateColspan($hours);
$navigation = new ilCalendarHeaderNavigationGUI($this,$this->seed,ilDateTime::DAY);
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
// add milestone link
include_once('Services/Calendar/classes/class.ilCalendarSettings.php');
$settings = ilCalendarSettings::_getInstance();
if(!$no_add)
{
if ($settings->getEnableGroupMilestones())
{
$this->tpl->setCurrentBlock("new_ms");
$this->tpl->setVariable('H_NEW_MS_SRC',ilUtil::getImagePath('ms_add.png'));
$this->tpl->setVariable('H_NEW_MS_ALT',$this->lng->txt('cal_new_ms'));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'idate', $this->seed->get(IL_CAL_DATE));
$this->tpl->setVariable('NEW_MS_LINK',$this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui','addMilestone'));
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("new_app1");
$this->tpl->setVariable('H_NEW_APP_SRC',ilUtil::getImagePath('date_add.png'));
$this->tpl->setVariable('H_NEW_APP_ALT',$this->lng->txt('cal_new_app'));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'idate', $this->seed->get(IL_CAL_DATE));
$this->tpl->setVariable('NEW_APP_LINK',$this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui','add'));
$this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable('NAVIGATION',$navigation->getHTML());
$this->tpl->setVariable('HEADER_DATE',$this->seed_info['mday'].' '.ilCalendarUtil::_numericMonthToString($this->seed_info['mon'],false));
$this->tpl->setVariable('HEADER_DAY',ilCalendarUtil::_numericDayToString($this->seed_info['wday'],true));
$this->tpl->setVariable('HCOLSPAN',$colspan - 1);
$this->tpl->setVariable('TXT_TIME', $lng->txt("time"));
// show fullday events
foreach($daily_apps as $event)
{
if($event['fullday'])
{
$this->showFulldayAppointment($event);
}
}
$this->tpl->setCurrentBlock('fullday_apps');
$this->tpl->setVariable('TXT_F_DAY', $lng->txt("cal_all_day"));
$this->tpl->setVariable('COLSPAN',$colspan - 1);
$this->tpl->parseCurrentBlock();
// parse the hour rows
foreach($hours as $numeric => $hour)
{
if(!($numeric%60) || ($numeric == $morning_aggr && $morning_aggr) ||
($numeric == $evening_aggr && $evening_aggr))
{
if(!$no_add)
{
$this->tpl->setCurrentBlock("new_app2");
$this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','idate',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','hour',floor($numeric/60));
$this->tpl->setVariable('NEW_APP_HOUR_LINK',$this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui','add'));
$this->tpl->setVariable('NEW_APP_SRC',ilUtil::getImagePath('date_add.png'));
$this->tpl->setVariable('NEW_APP_ALT',$this->lng->txt('cal_new_app'));
$this->tpl->parseCurrentBlock();
}
// aggregation rows
if(($numeric == $morning_aggr && $morning_aggr) ||
($numeric == $evening_aggr && $evening_aggr))
{
$this->tpl->setVariable('TIME_ROWSPAN', 1);
}
// rastered hour
else
{
$this->tpl->setVariable('TIME_ROWSPAN', 60/$raster);
}
$this->tpl->setCurrentBlock('time_txt');
$this->tpl->setVariable('TIME',$hour['txt']);
$this->tpl->parseCurrentBlock();
}
foreach($hour['apps_start'] as $app)
{
$this->showAppointment($app);
}
if ($ilUser->prefs["screen_reader_optimization"])
{
$this->tpl->touchBlock('scrd_app_cell');
}
for($i = ($colspan - 1);$i > $hour['apps_num'];$i--)
{
$this->tpl->setCurrentBlock('empty_cell');
$this->tpl->setVariable('EMPTY_WIDTH',(100 / (int) ($colspan - 1)).'%');
// last "slot" of hour needs border
if($numeric%60 == 60-$raster ||
($numeric == $morning_aggr && $morning_aggr) ||
($numeric == $evening_aggr && $evening_aggr))
{
$this->tpl->setVariable('EMPTY_STYLE', ' calempty_border');
}
$this->tpl->parseCurrentBlock();
}
$this->tpl->touchBlock('time_row');
}
}

+ Here is the call graph for this function:

ilCalendarDayGUI::showAppointment (   $a_app)
protected

show appointment

protected

Parameters
arrayappointment

Definition at line 342 of file class.ilCalendarDayGUI.php.

References $ilUser, $title, ilCalendarAppointmentPanelGUI\_getInstance(), ilCalendarUtil\calculateFontColor(), IL_CAL_DATE, IL_CAL_FKT_DATE, ilCalendarSettings\TIME_FORMAT_12, ilCalendarSettings\TIME_FORMAT_24, and ilCalendarCategory\TYPE_CH.

Referenced by show().

{
global $ilUser;
$this->tpl->setCurrentBlock('panel_code');
$this->tpl->setVariable('NUM',$this->num_appointments);
$this->tpl->parseCurrentBlock();
if (!$ilUser->prefs["screen_reader_optimization"])
{
$this->tpl->setCurrentBlock('app');
}
else
{
$this->tpl->setCurrentBlock('scrd_app');
}
include_once('./Services/Calendar/classes/class.ilCalendarAppointmentPanelGUI.php');
$this->tpl->setVariable('PANEL_DATA',ilCalendarAppointmentPanelGUI::_getInstance($this->seed)->getHTML($a_app));
$this->tpl->setVariable('PANEL_NUM',$this->num_appointments);
$this->tpl->setVariable('APP_ROWSPAN',$a_app['rowspan']);
$this->tpl->setVariable('APP_TITLE',$a_app['event']->getPresentationTitle(false));
switch($this->user_settings->getTimeFormat())
{
case ilCalendarSettings::TIME_FORMAT_24:
$title = $a_app['event']->getStart()->get(IL_CAL_FKT_DATE,'H:i',$this->timezone);
break;
case ilCalendarSettings::TIME_FORMAT_12:
$title = $a_app['event']->getStart()->get(IL_CAL_FKT_DATE,'h:ia',$this->timezone);
break;
}
// add end time for screen readers
if ($ilUser->prefs["screen_reader_optimization"])
{
switch($this->user_settings->getTimeFormat())
{
case ilCalendarSettings::TIME_FORMAT_24:
$title.= "-".$a_app['event']->getEnd()->get(IL_CAL_FKT_DATE,'H:i',$this->timezone);
break;
case ilCalendarSettings::TIME_FORMAT_12:
$title.= "-".$a_app['event']->getEnd()->get(IL_CAL_FKT_DATE,'h:ia',$this->timezone);
break;
}
}
// booking
if($a_app['category_type'] == ilCalendarCategory::TYPE_CH)
{
include_once 'Services/Booking/classes/class.ilBookingEntry.php';
$entry = new ilBookingEntry($a_app['event']->getContextId());
if($entry)
{
$title .= ' '.$a_app['event']->getTitle();
if($entry->isOwner())
{
$max = (int)$entry->getNumberOfBookings();
$current = (int)$entry->getCurrentNumberOfBookings($a_app['event']->getEntryId());
if($max > 1)
{
$title .= ' ('.$current.'/'.$max.')';
}
else if($current == $max)
{
$title .= ' ('.$this->lng->txt('cal_booked_out').')';
}
else
{
$title .= ' ('.$this->lng->txt('cal_book_free').')';
}
}
else if($entry->hasBooked($a_app['event']->getEntryId()))
{
$title .= ' ('.$this->lng->txt('cal_date_booked').')';
}
}
}
else
{
$title .= (' '.$a_app['event']->getPresentationTitle(false));
}
$this->tpl->setVariable('APP_TITLE',$title);
$color = $this->app_colors->getColorByAppointment($a_app['event']->getEntryId());
$this->tpl->setVariable('APP_BGCOLOR',$color);
$this->tpl->setVariable('APP_COLOR',ilCalendarUtil::calculateFontColor($color));
$this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','app_id',$a_app['event']->getEntryId());
$this->tpl->setVariable('APP_EDIT_LINK',$this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui','edit'));
$this->tpl->parseCurrentBlock();
$this->num_appointments++;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilCalendarDayGUI::showFulldayAppointment (   $a_app)
protected

show fullday appointment

protected

Parameters
arrayappointment
Returns

Definition at line 297 of file class.ilCalendarDayGUI.php.

References ilCalendarAppointmentPanelGUI\_getInstance(), ilCalendarUtil\calculateFontColor(), ilUtil\getImagePath(), and IL_CAL_DATE.

Referenced by show().

{
$this->tpl->setCurrentBlock('panel_code');
$this->tpl->setVariable('NUM',$this->num_appointments);
$this->tpl->parseCurrentBlock();
// milestone icon
if ($a_app['event']->isMilestone())
{
$this->tpl->setCurrentBlock('fullday_ms_icon');
$this->tpl->setVariable('ALT_FD_MS', $this->lng->txt("cal_milestone"));
$this->tpl->setVariable('SRC_FD_MS', ilUtil::getImagePath("icon_ms_s.png"));
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock('fullday_app');
include_once('./Services/Calendar/classes/class.ilCalendarAppointmentPanelGUI.php');
$this->tpl->setVariable('PANEL_F_DAY_DATA',ilCalendarAppointmentPanelGUI::_getInstance($this->seed)->getHTML($a_app));
$this->tpl->setVariable('F_DAY_ID',$this->num_appointments);
$compl = ($a_app['event']->isMilestone() && $a_app['event']->getCompletion() > 0)
? " (".$a_app['event']->getCompletion()."%)"
: "";
$this->tpl->setVariable('F_APP_TITLE',$a_app['event']->getPresentationTitle(false).$compl);
$color = $this->app_colors->getColorByAppointment($a_app['event']->getEntryId());
$this->tpl->setVariable('F_APP_BGCOLOR',$color);
$this->tpl->setVariable('F_APP_FONTCOLOR',ilCalendarUtil::calculateFontColor($color));
$this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','seed',$this->seed->get(IL_CAL_DATE));
$this->ctrl->setParameterByClass('ilcalendarappointmentgui','app_id',$a_app['event']->getEntryId());
$this->tpl->setVariable('F_APP_EDIT_LINK',$this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui','edit'));
$this->tpl->parseCurrentBlock();
$this->num_appointments++;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilCalendarDayGUI::$ctrl
protected

Definition at line 47 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$lng
protected

Definition at line 46 of file class.ilCalendarDayGUI.php.

Referenced by __construct(), and show().

ilCalendarDayGUI::$num_appointments = 1
protected

Definition at line 51 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$seed = null
protected

Definition at line 42 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$seed_info = array()
protected

Definition at line 43 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$tabs_gui
protected

Definition at line 48 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$timezone = 'UTC'
protected

Definition at line 53 of file class.ilCalendarDayGUI.php.

ilCalendarDayGUI::$tpl
protected

Definition at line 49 of file class.ilCalendarDayGUI.php.

Referenced by __construct(), and executeCommand().

ilCalendarDayGUI::$user_settings = null
protected

Definition at line 44 of file class.ilCalendarDayGUI.php.

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