Presentation day view. More...

Inheritance diagram for ilCalendarDayGUI:

Collaboration diagram for ilCalendarDayGUI:

Public Member Functions
	__construct (ilDate $seed_date)
	Constructor. More...

	executeCommand ()
	Execute command. More...

Public Member Functions inherited from ilCalendarViewGUI
	__construct (ilDate $seed, $presentation_type)

	setConsulationHoursUserId ($a_user_id)

	getConsultationHoursUserId ()

	initialize ($a_calendar_presentation_type)
	View initialization. More...

	getCurrentApp ()
	Get app for id. More...

	getEvents ()
	Get events. More...

	getDatesForItem ($item)
	Get start/end date for item. More...

	getModalForApp ()
	Get modal for appointment (see similar code in ilCalendarBlockGUI) More...

	getAppointmentShyButton ($a_calendar_entry, $a_dstart, $a_title_forced="")

	getActivePlugins ($a_slot_id)

	getModalTitleByPlugins ($a_current_title)

	getContentByPlugins ($a_cal_entry, $a_start_date, $a_content, $a_tpl)

	addToolbarActions ()
	Add download link to toolbar. More...

	downloadFiles ()
	Download files related to the appointments showed in the current calendar view (day,week,month,list). More...

	getBucketTitle ()
	get proper label to add in the background task popover More...

	countEventsInView ()
	get the events starting between 2 dates based in seed + view options. More...

Protected Member Functions
	showFulldayAppointment ($a_app)
	show fullday appointment More...

	showAppointment ($a_app)
	show appointment More...

	parseInfoIntoRaster ($daily_apps, $morning_aggr, $evening_aggr, $raster)
	calculate overlapping hours More...

	calculateColspan ($hours)
	calculate colspan More...

Protected Attributes
	$seed_info = array()

	$user_settings = null

	$lng

	$ctrl

	$tabs_gui

	$tpl

	$num_appointments = 1

	$timezone = 'UTC'

	$user

	$ui

	$toolbar

Protected Attributes inherited from ilCalendarViewGUI
	$ui_factory

	$ui_renderer

	$ctrl

	$presentation_type

	$toolbar

	$logger

	$ui

	$view_with_appointments

	$lng

	$user

	$seed

	$ch_user_id = 0

Additional Inherited Members
Data Fields inherited from ilCalendarViewGUI
const	CAL_PRESENTATION_DAY = 1

const	CAL_PRESENTATION_WEEK = 2

const	CAL_PRESENTATION_MONTH = 3

const	CAL_PRESENTATION_AGENDA_LIST = 9

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$

@ilCtrl_Calls ilCalendarDayGUI: ilCalendarAppointmentGUI @ilCtrl_Calls ilCalendarDayGUI: ilCalendarAppointmentPresentationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarDayGUI::__construct ( ilDate $seed_date )

Constructor.

@access public

Parameters

xrefitem todo 145.

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

    {
        parent::__construct($seed_date, ilCalendarViewGUI::CAL_PRESENTATION_DAY);
 
        $this->seed_info = $this->seed->get(IL_CAL_FKT_GETDATE);
 
        $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
        $this->app_colors = new ilCalendarAppointmentColors($this->user->getId());
        
        $this->timezone = $this->user->getTimeZone();
    }

References ILIAS\GlobalScreen\Provider\__construct(), ilCalendarUserSettings\_getInstanceByUserId(), ilCalendarViewGUI\CAL_PRESENTATION_DAY, IL_CAL_FKT_GETDATE, and user().

Here is the call graph for this function:

Member Function Documentation

◆ calculateColspan()

ilCalendarDayGUI::calculateColspan ( $hours )

protected

calculate colspan

@access protected

Parameters

return

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

    {
        $ilUser = $this->user;
 
 
        $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);
    }

References $ilUser, and $user.

◆ executeCommand()

ilCalendarDayGUI::executeCommand ( )

Execute command.

@access public

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

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
 
        $next_class = $ilCtrl->getNextClass();
        switch ($next_class) {
            case "ilcalendarappointmentpresentationgui":
                $this->ctrl->setReturn($this, "");
                include_once("./Services/Calendar/classes/class.ilCalendarAppointmentPresentationGUI.php");
                $this->logger->debug("-ExecCommand - representation of ilDate: this->seed->get(IL_CAL_DATE) = " . $this->seed->get(IL_CAL_DATE));
                $gui = ilCalendarAppointmentPresentationGUI::_getInstance($this->seed, $this->getCurrentApp());
                $this->ctrl->forwardCommand($gui);
                break;
            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;
    }

