ilCalendarDayGUI Class Reference

Presentation day view. More...

Inheritance diagram for ilCalendarDayGUI:

Collaboration diagram for ilCalendarDayGUI:

Public Member Functions
	__construct (ilDate $seed_date)
	initialize (int $a_calendar_presentation_type)
	executeCommand ()
Public Member Functions inherited from ilCalendarViewGUI
	__construct (ilDate $seed, int $presentation_type)
	setConsulationHoursUserId (int $a_user_id)
	getConsultationHoursUserId ()
	initialize (int $a_calendar_presentation_type)
	getCurrentApp ()
	getEvents ()
	getDatesForItem ($item)
	getModalForApp ()
	Get modal for appointment (see similar code in ilCalendarBlockGUI) More...
	getAppointmentShyButton (ilCalendarEntry $a_calendar_entry, string $a_dstart, string $a_title_forced="")
	getActivePlugins (string $a_slot_id)
	getModalTitleByPlugins (string $a_current_title)
	getContentByPlugins (ilCalendarEntry $a_cal_entry, int $a_start_date, string $a_content, ilTemplate $a_tpl)
	addToolbarFileDownload ()
	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
	show ()
	fill data section protected More...
	showFulldayAppointment (array $a_app)
	showAppointment (array $a_app)
	parseInfoIntoRaster (array $daily_apps, int $morning_aggr, int $evening_aggr, int $raster)
	calculate overlapping hours More...
	calculateColspan (array $hours)
Protected Member Functions inherited from ilCalendarViewGUI
	initAppointmentIdFromQuery ()
	initInitialDateFromQuery ()
	initInitialDateTimeFromQuery ()
	initBookingUserFromQuery ()

Protected Attributes
array	$seed_info = []
ilCalendarUserSettings	$user_settings
int	$num_appointments = 1
string	$timezone = 'UTC'
ilCalendarAppointmentColors	$app_colors
Protected Attributes inherited from ilCalendarViewGUI
int	$presentation_type = self::CAL_PRESENTATION_UNDEFINED
bool	$view_with_appointments = false
ilDate	$seed
int	$ch_user_id = 0
string	$period_end_day = null
Factory	$ui_factory
Renderer	$ui_renderer
ilCtrlInterface	$ctrl
ilToolbarGUI	$toolbar
ilLogger	$logger
ILIAS DI UIServices	$ui
ilLanguage	$lng
ilObjUser	$user
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilComponentFactory	$component_factory
ilTabsGUI	$tabs_gui
RefineryFactory	$refinery
HttpServices	$http

Additional Inherited Members
Data Fields inherited from ilCalendarViewGUI
const	CAL_PRESENTATION_UNDEFINED = 0
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 ilCalendarDayGUI: ilCalendarAppointmentGUI ilCalendarDayGUI: ilCalendarAppointmentPresentationGUI

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

Constructor & Destructor Documentation

__construct()

ilCalendarDayGUI::__construct

(

ilDate

$seed_date

)

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilCalendarViewGUI\CAL_PRESENTATION_DAY.

    {
        parent::__construct($seed_date, ilCalendarViewGUI::CAL_PRESENTATION_DAY);
    }

Here is the call graph for this function:

Member Function Documentation

calculateColspan()

ilCalendarDayGUI::calculateColspan ( array  $hours )

protected

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

Referenced by show().

                                                     : int
    {
        $colspan = 1;
        foreach ($hours as $hour) {
            $colspan = max($colspan, $hour['apps_num'] + 1);
        }
        return max($colspan, 2);
    }

Here is the caller graph for this function:

executeCommand()

ilCalendarDayGUI::executeCommand

(

)

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

