This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCalendarMonthGUI:

Collaboration diagram for ilCalendarMonthGUI:

Public Member Functions
	__construct (ilDate $seed_date)

	setBkId (int $bkid=0)

	initialize (int $a_calendar_presentation_type)

	executeCommand ()

	addScheduleFilter (ilCalendarScheduleFilter $a_filter)
	Add schedule filter. More...

	show ()

	getHTML ()

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
	showEvents (ilCalendarSchedule $scheduler, ilDate $date)

Protected Member Functions inherited from ilCalendarViewGUI
	initAppointmentIdFromQuery ()

	initInitialDateFromQuery ()

	initInitialDateTimeFromQuery ()

	initBookingUserFromQuery ()

Protected Attributes
int	$bkid

int	$num_appointments = 1

array	$schedule_filters = array()

ilCalendarUserSettings	$user_settings

ilCalendarAppointmentColors	$app_colors

string	$timezone = 'UTC'

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_Calls ilCalendarMonthGUI: ilCalendarAppointmentGUI @ilCtrl_Calls ilCalendarMonthGUI: ilCalendarAppointmentPresentationGUI

Definition at line 27 of file class.ilCalendarMonthGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarMonthGUI::__construct ( ilDate $seed_date )

Definition at line 37 of file class.ilCalendarMonthGUI.php.

    {
        parent::__construct($seed_date, ilCalendarViewGUI::CAL_PRESENTATION_MONTH);
        $this->bkid = $this->initBookingUserFromQuery();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addScheduleFilter()

ilCalendarMonthGUI::addScheduleFilter ( ilCalendarScheduleFilter $a_filter )

Add schedule filter.

Definition at line 91 of file class.ilCalendarMonthGUI.php.

                                                                         : void
    {
        $this->schedule_filters[] = $a_filter;
    }

◆ executeCommand()

ilCalendarMonthGUI::executeCommand ( )

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

                                    : void
    {
        $this->ctrl->saveParameter($this, 'seed');
 
        $next_class = $this->ctrl->getNextClass();
        switch ($next_class) {
            case "ilcalendarappointmentpresentationgui":
                $this->ctrl->setReturn($this, "");
                $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:
                $time = microtime(true);
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                $this->main_tpl->setContent($this->tpl->get());
                break;
        }
    }

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

Here is the call graph for this function:

◆ getHTML()

ilCalendarMonthGUI::getHTML ( )

Definition at line 232 of file class.ilCalendarMonthGUI.php.

                             : string
    {
        $this->show();
        return $this->tpl->get();
    }

References show().

Here is the call graph for this function:

◆ initialize()

ilCalendarMonthGUI::initialize ( int $a_calendar_presentation_type )

Reimplemented from ilCalendarViewGUI.

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

                                                                 : void
    {
        parent::initialize($a_calendar_presentation_type);
        $this->tabs_gui->setSubTabActive('app_month');
        $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();
        }
    }

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

Here is the call graph for this function:

◆ setBkId()

ilCalendarMonthGUI::setBkId ( int $bkid = 0 )

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

                                          : void
    {
        $this->bkid = $bkid;
    }

References $bkid.

◆ show()

ilCalendarMonthGUI::show ( )