References $_GET, $_SESSION, $app, $ctrl, $ilCtrl, $tpl, ilCalendarAppointmentPresentationGUI\_getInstance(), ilCalendarViewGUI\getCurrentApp(), and IL_CAL_DATE.

Here is the call graph for this function:

◆ parseInfoIntoRaster()

ilCalendarDayGUI::parseInfoIntoRaster	(	$daily_apps,
		$morning_aggr,
		$evening_aggr,
		$raster
	)

protected

calculate overlapping hours

@access protected

Returns: array hours

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

    {
        $ilUser = $this->user;
 
        $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', 0);
                    }
                    break;
                
                case ilCalendarSettings::TIME_FORMAT_12:
 
                    $this->logger->notice('Morning: ' . $morning_aggr . ' and $i:' . $i);
 
                    if ($morning_aggr > 0 && $i == $morning_aggr) {
                        $hours[$i]['txt'] =
                            date('h a', mktime(0, 0, 0, 1, 1, 2000)) . ' - ' .
                            date('h a', mktime($this->user_settings->getDayStart(), 0, 0, 1, 1, 2000));
                    } else {
                        $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(0, 0, 0, 1, 1, 2000));
                    }
                    break;
            }
        }
        
        
        foreach ($daily_apps as $app) {
            // fullday appointment are not relavant
            if ($app['fullday']) {
                continue;
            }
            // start hour for this day
            #21132 #21636
            if ($app['start_info']['mday'] != $this->seed_info['mday']) {
                $start = 0;
            } else {
                $start = $app['start_info']['hours'] * 60 + $app['start_info']['minutes'];
            }
            #21636
            //$start = $app['start_info']['hours']*60+$app['start_info']['minutes'];
 
            // end hour for this day
            #21132
            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'];
            }
            //$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;
    }

References $app, $i, $ilUser, $user, ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

◆ showAppointment()

ilCalendarDayGUI::showAppointment ( $a_app )

protected

show appointment

@access protected

Parameters

array appointment

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

    {
        $ilUser = $this->user;
 
        $event_tpl = new ilTemplate('tpl.day_event_view.html', true, true, 'Services/Calendar');
 
        if (!$ilUser->prefs["screen_reader_optimization"]) {
            $event_tpl->setCurrentBlock('app');
        } else {
            $event_tpl->setCurrentBlock('scrd_app');
        }
 
        $this->tpl->setVariable('APP_ROWSPAN', $a_app['rowspan']);
        //$event_tpl->setVariable('APP_TITLE',$a_app['event']->getPresentationTitle(false));
 
        switch ($this->user_settings->getTimeFormat()) {
            case ilCalendarSettings::TIME_FORMAT_24:
                $time = $a_app['event']->getStart()->get(IL_CAL_FKT_DATE, 'H:i', $this->timezone);
                break;
                
            case ilCalendarSettings::TIME_FORMAT_12:
                $time = $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:
                    $time .= "-" . $a_app['event']->getEnd()->get(IL_CAL_FKT_DATE, 'H:i', $this->timezone);
                    break;
                    
                case ilCalendarSettings::TIME_FORMAT_12:
                    $time .= "-" . $a_app['event']->getEnd()->get(IL_CAL_FKT_DATE, 'h:ia', $this->timezone);
                    break;
            }
        }
 
        $shy = $this->getAppointmentShyButton($a_app['event'], $a_app['dstart'], "");
 
        $title = $shy;
        $content = ($time != "")? $time . " " . $title : $title;
 
        $event_tpl->setVariable('EVENT_CONTENT', $content);
 
        $color = $this->app_colors->getColorByAppointment($a_app['event']->getEntryId());
        $event_tpl->setVariable('APP_BGCOLOR', $color);
        //$this->tpl->setVariable('APP_BGCOLOR',$color);
        $event_tpl->setVariable('APP_COLOR', ilCalendarUtil::calculateFontColor($color));
        //$this->tpl->setVariable('APP_COLOR',ilCalendarUtil::calculateFontColor($color));
        $event_tpl->setVariable('APP_ADD_STYLES', $a_app['event']->getPresentationStyle());
        //$this->tpl->setVariable('APP_ADD_STYLES',$a_app['event']->getPresentationStyle());
 
        $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());
        $event_tpl->setVariable('APP_EDIT_LINK', $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'edit'));
 
        if ($event_html_by_plugin = $this->getContentByPlugins($a_app['event'], $a_app['dstart'], $content, $event_tpl)) {
            $event_html = $event_html_by_plugin;
        } else {
            $event_tpl->parseCurrentBlock();
            $event_html = $event_tpl->get();
        }
 
        $this->tpl->setCurrentBlock("event_nfd");
        $this->tpl->setVariable("CONTENT_EVENT_NFD", $event_html);
        $this->tpl->parseCurrentBlock();
 
        $this->num_appointments++;
    }

