Inheritance diagram for ilCalendarViewGUI:

Collaboration diagram for ilCalendarViewGUI:

Public Member Functions
	__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...

Data Fields
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

Protected Member Functions
	initAppointmentIdFromQuery ()

	initInitialDateFromQuery ()

	initInitialDateTimeFromQuery ()

	initBookingUserFromQuery ()

Protected Attributes
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

Detailed Description

Author: Jesús López Reyes lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarViewGUI::__construct	(	ilDate	$seed,
		int	$presentation_type
	)

Definition at line 61 of file class.ilCalendarViewGUI.php.

References $seed, and initialize().

     {
         $this->seed = $seed;
         $this->initialize($presentation_type);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addToolbarFileDownload()

ilCalendarViewGUI::addToolbarFileDownload ( )

Add download link to toolbar.

Definition at line 396 of file class.ilCalendarViewGUI.php.

References $ctrl, Vendor\Package\$f, $lng, $toolbar, $ui_factory, ilCalendarSettings\_getInstance(), ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), countEventsInView(), ilCtrlInterface\getLinkTarget(), and ILIAS\Repository\lng().

                                             : void
     {
         $settings = ilCalendarSettings::_getInstance();
 
         if ($settings->isBatchFileDownloadsEnabled()) {
             $num_events = 0;
             if ($this->presentation_type == self::CAL_PRESENTATION_AGENDA_LIST) {
                 $num_events = $this->countEventsInView();
             }
             if ($this->view_with_appointments || $num_events) {
                 $toolbar = $this->toolbar;
                 $f = $this->ui_factory;
                 $lng = $this->lng;
                 $ctrl = $this->ctrl;
 
                 // file download
                 $add_button = $f->button()->standard(
                     $this->lng->txt("cal_download_files"),
                     $ctrl->getLinkTarget($this, "downloadFiles")
                 );
                 $toolbar->addSeparator();
                 $toolbar->addComponent($add_button);
             }
         }
     }

Here is the call graph for this function:

◆ countEventsInView()

ilCalendarViewGUI::countEventsInView ( )

get the events starting between 2 dates based in seed + view options.

Returns: int number of events in the calendar list view.

Definition at line 488 of file class.ilCalendarViewGUI.php.