Definition at line 96 of file class.ilCalendarMonthGUI.php.

                          : void
    {
        $this->tpl = new ilTemplate('tpl.month_view.html', true, true, 'Services/Calendar');
 
        ilYuiUtil::initDragDrop();
 
        $navigation = new ilCalendarHeaderNavigationGUI($this, $this->seed, ilDateTime::MONTH);
        $this->tpl->setVariable('NAVIGATION', $navigation->getHTML());
 
        for ($i = $this->user_settings->getWeekStart(); $i < (7 + $this->user_settings->getWeekStart()); $i++) {
            $this->tpl->setCurrentBlock('month_header_col');
            $this->tpl->setVariable('TXT_WEEKDAY', ilCalendarUtil::_numericDayToString($i, true));
            $this->tpl->parseCurrentBlock();
        }
 
        if ($this->bkid) {
            $user_id = $this->bkid;
            $disable_empty = true;
            $no_add = true;
        } else {
            if ($this->user->getId() == ANONYMOUS_USER_ID) {
                $user_id = $this->user->getId();
                $disable_empty = false;
                $no_add = true;
            } else {
                $user_id = $this->user->getId();
                $disable_empty = false;
                $no_add = false;
            }
        }
 
        $is_portfolio_embedded = false;
        if (ilCalendarCategories::_getInstance()->getMode() == ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION) {
            $no_add = true;
            $is_portfolio_embedded = true;
        }
        $scheduler = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_MONTH, $user_id);
        $scheduler->addSubitemCalendars(true);
        if (sizeof($this->schedule_filters)) {
            foreach ($this->schedule_filters as $filter) {
                $scheduler->addFilter($filter);
            }
        }
        $scheduler->calculate();
 
        $settings = ilCalendarSettings::_getInstance();
 
        $counter = 0;
        foreach (ilCalendarUtil::_buildMonthDayList(
            (int) $this->seed->get(IL_CAL_FKT_DATE, 'm'),
            (int) $this->seed->get(IL_CAL_FKT_DATE, 'Y'),
            $this->user_settings->getWeekStart()
        )->get() as $date) {
            $counter++;
            $has_events = (bool) $this->showEvents($scheduler, $date);
 
            if (!$this->view_with_appointments && $has_events) {
                $this->view_with_appointments = true;
            }
 
            if (!$no_add) {
                $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
                $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'idate', $date->get(IL_CAL_DATE));
                $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'seed', $this->seed->get(IL_CAL_DATE));
                $new_app_url = $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'add');
 
                if ($settings->getEnableGroupMilestones()) {
                    $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
                    $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'seed', $this->seed->get(IL_CAL_DATE));
                    $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'idate', $date->get(IL_CAL_DATE));
                    $new_ms_url = $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'addMilestone');
 
                    $this->tpl->setCurrentBlock("new_ms");
                    $this->tpl->setVariable('DD_ID', $date->get(IL_CAL_UNIX));
                    $this->tpl->setVariable(
                        'DD_TRIGGER',
                        $this->ui_renderer->render($this->ui_factory->symbol()->glyph()->add())
                    );
                    $this->tpl->setVariable('URL_DD_NEW_APP', $new_app_url);
                    $this->tpl->setVariable('TXT_DD_NEW_APP', $this->lng->txt('cal_new_app'));
                    $this->tpl->setVariable('URL_DD_NEW_MS', $new_ms_url);
                    $this->tpl->setVariable('TXT_DD_NEW_MS', $this->lng->txt('cal_new_ms'));
                    $this->tpl->parseCurrentBlock();
                } else {
                    $this->tpl->setCurrentBlock("new_app");
                    $this->tpl->setVariable(
                        'NEW_GLYPH',
                        $this->ui_renderer->render($this->ui_factory->symbol()->glyph()->add($new_app_url))
                    );
                    $this->tpl->parseCurrentBlock();
                }
            }
 
            $day = (int) $date->get(IL_CAL_FKT_DATE, 'j');
            $month = (int) $date->get(IL_CAL_FKT_DATE, 'n');
 
            if ($day == 1) {
                $month_day = '1 ' . ilCalendarUtil::_numericMonthToString($month, false);
            } else {
                $month_day = $day;
            }
 
            if (!$is_portfolio_embedded &&
                (!$disable_empty || $has_events)) {
                $this->tpl->setCurrentBlock('month_day_link');
                $this->ctrl->clearParametersByClass('ilcalendardaygui');
                $this->ctrl->setParameterByClass('ilcalendardaygui', 'seed', $date->get(IL_CAL_DATE));
                $this->tpl->setVariable('OPEN_DAY_VIEW', $this->ctrl->getLinkTargetByClass('ilcalendardaygui', ''));
                $this->ctrl->clearParametersByClass('ilcalendardaygui');
            } else {
                $this->tpl->setCurrentBlock('month_day_no_link');
            }
 
            $this->tpl->setVariable('MONTH_DAY', $month_day);
 
            $this->tpl->parseCurrentBlock();
 
            $this->tpl->setCurrentBlock('month_col');
 
            if (ilCalendarUtil::_isToday($date)) {
                $this->tpl->setVariable('TD_CLASS', 'caltoday');
            } elseif (ilDateTime::_equals($date, $this->seed, IL_CAL_MONTH)) {
                $this->tpl->setVariable('TD_CLASS', 'calstd');
            } elseif (ilDateTime::_before($date, $this->seed, IL_CAL_MONTH)) {
                $this->tpl->setVariable('TD_CLASS', 'calprev');
            } else {
                $this->tpl->setVariable('TD_CLASS', 'calnext');
            }
            $this->tpl->parseCurrentBlock();
            if ($counter && !($counter % 7)) {
                $this->tpl->setCurrentBlock('month_row');
                $this->tpl->parseCurrentBlock();
            }
        }
    }