References ilCalendarAppointmentPresentationGUI\_getInstance(), ILIAS\Repository\ctrl(), ilSession\get(), ilCalendarViewGUI\getCurrentApp(), IL_CAL_DATE, ilCalendarViewGUI\initAppointmentIdFromQuery(), ilCalendarViewGUI\initInitialDateFromQuery(), and ILIAS\Repository\logger().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass();
        switch ($next_class) {
            case "ilcalendarappointmentpresentationgui":
                $this->ctrl->setReturn($this, "");
                $this->logger->debug("-ExecCommand - representation of ilDate: this->seed->get(IL_CAL_DATE) = " . $this->seed->get(IL_CAL_DATE));
                $gui = ilCalendarAppointmentPresentationGUI::_getInstance($this->seed, (array) $this->getCurrentApp());
                $this->ctrl->forwardCommand($gui);
                break;
            case 'ilcalendarappointmentgui':
                $this->ctrl->setReturn($this, '');
                $this->tabs_gui->setSubTabActive((string) ilSession::get('cal_last_tab'));

                // initial date for new calendar appointments
                $idate = new ilDate($this->initInitialDateFromQuery(), IL_CAL_DATE);
                $app = new ilCalendarAppointmentGUI($this->seed, $idate, $this->initAppointmentIdFromQuery());
                $this->ctrl->forwardCommand($app);
                break;

            default:
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                $this->main_tpl->setContent($this->tpl->get());
                break;
        }
    }

Here is the call graph for this function:

initialize()

ilCalendarDayGUI::initialize

(

int

$a_calendar_presentation_type

)

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

References $DIC, ilCalendarUserSettings\_getInstanceByUserId(), IL_CAL_FKT_GETDATE, and ILIAS\Repository\user().

                                                                 : void
    {
        global $DIC;

        parent::initialize($a_calendar_presentation_type);
        $this->seed_info = (array) $this->seed->get(IL_CAL_FKT_GETDATE);
        $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
        $this->app_colors = new ilCalendarAppointmentColors($this->user->getId());
        if ($this->user->getTimeZone()) {
            $this->timezone = $this->user->getTimeZone();
        }
    }

Here is the call graph for this function:

parseInfoIntoRaster()

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

protected

calculate overlapping hours

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

References ILIAS\Repository\logger(), ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by show().

                                                                                                                : array
    {
        $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 {
                        if (!isset($hours[$i]['txt'])) {
                            $hours[$i]['txt'] = sprintf('%02d:%02d', floor($i / 60), $i % 60);
                        } else {
                            $hours[$i]['txt'] .= sprintf('%02d:%02d', floor($i / 60), $i % 60);
                        }
                    }
                    if ($evening_aggr < 23 * 60 && $i == $evening_aggr) {
                        if (!isset($hours[$i]['txt'])) {
                            $hours[$i]['txt'] = ' - ' . sprintf('%02d:00', 0);
                        } else {
                            $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((int) floor($i / 60), $i % 60, 0, 1, 1, 2000));
                    }
                    if ($evening_aggr < 23 * 60 && $i == $evening_aggr) {
                        if (!isset($hours[$i]['txt'])) {
                            $hours[$i]['txt'] = ' - ' . date('h a', mktime(0, 0, 0, 1, 1, 2000));
                        } else {
                            $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

            // 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'];
            }

            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) {
                    $app['rowspan'] = ceil(($end - $start) / $raster);
                    $hours[$i]['apps_start'][] = $app;
                    $first = false;
                }
                $hours[$i]['apps_num']++;
            }
        }
        return $hours;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

show()

ilCalendarDayGUI::show ( )

protected

fill data section protected

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