References $seed, getEvents(), ilCalendarAgendaListGUI\getPeriod(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_MONTH, ilCalendarAgendaListGUI\PERIOD_DAY, ilCalendarAgendaListGUI\PERIOD_HALF_YEAR, ilCalendarAgendaListGUI\PERIOD_MONTH, and ilCalendarAgendaListGUI\PERIOD_WEEK.

Referenced by addToolbarFileDownload().

                                        : int
     {
         $start = $this->seed;
         $end = clone $start;
         $get_list_option = ilCalendarAgendaListGUI::getPeriod();
         switch ($get_list_option) {
             case ilCalendarAgendaListGUI::PERIOD_DAY:
                 break;
             case ilCalendarAgendaListGUI::PERIOD_MONTH:
                 $end->increment(IL_CAL_MONTH, 1);
                 break;
             case ilCalendarAgendaListGUI::PERIOD_HALF_YEAR:
                 $end->increment(IL_CAL_MONTH, 6);
                 break;
             case ilCalendarAgendaListGUI::PERIOD_WEEK:
             default:
                 $end->increment(IL_CAL_DAY, 7);
                 break;
         }
         $events = $this->getEvents();
         $num_events = 0;
         foreach ($events as $event) {
             $event_start = $event['event']->getStart()->get(IL_CAL_DATE);
 
             if ($event_start >= $start->get(IL_CAL_DATE) && $event_start <= $end->get(IL_CAL_DATE)) {
                 $num_events++;
             }
         }
         return $num_events;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadFiles()

ilCalendarViewGUI::downloadFiles ( )

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

Not modals

Definition at line 425 of file class.ilCalendarViewGUI.php.

References ILIAS\Repository\ctrl(), getBucketTitle(), getEvents(), ILIAS\Repository\lng(), ilDownloadFilesBackgroundTask\setBucketTitle(), and ILIAS\Repository\user().

                                    : void
     {
         $download_job = new ilDownloadFilesBackgroundTask($this->user->getId());
         $download_job->setBucketTitle($this->getBucketTitle());
         $download_job->setEvents($this->getEvents());
         if ($download_job->run()) {
             $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('cal_download_files_started'), true);
         }
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

◆ getActivePlugins()

ilCalendarViewGUI::getActivePlugins ( string $a_slot_id )

Parameters

string $a_slot_id

Returns: Iterator <ilPlugin>

Definition at line 330 of file class.ilCalendarViewGUI.php.

Referenced by getContentByPlugins(), getModalTitleByPlugins(), and ilCalendarAgendaListGUI\getPluginAgendaItem().

                                                        : Iterator
     {
         return $this->component_factory->getActivePluginsInSlot($a_slot_id);
     }

Here is the caller graph for this function:

◆ getAppointmentShyButton()

ilCalendarViewGUI::getAppointmentShyButton	(	ilCalendarEntry	$a_calendar_entry,
		string	$a_dstart,
		string	$a_title_forced = `""`
	)

Parameters

ilCalendarEntry	$a_calendar_entry
string	$a_dstart
string	$a_title_forced	//used in plugins to rename the shy button title.

Returns: string shy button html

Definition at line 283 of file class.ilCalendarViewGUI.php.

References $url, ILIAS\Repository\ctrl(), getConsultationHoursUserId(), ilCalendarEntry\getEntryId(), ilCalendarEntry\getPresentationTitle(), ilCalendarEntry\getStart(), IL_CAL_DATE, IL_CAL_FKT_DATE, initAppointmentIdFromQuery(), initInitialDateTimeFromQuery(), ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by getContentByPlugins(), ilCalendarWeekGUI\showAppointment(), ilCalendarDayGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), ilCalendarWeekGUI\showFulldayAppointment(), and ilCalendarDayGUI\showFulldayAppointment().

      : string {
         $this->ctrl->setParameter($this, "app_id", $a_calendar_entry->getEntryId());
 
         if ($this->getConsultationHoursUserId()) {
             $this->ctrl->setParameter($this, 'chuid', $this->getConsultationHoursUserId());
         }
         $this->ctrl->setParameter($this, 'dt', $a_dstart);
         $this->ctrl->setParameter($this, 'seed', $this->seed->get(IL_CAL_DATE));
         $url = $this->ctrl->getLinkTarget($this, "getModalForApp", "", true, false);
         $this->ctrl->setParameter($this, "app_id", $this->initAppointmentIdFromQuery());
         $this->ctrl->setParameter($this, "dt", $this->initInitialDateTimeFromQuery());
         $this->ctrl->setParameter($this, 'seed', $this->seed->get(IL_CAL_DATE));
 
         $modal = $this->ui_factory->modal()->roundtrip('', [])->withAsyncRenderUrl($url);
 
         //Day view presents the titles with the full length.(agenda:class.ilCalendarAgendaListGUI.php)
         if ($this->presentation_type == self::CAL_PRESENTATION_DAY) {
             $title = ($a_title_forced == "") ? $a_calendar_entry->getPresentationTitle(false) : $a_title_forced;
         } else {
             $title = ($a_title_forced == "") ? $a_calendar_entry->getPresentationTitle() : $a_title_forced;
         }
 
         // aria label including start time
         $start_time = '';
         switch ($this->user_settings->getTimeFormat()) {
             case ilCalendarSettings::TIME_FORMAT_24:
                 $start_time = $a_calendar_entry->getStart()->get(IL_CAL_FKT_DATE, 'H:i', $this->timezone);
                 break;
 
             case ilCalendarSettings::TIME_FORMAT_12:
                 $start_time = $a_calendar_entry->getStart()->get(IL_CAL_FKT_DATE, 'h:ia', $this->timezone);
                 break;
         }
         $aria_label = $start_time . ' - ' . $title;
 
         $comps = [$this->ui_factory->button()->shy($title, "#")->withAriaLabel($aria_label)->withOnClick($modal->getShowSignal()), $modal];
         return $this->ui_renderer->render($comps);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBucketTitle()

ilCalendarViewGUI::getBucketTitle ( )

get proper label to add in the background task popover

Definition at line 439 of file class.ilCalendarViewGUI.php.

References ilCalendarUtil\_buildWeekDayList(), ilCalendarUserSettings\_getInstanceByUserId(), IL_CAL_DATE, IL_CAL_FKT_DATE, ILIAS\Repository\lng(), ilCalendarAgendaListGUI\PERIOD_DAY, ilCalendarAgendaListGUI\PERIOD_HALF_YEAR, ilCalendarAgendaListGUI\PERIOD_MONTH, ilCalendarAgendaListGUI\PERIOD_WEEK, and ILIAS\Repository\user().

Referenced by downloadFiles().

                                     : string
     {
         //definition of bucket titles here: 21365
         $user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
         $bucket_title = $this->lng->txt("cal_calendar_download");
 
         switch ($this->presentation_type) {
             case self::CAL_PRESENTATION_DAY:
                 $bucket_title .= " " . $this->seed->get(IL_CAL_DATE);
                 break;
             case self::CAL_PRESENTATION_WEEK:
                 $weekday_list = ilCalendarUtil::_buildWeekDayList($this->seed, $user_settings->getWeekStart())->get();
                 $start = current($weekday_list);
                 $char = strtolower(mb_substr($this->lng->txt("week"), 0, 1));
                 $bucket_title .= " " . $start->get(IL_CAL_DATE) . " 1$char";
                 break;
             case self::CAL_PRESENTATION_MONTH:
                 $year_month = $this->seed->get(IL_CAL_FKT_DATE, 'Y-m', 'UTC');
                 $char = strtolower(mb_substr($this->lng->txt("month"), 0, 1));
                 $bucket_title .= " " . $year_month . " 1" . $char;
                 break;
             case self::CAL_PRESENTATION_AGENDA_LIST:
                 $bucket_title .= " " . $this->seed->get(IL_CAL_DATE);
                 $get_list_option = intval($this->user->getPref('cal_list_view'));
                 switch ($get_list_option) {
                     case ilCalendarAgendaListGUI::PERIOD_DAY:
                         break;
                     case ilCalendarAgendaListGUI::PERIOD_MONTH:
                         $char = strtolower(mb_substr($this->lng->txt("month"), 0, 1));
                         $bucket_title .= " 1$char";
                         break;
                     case ilCalendarAgendaListGUI::PERIOD_HALF_YEAR:
                         $char = strtolower(mb_substr($this->lng->txt("month"), 0, 1));
                         $bucket_title .= " 6$char";
                         break;
                     case ilCalendarAgendaListGUI::PERIOD_WEEK:
                     default:
                         $char = strtolower(mb_substr($this->lng->txt("week"), 0, 1));
                         $bucket_title .= " 1$char";
                         break;
                 }
         }
         return $bucket_title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConsultationHoursUserId()

ilCalendarViewGUI::getConsultationHoursUserId ( )

Definition at line 72 of file class.ilCalendarViewGUI.php.

References $ch_user_id.

Referenced by getAppointmentShyButton().

                                                 : int
     {
         return $this->ch_user_id;
     }

Here is the caller graph for this function:

◆ getContentByPlugins()

ilCalendarViewGUI::getContentByPlugins	(	ilCalendarEntry	$a_cal_entry,
		int	$a_start_date,
		string	$a_content,
		ilTemplate	$a_tpl
	)

Parameters

ilCalendarEntry	$a_cal_entry
int	$a_start_date
string	$a_content
ilTemplate	$a_tpl	needed to adding elements in the template like extra content inside the event container

Returns: string

Definition at line 353 of file class.ilCalendarViewGUI.php.

References XapiProxy\$plugin, ilTemplate\get(), getActivePlugins(), getAppointmentShyButton(), IL_CAL_UNIX, ilTemplate\parseCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by ilCalendarWeekGUI\showAppointment(), ilCalendarDayGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), ilCalendarWeekGUI\showFulldayAppointment(), and ilCalendarDayGUI\showFulldayAppointment().

      : string {
         $content = $a_content;
 
         //"capg" is the plugin slot id for AppointmentCustomGrid
         foreach ($this->getActivePlugins("capg") as $plugin) {
             $plugin->setAppointment($a_cal_entry, new ilDateTime($a_start_date, IL_CAL_UNIX));
 
             if ($new_title = $plugin->editShyButtonTitle()) {
                 $a_tpl->setVariable(
                     'EVENT_CONTENT',
                     $this->getAppointmentShyButton($a_cal_entry, (string) $a_start_date, $new_title)
                 );
             }
 
             if ($glyph = $plugin->addGlyph()) {
                 $a_tpl->setVariable('EXTRA_GLYPH_BY_PLUGIN', $glyph);
             }
 
             if ($more_content = $plugin->addExtraContent()) {
                 $a_tpl->setVariable('EXTRA_CONTENT_BY_PLUGIN', $more_content);
             }
 
             $a_tpl->parseCurrentBlock();
             $html_content = $a_tpl->get();
 
             if ($new_content = $plugin->replaceContent($html_content)) {
                 $content = $new_content;
             }
         }
         if ($content == $a_content) {
             return '';
         }
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentApp()

ilCalendarViewGUI::getCurrentApp ( )

Definition at line 147 of file class.ilCalendarViewGUI.php.

References getEvents(), initAppointmentIdFromQuery(), and null.

Referenced by ilCalendarDayGUI\executeCommand(), ilCalendarMonthGUI\executeCommand(), ilCalendarWeekGUI\executeCommand(), and ilCalendarAgendaListGUI\executeCommand().

                                    : ?array
     {
         // @todo: this needs optimization
         $events = $this->getEvents();
         foreach ($events as $item) {
             if ($item["event"]->getEntryId() == $this->initAppointmentIdFromQuery()) {
                 return $item;
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatesForItem()

ilCalendarViewGUI::getDatesForItem ( $item )

Parameters

$item

Returns: array<{start: ilDate|ilDateTime, end: ilDate|ilDateTime}>

Exceptions

ilDateTimeException

Definition at line 230 of file class.ilCalendarViewGUI.php.

References IL_CAL_UNIX.

Referenced by getModalForApp().

                                           : array
     {
         $start = $item["dstart"];
         $end = $item["dend"];
         if ($item["fullday"]) {
             $start = new ilDate($start, IL_CAL_UNIX);
             $end = new ilDate($end, IL_CAL_UNIX);
         } else {
             $start = new ilDateTime($start, IL_CAL_UNIX);
             $end = new ilDateTime($end, IL_CAL_UNIX);
         }
         return array("start" => $start, "end" => $end);
     }

Here is the caller graph for this function:

◆ getEvents()

ilCalendarViewGUI::getEvents ( )

Definition at line 159 of file class.ilCalendarViewGUI.php.

References $seed, ilCalendarAgendaListGUI\getPeriod(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_MONTH, IL_CAL_WEEK, null, ilCalendarAgendaListGUI\PERIOD_DAY, ilCalendarAgendaListGUI\PERIOD_HALF_YEAR, ilCalendarAgendaListGUI\PERIOD_MONTH, ilCalendarAgendaListGUI\PERIOD_WEEK, ilCalendarSchedule\TYPE_DAY, ilCalendarSchedule\TYPE_HALF_YEAR, ilCalendarSchedule\TYPE_MONTH, ilCalendarSchedule\TYPE_WEEK, and ILIAS\Repository\user().

Referenced by countEventsInView(), downloadFiles(), getCurrentApp(), ilCalendarAgendaListGUI\getHTML(), and getModalForApp().

                                : array
     {
         $user = $this->user->getId();
         $schedule = null;
         switch ($this->presentation_type) {
             case self::CAL_PRESENTATION_AGENDA_LIST:
                 $end_date = clone $this->seed;
                 switch (ilCalendarAgendaListGUI::getPeriod()) {
                     case ilCalendarAgendaListGUI::PERIOD_DAY:
                         $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_DAY, $user, true);
                         $end_date->increment(IL_CAL_DAY, 1);
                         break;
 
                     case ilCalendarAgendaListGUI::PERIOD_WEEK:
                         $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_WEEK, $user, true);
                         $end_date->increment(IL_CAL_WEEK, 1);
                         break;
 
                     case ilCalendarAgendaListGUI::PERIOD_MONTH:
                         $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_MONTH, $user, true);
                         $end_date->increment(IL_CAL_MONTH, 1);
                         break;
 
                     case ilCalendarAgendaListGUI::PERIOD_HALF_YEAR:
                         $schedule = new ilCalendarSchedule(
                             $this->seed,
                             ilCalendarSchedule::TYPE_HALF_YEAR,
                             $user,
                             true
                         );
                         $end_date->increment(IL_CAL_MONTH, 6);
                         break;
                     default:
                         // default is week ?!
                         $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_WEEK, $user, true);
                         $end_date->increment(IL_CAL_WEEK, 1);
                         break;
                 }
                 $this->period_end_day = $end_date->get(IL_CAL_DATE);
                 $schedule->setPeriod($this->seed, $end_date);
 
                 //}
                 /*else
                 {
                     $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_PD_UPCOMING);
                 }*/
 
                 break;
             case self::CAL_PRESENTATION_DAY:
                 $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_DAY, $user, true);
                 break;
             case self::CAL_PRESENTATION_WEEK:
                 $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_WEEK, $user, true);
                 break;
             case self::CAL_PRESENTATION_MONTH:
                 // if we put the user and true in the call method we will get only events and
                 // files from the current month. Not from 6 days before and after.
                 $schedule = new ilCalendarSchedule($this->seed, ilCalendarSchedule::TYPE_MONTH);
                 break;
         }
 
         $schedule->addSubitemCalendars(true);
         $schedule->calculate();
         return $schedule->getScheduledEvents();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModalForApp()

ilCalendarViewGUI::getModalForApp ( )

Get modal for appointment (see similar code in ilCalendarBlockGUI)

Todo:: fix envent initialisation

Definition at line 248 of file class.ilCalendarViewGUI.php.

References ilCalendarAppointmentPresentationGUI\_getInstance(), ILIAS\Repository\ctrl(), exit, ilDatePresentation\formatPeriod(), getDatesForItem(), getEvents(), getModalTitleByPlugins(), initAppointmentIdFromQuery(), initInitialDateTimeFromQuery(), and ILIAS\Repository\lng().

                                     : void
     {
         // set return class
         $this->ctrl->setReturn($this, '');
 
         // @todo: this needs optimization
         $events = $this->getEvents();
 
         //item => array containing ilcalendary object, dstart of the event , dend etc.
         foreach ($events as $item) {
             if ($item["event"]->getEntryId() == $this->initAppointmentIdFromQuery() && $item['dstart'] == $this->initInitialDateTimeFromQuery()) {
                 $dates = $this->getDatesForItem($item);
                 // content of modal
                 $next_gui = ilCalendarAppointmentPresentationGUI::_getInstance($this->seed, $item);
                 $content = $this->ctrl->getHTML($next_gui);
 
                 //plugins can change the modal title.
                 $modal_title = ilDatePresentation::formatPeriod($dates["start"], $dates["end"]);
                 $modal_title = $this->getModalTitleByPlugins($modal_title);
                 $modal = $this->ui_factory->modal()->roundtrip(
                     $modal_title,
                     $this->ui_factory->legacy()->content($content)
                 )->withCancelButtonLabel($this->lng->txt("close"));
                 echo $this->ui_renderer->renderAsync($modal);
             }
         }
         exit();
     }

Here is the call graph for this function:

◆ getModalTitleByPlugins()

ilCalendarViewGUI::getModalTitleByPlugins ( string $a_current_title )

Definition at line 335 of file class.ilCalendarViewGUI.php.

References XapiProxy\$plugin, and getActivePlugins().

Referenced by getModalForApp().

                                                                    : string
     {
         $modal_title = $a_current_title;
         //demo of plugin execution.
         //"capm" is the plugin slot id for Appointment presentations (modals)
         foreach ($this->getActivePlugins("capm") as $plugin) {
             $modal_title = ($new_title = $plugin->editModalTitle($a_current_title)) ? $new_title : $a_current_title;
         }
         return $modal_title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAppointmentIdFromQuery()

ilCalendarViewGUI::initAppointmentIdFromQuery ( )

protected

Definition at line 103 of file class.ilCalendarViewGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilCalendarDayGUI\executeCommand(), ilCalendarInboxGUI\executeCommand(), ilCalendarMonthGUI\executeCommand(), ilCalendarWeekGUI\executeCommand(), getAppointmentShyButton(), getCurrentApp(), ilCalendarAgendaListGUI\getHTML(), and getModalForApp().

                                                    : int
     {
         if ($this->http->wrapper()->query()->has('app_id')) {
             return $this->http->wrapper()->query()->retrieve(
                 'app_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBookingUserFromQuery()

ilCalendarViewGUI::initBookingUserFromQuery ( )

protected

Definition at line 136 of file class.ilCalendarViewGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilCalendarMonthGUI\__construct(), ilCalendarWeekGUI\setUpCalendar(), and ilCalendarDayGUI\show().

                                                  : int
     {
         if ($this->http->wrapper()->query()->has('bkid')) {
             return $this->http->wrapper()->query()->retrieve(
                 'bkid',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize()

ilCalendarViewGUI::initialize ( int $a_calendar_presentation_type )

Definition at line 77 of file class.ilCalendarViewGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), iljQueryUtil\initjQuery(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by __construct().

                                                                  : void
     {
         global $DIC;
 
         $this->component_factory = $DIC['component.factory'];
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->ui = $DIC->ui();
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->tabs_gui = $DIC->tabs();
         $this->toolbar = $DIC->toolbar();
         $this->presentation_type = $a_calendar_presentation_type;
         $this->logger = $DIC->logger()->cal();
         $this->view_with_appointments = false;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         if ($this->presentation_type == self::CAL_PRESENTATION_DAY ||
             $this->presentation_type == self::CAL_PRESENTATION_WEEK) {
             iljQueryUtil::initjQuery($this->main_tpl);
             $this->main_tpl->addJavaScript('assets/js/calendar_appointment.js');
         }
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initInitialDateFromQuery()

ilCalendarViewGUI::initInitialDateFromQuery ( )

protected

Definition at line 114 of file class.ilCalendarViewGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilCalendarDayGUI\executeCommand(), ilCalendarMonthGUI\executeCommand(), and ilCalendarWeekGUI\executeCommand().

                                                  : string
     {
         if ($this->http->wrapper()->query()->has('idate')) {
             return $this->http->wrapper()->query()->retrieve(
                 'idate',
                 $this->refinery->kindlyTo()->string()
             );
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initInitialDateTimeFromQuery()

ilCalendarViewGUI::initInitialDateTimeFromQuery ( )

protected

Definition at line 125 of file class.ilCalendarViewGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by getAppointmentShyButton(), ilCalendarAgendaListGUI\getHTML(), and getModalForApp().

                                                      : int
     {
         if ($this->http->wrapper()->query()->has('dt')) {
             return $this->http->wrapper()->query()->retrieve(
                 'dt',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConsulationHoursUserId()

ilCalendarViewGUI::setConsulationHoursUserId ( int $a_user_id )

Definition at line 67 of file class.ilCalendarViewGUI.php.

                                                              : void
     {
         $this->ch_user_id = $a_user_id;
     }

Field Documentation

◆ $ch_user_id

int ilCalendarViewGUI::$ch_user_id = 0

protected

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

Referenced by getConsultationHoursUserId().

◆ $component_factory

ilComponentFactory ilCalendarViewGUI::$component_factory

protected

Definition at line 56 of file class.ilCalendarViewGUI.php.

◆ $ctrl

ilCtrlInterface ilCalendarViewGUI::$ctrl

protected

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

Referenced by addToolbarFileDownload().

◆ $http

HttpServices ilCalendarViewGUI::$http

protected

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

◆ $lng

ilLanguage ilCalendarViewGUI::$lng

protected

Definition at line 52 of file class.ilCalendarViewGUI.php.

Referenced by addToolbarFileDownload().

◆ $logger

ilLogger ilCalendarViewGUI::$logger

protected

Definition at line 50 of file class.ilCalendarViewGUI.php.

◆ $main_tpl

ilGlobalTemplateInterface ilCalendarViewGUI::$main_tpl

protected

Definition at line 55 of file class.ilCalendarViewGUI.php.

◆ $period_end_day

string ilCalendarViewGUI::$period_end_day = null

protected

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

◆ $presentation_type

int ilCalendarViewGUI::$presentation_type = self::CAL_PRESENTATION_UNDEFINED

protected

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

◆ $refinery

RefineryFactory ilCalendarViewGUI::$refinery

protected

Definition at line 58 of file class.ilCalendarViewGUI.php.

◆ $seed

ilDate ilCalendarViewGUI::$seed

protected

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

Referenced by __construct(), countEventsInView(), getEvents(), and ilCalendarAgendaListGUI\initEndPeriod().

◆ $tabs_gui

ilTabsGUI ilCalendarViewGUI::$tabs_gui

protected

Definition at line 57 of file class.ilCalendarViewGUI.php.

◆ $toolbar

ilToolbarGUI ilCalendarViewGUI::$toolbar

protected

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

Referenced by addToolbarFileDownload().

◆ $tpl

ilTemplate ilCalendarViewGUI::$tpl

protected

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

◆ $ui

ILIAS DI UIServices ilCalendarViewGUI::$ui

protected

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

◆ $ui_factory

Factory ilCalendarViewGUI::$ui_factory

protected

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

Referenced by addToolbarFileDownload().

◆ $ui_renderer

Renderer ilCalendarViewGUI::$ui_renderer

protected

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

◆ $user

ilObjUser ilCalendarViewGUI::$user

protected

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

Referenced by ilCalendarAgendaListGUI\getPeriod(), and ilCalendarWeekGUI\showAppointment().

◆ $view_with_appointments

bool ilCalendarViewGUI::$view_with_appointments = false

protected

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

◆ CAL_PRESENTATION_AGENDA_LIST

const ilCalendarViewGUI::CAL_PRESENTATION_AGENDA_LIST = 9

Definition at line 38 of file class.ilCalendarViewGUI.php.

Referenced by ilCalendarInboxGUI\__construct(), and ilCalendarAgendaListGUI\__construct().

◆ CAL_PRESENTATION_DAY

const ilCalendarViewGUI::CAL_PRESENTATION_DAY = 1

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

Referenced by ilCalendarDayGUI\__construct().

◆ CAL_PRESENTATION_MONTH

const ilCalendarViewGUI::CAL_PRESENTATION_MONTH = 3

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

Referenced by ilCalendarMonthGUI\__construct().

◆ CAL_PRESENTATION_UNDEFINED

const ilCalendarViewGUI::CAL_PRESENTATION_UNDEFINED = 0

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

◆ CAL_PRESENTATION_WEEK

const ilCalendarViewGUI::CAL_PRESENTATION_WEEK = 2

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

Referenced by ilCalendarWeekGUI\__construct().

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

components/ILIAS/Calendar/classes/class.ilCalendarViewGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToolbarFileDownload()

◆ countEventsInView()

◆ downloadFiles()

◆ getActivePlugins()

◆ getAppointmentShyButton()

◆ getBucketTitle()

◆ getConsultationHoursUserId()

◆ getContentByPlugins()

◆ getCurrentApp()

◆ getDatesForItem()

◆ getEvents()

◆ getModalForApp()

◆ getModalTitleByPlugins()

◆ initAppointmentIdFromQuery()

◆ initBookingUserFromQuery()

◆ initialize()

◆ initInitialDateFromQuery()

◆ initInitialDateTimeFromQuery()

◆ setConsulationHoursUserId()

Field Documentation

◆ $ch_user_id

◆ $component_factory

◆ $ctrl

◆ $http

◆ $lng

◆ $logger

◆ $main_tpl

◆ $period_end_day

◆ $presentation_type

◆ $refinery

◆ $seed

◆ $tabs_gui

◆ $toolbar

◆ $tpl

◆ $ui

◆ $ui_factory

◆ $ui_renderer

◆ $user

◆ $view_with_appointments

◆ CAL_PRESENTATION_AGENDA_LIST

◆ CAL_PRESENTATION_DAY

◆ CAL_PRESENTATION_MONTH

◆ CAL_PRESENTATION_UNDEFINED

◆ CAL_PRESENTATION_WEEK