References $bkid, $i, ILIAS\LTI\ToolProvider\$settings, ilDateTime\_before(), ilCalendarUtil\_buildMonthDayList(), ilDateTime\_equals(), ilCalendarCategories\_getInstance(), ilCalendarSettings\_getInstance(), ilCalendarUtil\_isToday(), ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), IL_CAL_DATE, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_UNIX, ilYuiUtil\initDragDrop(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilCalendarCategories\MODE_PORTFOLIO_CONSULTATION, ilDateTime\MONTH, showEvents(), ilCalendarSchedule\TYPE_MONTH, and ILIAS\Repository\user().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showEvents()

ilCalendarMonthGUI::showEvents	(	ilCalendarSchedule	$scheduler,
		ilDate	$date
	)

protected

Definition at line 238 of file class.ilCalendarMonthGUI.php.

                                                                              : int
    {
        $count = 0;
        $time = '';
        foreach ($scheduler->getByDay($date, $this->timezone) as $item) {
            $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
            $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $item['event']->getEntryId());
 
            $event_tpl = new ilTemplate('tpl.month_event_view.html', true, true, 'Services/Calendar');
            // milestone icon
            if ($item['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();
            }
 
            $compl = ($item['event']->isMilestone() && $item['event']->getCompletion() > 0)
                ? " (" . $item['event']->getCompletion() . "%)"
                : "";
 
            if (!$item['event']->isFullDay()) {
                switch ($this->user_settings->getTimeFormat()) {
                    case ilCalendarSettings::TIME_FORMAT_24:
                        $time = $item['event']->getStart()->get(IL_CAL_FKT_DATE, 'H:i', $this->timezone);
                        break;
 
                    case ilCalendarSettings::TIME_FORMAT_12:
                        $time = $item['event']->getStart()->get(IL_CAL_FKT_DATE, 'h:ia', $this->timezone);
                        break;
                }
            }
 
            //plugins can change the modal title.
            $shy = $this->getAppointmentShyButton($item['event'], (string) $item['dstart'], "");
            $title = ($time != "") ? $time . " " . $shy : $shy;
            $event_html = $title . $compl;
            $event_tpl->setCurrentBlock('il_event');
 
            //Start configuring the default template
            $event_tpl->setVariable(
                'EVENT_EDIT_LINK',
                $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'edit')
            );
            $event_tpl->setVariable('EVENT_NUM', $item['event']->getEntryId());
            $event_tpl->setVariable('EVENT_CONTENT', $event_html);
            $color = $this->app_colors->getColorByAppointment($item['event']->getEntryId());
            $event_tpl->setVariable('EVENT_BGCOLOR', $color);
            $event_tpl->setVariable('EVENT_ADD_STYLES', $item['event']->getPresentationStyle());
            $event_tpl->setVariable('EVENT_FONTCOLOR', ilCalendarUtil::calculateFontColor($color));
 
            //plugins can override the previous template variables. The plugin slot parses the current block because
            //it needs to call the template get method to use the resulting HTML in the replaceContent method.
            if ($event_html_by_plugin = $this->getContentByPlugins(
                $item['event'],
                $item['dstart'],
                $event_html,
                $event_tpl
            )) {
                $event_body_html = $event_html_by_plugin;
            } else {
                $event_tpl->parseCurrentBlock();
                $event_body_html = $event_tpl->get();
            }
 
            $this->tpl->setCurrentBlock("event_nfd");
            $this->tpl->setVariable("EVENT_CONTENT", $event_body_html);
            $this->tpl->parseCurrentBlock();
 
            $this->num_appointments++;
            $count++;
        }
        return $count;
    }