References $user_id, ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), ANONYMOUS_USER_ID, calculateColspan(), ILIAS\Repository\ctrl(), ilDateTime\DAY, IL_CAL_DATE, ilCalendarViewGUI\initBookingUserFromQuery(), ilYuiUtil\initDragDrop(), ILIAS\Repository\lng(), parseInfoIntoRaster(), showAppointment(), showFulldayAppointment(), ilCalendarSchedule\TYPE_DAY, and ILIAS\Repository\user().

                             : void
    {
        // 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, 'components/ILIAS/Calendar');

        ilYuiUtil::initDragDrop();

        $bkid = $this->initBookingUserFromQuery();
        if ($bkid) {
            $user_id = $bkid;
            $no_add = true;
        } elseif ($this->user->getId() == ANONYMOUS_USER_ID) {
            $user_id = $this->user->getId();
            $no_add = true;
        } else {
            $user_id = $this->user->getId();
            $no_add = false;
        }
        $scheduler = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_DAY, $user_id);
        $scheduler->addSubitemCalendars(true);
        $scheduler->calculate();
        $daily_apps = $scheduler->getByDay($this->seed, $this->timezone);

        //display the download files button.
        if (count($daily_apps)) {
            $this->view_with_appointments = true;
        }

        $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));

        if (!$no_add) {
            $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'seed', $this->seed->get(IL_CAL_DATE));
            $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'idate', $this->seed->get(IL_CAL_DATE));
            $new_app_url = $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'add');

            $this->tpl->setCurrentBlock("new_app1");
            $this->tpl->setVariable(
                'H_NEW_APP_GLYPH',
                $this->ui_renderer->render($this->ui_factory->symbol()->glyph()->add($new_app_url))
            );
            $this->tpl->parseCurrentBlock();

            $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
        }

        $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((int) $this->seed_info['wday'], true)
        );
        $this->tpl->setVariable('HCOLSPAN', $colspan - 1);

        $this->tpl->setVariable('TXT_TIME', $this->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', $this->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_GLYPH',
                        $this->ui_renderer->render($this->ui_factory->symbol()->glyph()->add(
                            $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'add')
                        ))
                    );
                    $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);
            }

            for ($i = ($colspan - 1); $i > $hour['apps_num']; $i--) {
                $this->tpl->setCurrentBlock('empty_cell');
                $this->tpl->setVariable('EMPTY_WIDTH', (100 / ($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:

showAppointment()

ilCalendarDayGUI::showAppointment ( array  $a_app )

protected

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

References ilCalendarUtil\calculateFontColor(), ILIAS\Repository\ctrl(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarViewGUI\getContentByPlugins(), IL_CAL_DATE, IL_CAL_FKT_DATE, ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by show().

                                                    : void
    {
        $event_tpl = new ilTemplate('tpl.day_event_view.html', true, true, 'components/ILIAS/Calendar');
        $event_tpl->setCurrentBlock('app');
        $this->tpl->setVariable('APP_ROWSPAN', $a_app['rowspan']);
        $time = '';
        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;
        }

        $shy = $this->getAppointmentShyButton($a_app['event'], (string) $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);
        $event_tpl->setVariable('APP_COLOR', ilCalendarUtil::calculateFontColor($color));
        $event_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++;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showFulldayAppointment()

ilCalendarDayGUI::showFulldayAppointment ( array  $a_app )

protected

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

References ilCalendarUtil\calculateFontColor(), ILIAS\Repository\ctrl(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarViewGUI\getContentByPlugins(), and IL_CAL_DATE.

Referenced by show().

                                                           : void
    {
        $event_tpl = new ilTemplate('tpl.day_event_view.html', true, true, 'components/ILIAS/Calendar');

        $event_tpl->setCurrentBlock('fullday_app');

        $content = $this->getAppointmentShyButton($a_app['event'], (string) $a_app['dstart'], "");

        $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++;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$app_colors

ilCalendarAppointmentColors ilCalendarDayGUI::$app_colors

protected

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

$num_appointments

int ilCalendarDayGUI::$num_appointments = 1

protected

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

$seed_info

array ilCalendarDayGUI::$seed_info = []

protected

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

$timezone

string ilCalendarDayGUI::$timezone = 'UTC'

protected

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

$user_settings

ilCalendarUserSettings ilCalendarDayGUI::$user_settings

protected

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

---

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

• components/ILIAS/Calendar/classes/class.ilCalendarDayGUI.php