References $ilUser, $user, ilCalendarUtil\calculateFontColor(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarViewGUI\getContentByPlugins(), IL_CAL_DATE, IL_CAL_FKT_DATE, ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Here is the call graph for this function:

◆ showFulldayAppointment()

ilCalendarDayGUI::showFulldayAppointment ( $a_app )

protected

show fullday appointment

@access protected

Parameters

array appointment

Returns

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

    {
        $f = $this->ui_factory;
        $r = $this->ui_renderer;
 
        $event_tpl = new ilTemplate('tpl.day_event_view.html', true, true, 'Services/Calendar');
 
        // milestone icon
        if ($a_app['event']->isMilestone()) {
            $event_tpl->setCurrentBlock('fullday_ms_icon');
            $event_tpl->setVariable('ALT_FD_MS', $this->lng->txt("cal_milestone"));
            $event_tpl->setVariable('SRC_FD_MS', ilUtil::getImagePath("icon_ms.svg"));
            $event_tpl->parseCurrentBlock();
        }
 
        $event_tpl->setCurrentBlock('fullday_app');
        
        $compl = ($a_app['event']->isMilestone() && $a_app['event']->getCompletion() > 0)
            ? " (" . $a_app['event']->getCompletion() . "%)"
            : "";
 
        $shy = $this->getAppointmentShyButton($a_app['event'], $a_app['dstart'], "");
 
        //$title = ($new_title = $this->getContentByPlugins($a_app['event'], $a_app['dstart'], $shy))? $new_title : $shy;
 
        $content = $shy . $compl;
 
        $event_tpl->setVariable('EVENT_CONTENT', $content);
 
        $color = $this->app_colors->getColorByAppointment($a_app['event']->getEntryId());
        $event_tpl->setVariable('F_APP_BGCOLOR', $color);
        $event_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());
        $event_tpl->setVariable('F_APP_EDIT_LINK', $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'edit'));
 
        if ($event_html_by_plugin = $this->getContentByPlugins($a_app['event'], $a_app['dstart'], $content, $event_tpl)) {
            $body_html = $event_html_by_plugin;
        } else {
            $event_tpl->parseCurrentBlock();
            $body_html = $event_tpl->get();
        }
 
        $this->tpl->setCurrentBlock("content_fd");
        $this->tpl->setVariable("CONTENT_EVENT", $body_html);
        $this->tpl->parseCurrentBlock();
 
        $this->num_appointments++;
    }

References Vendor\Package\$f, ilCalendarViewGUI\$ui_factory, ilCalendarViewGUI\$ui_renderer, ilCalendarUtil\calculateFontColor(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarViewGUI\getContentByPlugins(), ilUtil\getImagePath(), and IL_CAL_DATE.

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCalendarDayGUI::$ctrl

protected

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

Referenced by executeCommand().

◆ $lng

ilCalendarDayGUI::$lng

protected

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

◆ $num_appointments

ilCalendarDayGUI::$num_appointments = 1

protected

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

◆ $seed_info

ilCalendarDayGUI::$seed_info = array()

protected

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

◆ $tabs_gui

ilCalendarDayGUI::$tabs_gui

protected

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

◆ $timezone

ilCalendarDayGUI::$timezone = 'UTC'

protected

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

◆ $toolbar

ilCalendarDayGUI::$toolbar

protected

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

◆ $tpl

ilCalendarDayGUI::$tpl

protected

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

Referenced by executeCommand().

◆ $ui

ilCalendarDayGUI::$ui

protected

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

◆ $user

ilCalendarDayGUI::$user

protected

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

Referenced by calculateColspan(), parseInfoIntoRaster(), and showAppointment().

◆ $user_settings

ilCalendarDayGUI::$user_settings = null

protected

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

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

Services/Calendar/classes/class.ilCalendarDayGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ calculateColspan()

◆ executeCommand()

◆ parseInfoIntoRaster()

◆ showAppointment()

◆ showFulldayAppointment()

Field Documentation

◆ $ctrl

◆ $lng

◆ $num_appointments

◆ $seed_info

◆ $tabs_gui

◆ $timezone

◆ $toolbar

◆ $tpl

◆ $ui

◆ $user

◆ $user_settings