ilCalendarPresentationGUI Class Reference

Collaboration diagram for ilCalendarPresentationGUI:

Public Member Functions
	__construct ($a_ref_id=0)
	getRepositoryMode ()
	executeCommand ()
	showViewSelection (string $a_active="cal_list")
	getNextClass ()
	readLastClass ()
	Read last class from history. More...
	setCmdClass ($a_class)
	initSeed ()
	init the seed date for presentations (month view, minicalendar) More...
	showToolbarAndSidebar ()

Protected Member Functions
	initAppointmentIdFromQuery ()
	initCategoryIdFromQuery ()
	initAndRedirectToConsultationHours ()
	Init and redirect to consultation hours. More...
	initCalendarView ()
	Initialises calendar view according to given settings. More...
	redirectWithParameters (string $class)
	forwardToClass (string $a_class)
	showSideBlocks ()
	addCategoryTabs ()
	Add tabs for ilCategoryGUI context This cannot be done there since many views (Day Week Agenda) are initiated from these view. More...
	addStandardTabs ()
	add standard tabs More...
	prepareOutput ()
	getRequestedSeedAsString ()

Protected Attributes
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilTabsGUI	$tabs_gui
ilObjUser	$user
ilHelpGUI	$help
ilRbacSystem	$rbacsystem
ILIAS DI UIServices	$ui
ilToolbarGUI	$toolbar
ilAccessHandler	$access
HttpServices	$http
RefineryFactory	$refinery
ilCalendarSettings	$cal_settings
ilCalendarActions	$actions
ilCalendarCategories	$cats
bool	$repository_mode = false
int	$ref_id = 0
int	$category_id = 0
ilDate	$seed = null
int	$cal_view = 0
int	$cal_period = 0

Private Attributes
UIRenderer	$renderer
UIFactory	$ui_factory

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$ ilCalendarPresentationGUI: ilCalendarMonthGUI, ilCalendarUserSettingsGUI, ilCalendarCategoryGUI, ilCalendarWeekGUI ilCalendarPresentationGUI: ilCalendarAppointmentGUI, ilCalendarDayGUI, ilCalendarInboxGUI, ilCalendarSubscriptionGUI ilCalendarPresentationGUI: ilConsultationHoursGUI, ilCalendarBlockGUI, ilPDCalendarBlockGUI, ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

__construct()

ilCalendarPresentationGUI::__construct

(

$a_ref_id = 0

)

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

References $cats, $DIC, ilCalendarUserSettings\_getInstance(), ilCalendarCategories\_getInstance(), ilCalendarSettings\_getInstance(), ilCalendarCategory\_getInstanceByObjId(), ilCalendarVisibility\_getInstanceByUserId(), ilObject\_lookupObjId(), ILIAS\Repository\access(), ilCalendarUserSettings\CAL_SELECTION_MEMBERSHIP, ILIAS\Repository\ctrl(), ilCalendarActions\getInstance(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), initCalendarView(), ilCalendarCategories\initialize(), ILIAS\Repository\lng(), ilCalendarCategories\MODE_PERSONAL_DESKTOP_ITEMS, ilCalendarCategories\MODE_PERSONAL_DESKTOP_MEMBERSHIP, ilCalendarCategories\MODE_REPOSITORY, ilCalendarCategories\MODE_SINGLE_CALENDAR, ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('dateplaner');

        $this->renderer = $DIC->ui()->renderer();
        $this->ui_factory = $DIC->ui()->factory();

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs_gui = $DIC->tabs();
        $this->user = $DIC->user();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->help = $DIC["ilHelp"];
        $this->ui = $DIC->ui();
        $this->toolbar = $DIC->toolbar();
        $this->ref_id = $a_ref_id;
        $this->category_id = 0;
        if ($this->http->wrapper()->query()->has('category_id')) {
            $this->category_id = $this->http->wrapper()->query()->retrieve(
                'category_id',
                $this->refinery->kindlyTo()->int()
            );
        }

        $this->repository_mode = $a_ref_id > 0;
        if ($this->repository_mode && $this->category_id === 0) {
            $obj_id = ilObject::_lookupObjId($this->ref_id);
            $category = ilCalendarCategory::_getInstanceByObjId($obj_id);
            $this->category_id = is_null($category) ? 0 : $category->getCategoryID();
        }
        $this->ctrl->setParameter($this, 'category_id', $this->category_id);
        $this->cal_settings = ilCalendarSettings::_getInstance();

        // show back to pd
        $this->ctrl->saveParameter($this, 'backpd');

        $this->initCalendarView();
        $cats = ilCalendarCategories::_getInstance($this->user->getId());

        if ($this->category_id > 0 && $this->ref_id <= 0) {        // single calendar view
            // ensure activation of this category
            $vis = ilCalendarVisibility::_getInstanceByUserId($this->user->getId(), $a_ref_id);
            $vis->forceVisibility($this->category_id);

            $cats->initialize(ilCalendarCategories::MODE_SINGLE_CALENDAR, 0, false, $this->category_id);
        } elseif ($a_ref_id > 0) {
            $cats->initialize(ilCalendarCategories::MODE_REPOSITORY, (int) $a_ref_id, true);
        } elseif (ilCalendarUserSettings::_getInstance()->getCalendarSelectionType() == ilCalendarUserSettings::CAL_SELECTION_MEMBERSHIP) {
            $cats->initialize(ilCalendarCategories::MODE_PERSONAL_DESKTOP_MEMBERSHIP);
        } else {
            $cats->initialize(ilCalendarCategories::MODE_PERSONAL_DESKTOP_ITEMS);
        }

        $this->actions = ilCalendarActions::getInstance();
        $this->cats = $cats;
    }

Here is the call graph for this function:

Member Function Documentation

addCategoryTabs()

ilCalendarPresentationGUI::addCategoryTabs ( )

protected

Add tabs for ilCategoryGUI context This cannot be done there since many views (Day Week Agenda) are initiated from these view.

Definition at line 542 of file class.ilCalendarPresentationGUI.php.

References $ctrl, ilObject\_lookupType(), ilCtrlInterface\clearParameterByClass(), ILIAS\Repository\ctrl(), ilCtrlInterface\getLinkTargetByClass(), getRepositoryMode(), ILIAS\FileDelivery\http(), initCategoryIdFromQuery(), ILIAS\Repository\lng(), and ilCtrlInterface\setParameterByClass().

Referenced by prepareOutput().

                                        : void
    {
        $ctrl = $this->ctrl;
        $this->tabs_gui->clearTargets();
        $ctrl->setParameterByClass(ilCalendarCategoryGUI::class, "category_id", $this->initCategoryIdFromQuery());
        if ($this->getRepositoryMode()) {
            if ($this->http->wrapper()->query()->has('backpd')) {
                $this->tabs_gui->setBack2Target(
                    $this->lng->txt('back_to_pd'),
                    $this->ctrl->getLinkTargetByClass(ilDashboardGUI::class, 'jumpToCalendar')
                );
            }
            $label = $this->lng->txt('back_to_' . ilObject::_lookupType($this->ref_id, true));
            $this->tabs_gui->setBackTarget(
                $label,
                $this->ctrl->getParentReturn($this)
            );
        } elseif ($this->http->wrapper()->query()->has('backvm')) {
            // no object calendar => back is back to manage view
            $this->tabs_gui->setBackTarget(
                $this->lng->txt("back"),
                $ctrl->getLinkTargetByClass(ilCalendarCategoryGUI::class, 'manage')
            );
        } else {
            $ctrl->clearParameterByClass(ilCalendarPresentationGUI::class, 'category_id');
            $this->tabs_gui->setBackTarget(
                $this->lng->txt("back"),
                $ctrl->getLinkTargetByClass('ilcalendarpresentationgui', '')
            );
            $ctrl->setParameterByClass(ilCalendarPresentationGUI::class, "category_id", $this->initCategoryIdFromQuery());
        }

        $this->tabs_gui->addTab(
            "cal_agenda",
            $this->lng->txt("cal_agenda"),
            $ctrl->getLinkTargetByClass(ilCalendarPresentationGUI::class, "")
        );

        if ($this->actions->checkShareCal($this->category_id)) {
            $this->tabs_gui->addTab(
                "share",
                $this->lng->txt("cal_share"),
                $ctrl->getLinkTargetByClass(ilCalendarCategoryGUI::class, "shareSearch")
            );
        }
        if ($this->actions->checkSettingsCal($this->category_id)) {
            $ctrl->setParameterByClass(ilCalendarCategoryGUI::class, 'category_id', $this->category_id);
            $this->tabs_gui->addTab(
                "edit",
                $this->lng->txt("settings"),
                $ctrl->getLinkTargetByClass(ilCalendarCategoryGUI::class, "edit")
            );
            $ctrl->clearParameterByClass(ilCalendarCategoryGUI::class, 'category_id');
        }
        $this->tabs_gui->activateTab('cal_agenda');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStandardTabs()

ilCalendarPresentationGUI::addStandardTabs ( )

protected

add standard tabs

Definition at line 602 of file class.ilCalendarPresentationGUI.php.

References $access, $rbacsystem, ilCalendarSettings\_getInstance(), ilCalendarCategory\_getInstanceByObjId(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilRBACAccessHandler\checkAccess(), ILIAS\Repository\ctrl(), getRepositoryMode(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by prepareOutput().

                                        : void
    {
        $access = $this->access;
        $rbacsystem = $this->rbacsystem;

        $this->tabs_gui->clearTargets();
        if ($this->getRepositoryMode()) {
            if ($this->http->wrapper()->query()->has('backpd')) {
                $this->tabs_gui->setBack2Target(
                    $this->lng->txt('back_to_pd'),
                    $this->ctrl->getLinkTargetByClass(ilDashboardGUI::class, 'jumpToCalendar')
                );
            }
            $label = $this->lng->txt('back_to_' . ilObject::_lookupType($this->ref_id, true));
            $this->tabs_gui->setBackTarget(
                $label,
                $this->ctrl->getParentReturn($this)
            );

            $obj_id = ilObject::_lookupObjId($this->ref_id);
            $category = ilCalendarCategory::_getInstanceByObjId($obj_id);
            $category_id = $category->getCategoryID();

            // agenda tab
            $this->tabs_gui->addTab(
                'cal_agenda',
                $this->lng->txt('cal_agenda'),
                $this->ctrl->getLinkTarget($this, '')
            );

            // settings tab
            if ($access->checkAccess('edit_event', '', $this->ref_id)) {
                $this->ctrl->setParameterByClass(ilCalendarCategoryGUI::class, 'category_id', $category_id);
                $this->tabs_gui->addTab(
                    'cal_manage',
                    $this->lng->txt('settings'),
                    $this->ctrl->getLinkTargetByClass(ilCalendarCategoryGUI::class, 'edit')
                );
                $this->ctrl->clearParameterByClass(ilCalendarCategoryGUI::class, 'category_id');
            }
        } else {
            $this->tabs_gui->addTab(
                'cal_agenda',
                $this->lng->txt("cal_agenda"),
                $this->ctrl->getLinkTarget($this, '')
            );

            if (
                $this->rbacsystem->checkAccess(
                    'add_consultation_hours',
                    ilCalendarSettings::_getInstance()->getCalendarSettingsId()
                ) &&
                ilCalendarSettings::_getInstance()->areConsultationHoursEnabled()
            ) {
                $this->tabs_gui->addTab(
                    'app_consultation_hours',
                    $this->lng->txt('app_consultation_hours'),
                    $this->ctrl->getLinkTargetByClass(ilConsultationHoursGUI::class, '')
                );
            }
            $this->tabs_gui->addTarget(
                'cal_manage',
                $this->ctrl->getLinkTargetByClass('ilCalendarCategoryGUI', 'manage')
            );
            $this->tabs_gui->addTarget('settings', $this->ctrl->getLinkTargetByClass('ilCalendarUserSettingsGUI', ''));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilCalendarPresentationGUI::executeCommand

(

)

Definition at line 202 of file class.ilCalendarPresentationGUI.php.

References $ref_id, $seed, $user_id, ilCalendarSettings\_getInstance(), ILIAS\Repository\ctrl(), forwardToClass(), ilSession\get(), getNextClass(), getRepositoryMode(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), initAndRedirectToConsultationHours(), initAppointmentIdFromQuery(), initSeed(), ILIAS\Repository\lng(), prepareOutput(), readLastClass(), ilUtil\redirect(), ILIAS\Repository\refinery(), setCmdClass(), showSideBlocks(), showToolbarAndSidebar(), showViewSelection(), and ILIAS\Repository\user().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();

        if (!ilCalendarSettings::_getInstance()->isEnabled()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
        }

        $this->initSeed();
        if (!$this->ctrl->isAsynch()) {
            $this->prepareOutput();
        }

        $this->help->setScreenIdComponent("cal");
        switch ($cmd) {
            case 'selectCHCalendarOfUser':
                $this->initAndRedirectToConsultationHours();
                break;
        }

        // now next class is not empty, which breaks old consultation hour implementation
        $next_class = $this->getNextClass();

        switch ($next_class) {
            case 'ilcalendarinboxgui':
                $this->tabs_gui->activateTab('cal_agenda');
                $inbox_gui = $this->forwardToClass('ilcalendarinboxgui');
                if ($this->showToolbarAndSidebar()) {
                    $this->showViewSelection("cal_list");
                    $this->showSideBlocks();
                    $inbox_gui->addToolbarFileDownload();
                }

                break;

            case 'ilconsultationhoursgui':
                $this->tabs_gui->activateTab('app_consultation_hours');
                $this->tabs_gui->clearTargets();

                // No side blocks
                $this->tabs_gui->setBackTarget(
                    $this->lng->txt('cal_back_to_cal'),
                    $this->ctrl->getLinkTargetByClass($this->readLastClass())
                );
                $this->ctrl->forwardCommand(new ilConsultationHoursGUI());
                if ($this->showToolbarAndSidebar()) {
                    $this->showSideBlocks();
                }
                return;

            case 'ilcalendarmonthgui':
                $this->tabs_gui->activateTab('cal_agenda');
                $month_gui = $this->forwardToClass('ilcalendarmonthgui');

                if ($this->showToolbarAndSidebar()) {
                    $this->showViewSelection("app_month");
                    $this->showSideBlocks();
                    $month_gui->addToolbarFileDownload();
                }
                break;

            case 'ilcalendarweekgui':
                $this->tabs_gui->activateTab('cal_agenda');
                $week_gui = $this->forwardToClass('ilcalendarweekgui');
                if ($this->showToolbarAndSidebar()) {
                    $this->showViewSelection("app_week");
                    $this->showSideBlocks();
                    $week_gui->addToolbarFileDownload();
                }

                break;

            case 'ilcalendardaygui':
                $this->tabs_gui->activateTab('cal_agenda');
                $day_gui = $this->forwardToClass('ilcalendardaygui');
                if ($this->showToolbarAndSidebar()) {
                    $this->showViewSelection("app_day");
                    $this->showSideBlocks();
                    $day_gui->addToolbarFileDownload();
                }
                break;

            case 'ilcalendarusersettingsgui':
                $this->ctrl->setReturn($this, '');
                $this->tabs_gui->activateTab('settings');
                $this->setCmdClass('ilcalendarusersettingsgui');

                $user_settings = new ilCalendarUserSettingsGUI();
                $this->ctrl->forwardCommand($user_settings);
                // No side blocks
                return;

            case 'ilcalendarappointmentgui':
                $this->ctrl->setReturn($this, '');
                $this->tabs_gui->activateTab((string) ilSession::get('cal_last_tab'));

                $app = new ilCalendarAppointmentGUI($this->seed, $this->seed, $this->initAppointmentIdFromQuery());
                $this->ctrl->forwardCommand($app);
                break;

            case 'ilcalendarsubscriptiongui':
                $this->ctrl->setReturn($this, '');
                $this->tabs_gui->activateTab("cal_agenda");

                $ref_id = 0;
                if ($this->http->wrapper()->query()->has('ref_id')) {
                    $ref_id = $this->http->wrapper()->query()->retrieve(
                        'ref_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                $sub = new ilCalendarSubscriptionGUI($this->category_id, $ref_id);
                $this->ctrl->forwardCommand($sub);
                if ($this->showToolbarAndSidebar()) {
                    $this->showSideBlocks();
                }
                break;

            case 'ilcalendarcategorygui':
                $this->ctrl->setReturn($this, '');
                $this->tabs_gui->activateTab("cal_manage");
                $category = new ilCalendarCategoryGUI($this->user->getId(), $this->seed, $this->ref_id);
                if ($this->ctrl->forwardCommand($category)) {
                    return;
                } else {
                    $this->showSideBlocks();
                    break;
                }

                // no break
            case 'ilcalendarblockgui':
                $side_cal = new ilCalendarBlockGUI();
                $side_cal->setRepositoryMode($this->getRepositoryMode());
                $side_cal->setForceMonthView(true);
                $this->ctrl->forwardCommand($side_cal);
                $this->showSideBlocks();
                break;

            case 'ilpdcalendarblockgui':
                $side_cal = new ilPDCalendarBlockGUI();
                $side_cal->setRepositoryMode($this->getRepositoryMode());
                $side_cal->setForceMonthView(true);
                $this->ctrl->forwardCommand($side_cal);
                $this->showSideBlocks();
                break;

            case 'ilpublicuserprofilegui':
                $user_id = $this->user->getId();
                if ($this->http->wrapper()->query()->has('user_id')) {
                    $user_id = $this->http->wrapper()->query()->retrieve(
                        'user_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                $user_profile = new ilPublicUserProfileGUI($user_id);
                $html = $this->ctrl->forwardCommand($user_profile);
                $this->tpl->setContent($html);
                break;

            default:
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                $this->showSideBlocks();
                break;
        }
    }

Here is the call graph for this function:

forwardToClass()

ilCalendarPresentationGUI::forwardToClass ( string  $a_class )

protected

Definition at line 480 of file class.ilCalendarPresentationGUI.php.

References $user, ILIAS\Repository\ctrl(), null, ilSession\set(), setCmdClass(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                                      : ?ilCalendarViewGUI
    {
        $ilUser = $this->user;
        switch ($a_class) {
            case 'ilcalendarmonthgui':
                $this->user->writePref('cal_last_class', $a_class);
                ilSession::set('cal_last_tab', 'app_month');
                $this->setCmdClass('ilcalendarmonthgui');
                $month_gui = new ilCalendarMonthGUI($this->seed);
                $this->ctrl->forwardCommand($month_gui);
                return $month_gui;

            case 'ilcalendarweekgui':
                $this->user->writePref('cal_last_class', $a_class);
                ilSession::set('cal_last_tab', 'app_week');
                $this->setCmdClass('ilcalendarweekgui');
                $week_gui = new ilCalendarWeekGUI($this->seed);
                $this->ctrl->forwardCommand($week_gui);
                return $week_gui;

            case 'ilcalendardaygui':
                $this->user->writePref('cal_last_class', $a_class);
                ilSession::set('cal_last_tab', 'app_day');
                $this->setCmdClass('ilcalendardaygui');
                $day_gui = new ilCalendarDayGUI($this->seed);
                $this->ctrl->forwardCommand($day_gui);
                return $day_gui;

            case 'ilcalendarinboxgui':
                $this->user->writePref('cal_last_class', $a_class);
                ilSession::set('cal_last_tab', 'cal_upcoming_events_header');
                $this->setCmdClass('ilcalendarinboxgui');
                $inbox_gui = new ilCalendarInboxGUI($this->seed);
                $this->ctrl->forwardCommand($inbox_gui);
                return $inbox_gui;
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNextClass()

ilCalendarPresentationGUI::getNextClass

(

)

Definition at line 419 of file class.ilCalendarPresentationGUI.php.

References ILIAS\Repository\ctrl(), readLastClass(), and redirectWithParameters().

Referenced by executeCommand().

                                  : string
    {
        if (strlen($next_class = $this->ctrl->getNextClass())) {
            return $next_class;
        }
        if (
            strcasecmp($this->ctrl->getCmdClass(), ilCalendarPresentationGUI::class) === 0 ||
            $this->ctrl->getCmdClass() == ''
        ) {
            $cmd_class = $this->readLastClass();
            $this->redirectWithParameters($cmd_class);
            return $cmd_class;
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRepositoryMode()

ilCalendarPresentationGUI::getRepositoryMode

(

)

Definition at line 127 of file class.ilCalendarPresentationGUI.php.

References $repository_mode.

Referenced by addCategoryTabs(), addStandardTabs(), executeCommand(), initSeed(), and showSideBlocks().

                                       : bool
    {
        return $this->repository_mode;
    }

Here is the caller graph for this function:

getRequestedSeedAsString()

ilCalendarPresentationGUI::getRequestedSeedAsString ( )

protected

Definition at line 743 of file class.ilCalendarPresentationGUI.php.

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

Referenced by initAndRedirectToConsultationHours(), and initSeed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initAndRedirectToConsultationHours()

ilCalendarPresentationGUI::initAndRedirectToConsultationHours ( )

protected

Init and redirect to consultation hours.

Definition at line 158 of file class.ilCalendarPresentationGUI.php.

References $ref_id, ilCalendarVisibility\_getInstanceByUserId(), ILIAS\Repository\ctrl(), getRequestedSeedAsString(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilCalendarCategory\TYPE_CH, and ILIAS\Repository\user().

Referenced by executeCommand().

                                                           : void
    {
        $ch_user_id = 0;
        if ($this->http->wrapper()->query()->has('ch_user_id')) {
            $ch_user_id = $this->http->wrapper()->query()->retrieve(
                'ch_user_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $visibility = ilCalendarVisibility::_getInstanceByUserId($this->user->getId(), $this->ref_id);
        foreach ($this->cats->getCategoriesInfo() as $info) {
            if (
                $info["type"] == ilCalendarCategory::TYPE_CH &&
                $info["obj_id"] == $ch_user_id
            ) {
                $v = $visibility->getVisible();
                if (!in_array($info["cat_id"], $v)) {
                    $v[] = $info["cat_id"];
                }
                $visibility->showSelected($v);
                $visibility->save();
                $this->ctrl->setParameterByClass(ilCalendarMonthGUI::class, 'category_id', $info['cat_id']);
                $this->ctrl->setParameterByClass(\ilCalendarMonthGUI::class, 'seed', $this->getRequestedSeedAsString());
            }
        }
        $this->ctrl->redirectToURL(
            $this->ctrl->getLinkTargetByClass(\ilCalendarMonthGUI::class, '')
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initAppointmentIdFromQuery()

ilCalendarPresentationGUI::initAppointmentIdFromQuery ( )

protected

Definition at line 132 of file class.ilCalendarPresentationGUI.php.

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

Referenced by executeCommand().

                                                   : 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:

initCalendarView()

ilCalendarPresentationGUI::initCalendarView ( )

protected

Initialises calendar view according to given settings.

Definition at line 191 of file class.ilCalendarPresentationGUI.php.

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

Referenced by __construct().

                                         : void
    {
        $this->cal_view = $this->cal_settings->getDefaultCal();
        if ($this->http->wrapper()->query()->has('cal_view')) {
            $this->cal_view = $this->http->wrapper()->query()->retrieve(
                'cal_view',
                $this->refinery->kindlyTo()->int()
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCategoryIdFromQuery()

ilCalendarPresentationGUI::initCategoryIdFromQuery ( )

protected

Definition at line 143 of file class.ilCalendarPresentationGUI.php.

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

Referenced by addCategoryTabs().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initSeed()

ilCalendarPresentationGUI::initSeed

(

)

init the seed date for presentations (month view, minicalendar)

Definition at line 758 of file class.ilCalendarPresentationGUI.php.

References ILIAS\Repository\ctrl(), ilSession\get(), getRepositoryMode(), getRequestedSeedAsString(), IL_CAL_DATE, IL_CAL_UNIX, and ilSession\set().

Referenced by executeCommand().

                              : void
    {
        $seed = $this->getRequestedSeedAsString();

        // default to today
        $now = new \ilDate(time(), IL_CAL_UNIX);
        $this->seed = new \ilDate($now->get(IL_CAL_DATE), IL_CAL_DATE);
        if ($seed) {
            $this->seed = new ilDate($seed, IL_CAL_DATE);
        } elseif (!$this->getRepositoryMode()) {
            $session_seed = ilSession::get('cal_seed');
            if ($session_seed) {
                $this->seed = new ilDate($session_seed, IL_CAL_DATE);
            }
        }
        $this->ctrl->setParameter($this, 'seed', $this->seed->get(IL_CAL_DATE));
        ilSession::set('cal_seed', $this->seed->get(IL_CAL_DATE));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareOutput()

ilCalendarPresentationGUI::prepareOutput ( )

protected

Definition at line 670 of file class.ilCalendarPresentationGUI.php.

References $ctrl, $lng, $tabs_gui, $tpl, ilObjUser\_lookupFullname(), addCategoryTabs(), addStandardTabs(), ilUtil\getImagePath(), ilCtrlInterface\getLinkTargetByClass(), ILIAS\Repository\lng(), renderer(), ILIAS\UICore\GlobalTemplate\setHeaderActionMenu(), ilCtrlInterface\setParameterByClass(), ILIAS\UICore\GlobalTemplate\setTitle(), ILIAS\UICore\GlobalTemplate\setTitleIcon(), ilCalendarCategory\TYPE_BOOK, ilCalendarCategory\TYPE_CH, ilCalendarCategory\TYPE_GLOBAL, ilCalendarCategory\TYPE_OBJ, and ilCalendarCategory\TYPE_USR.

Referenced by executeCommand().

                                      : void
    {
        if ($this->category_id) {
            $this->addCategoryTabs();
        } else {
            $this->addStandardTabs();
        }

        // #0035566
        $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_cal.svg"));

        // if we are in single calendar view
        if ($this->category_id > 0) {
            $tabs = $this->tabs_gui;
            $lng = $this->lng;
            $ctrl = $this->ctrl;
            $tpl = $this->tpl;

            $category = new ilCalendarCategory($this->category_id);

            // Set header
            $header = "";
            switch ($category->getType()) {
                case ilCalendarCategory::TYPE_USR:
                    $header = $this->lng->txt('cal_type_personal') . ": " . $category->getTitle();
                    break;

                case ilCalendarCategory::TYPE_GLOBAL:
                    $header = $this->lng->txt('cal_type_system') . ": " . $category->getTitle();
                    break;

                case ilCalendarCategory::TYPE_OBJ:
                    $header = $this->lng->txt('cal_type_' . $category->getObjType()) . ": " . $category->getTitle();
                    break;

                case ilCalendarCategory::TYPE_CH:
                    $header = str_replace(
                        "%1",
                        ilObjUser::_lookupFullname($category->getObjId()),
                        $this->lng->txt("cal_consultation_hours_for_user")
                    );
                    break;

                case ilCalendarCategory::TYPE_BOOK:
                    $header = $category->getTitle();
                    break;
            }
            $tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_cal.svg"));
            $tpl->setTitle($header);

            $dropDownItems = array();

            // iCal-Url
            $ctrl->setParameterByClass("ilcalendarsubscriptiongui", "category_id", $this->category_id);
            $dropDownItems[] = $this->ui_factory->button()->shy(
                $this->lng->txt("cal_ical_url"),
                $ctrl->getLinkTargetByClass("ilcalendarsubscriptiongui", "")
            );

            // delete action
            if ($this->actions->checkDeleteCal($this->category_id)) {
                $ctrl->setParameterByClass("ilcalendarcategorygui", "category_id", $this->category_id);
                $dropDownItems[] = $this->ui_factory->button()->shy(
                    $this->lng->txt("cal_delete_cal"),
                    $ctrl->getLinkTargetByClass("ilcalendarcategorygui", "confirmDelete")
                );
            }
            $dropDown = $this->ui_factory->dropdown()->standard($dropDownItems)
                                         ->withAriaLabel($this->lng->txt('actions'));
            $tpl->setHeaderActionMenu($this->renderer->render($dropDown));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readLastClass()

ilCalendarPresentationGUI::readLastClass

(

)

Read last class from history.

Definition at line 438 of file class.ilCalendarPresentationGUI.php.

References $user, ilCalendarSettings\DEFAULT_CAL_DAY, ilCalendarSettings\DEFAULT_CAL_LIST, ilCalendarSettings\DEFAULT_CAL_MONTH, ilCalendarSettings\DEFAULT_CAL_WEEK, ILIAS\FileDelivery\http(), and ILIAS\Repository\user().

Referenced by executeCommand(), and getNextClass().

                                   : string
    {
        $ilUser = $this->user;
        switch ($this->cal_view) {
            case ilCalendarSettings::DEFAULT_CAL_DAY:
                $class = "ilcalendardaygui";
                break;
            case ilCalendarSettings::DEFAULT_CAL_WEEK:
                $class = "ilcalendarweekgui";
                break;
            case ilCalendarSettings::DEFAULT_CAL_MONTH:
                $class = "ilcalendarmonthgui";
                break;
            case ilCalendarSettings::DEFAULT_CAL_LIST:
            default:
                $class = "ilcalendarinboxgui";
                break;
        }

        // see #34998, if cal_view is requested (e.g. through starting point)
        // it must get high prio than history entry
        $user_pref = $this->user->getPref('cal_last_class');
        $use_pref = $user_pref && ($user_pref !== "") && !$this->http->wrapper()->query()->has('cal_view');

        return $use_pref ? $user_pref : $class;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectWithParameters()

ilCalendarPresentationGUI::redirectWithParameters ( string  $class )

protected

Definition at line 474 of file class.ilCalendarPresentationGUI.php.

References ILIAS\Repository\ctrl().

Referenced by getNextClass(), and setCmdClass().

                                                            : void
    {
        $this->ctrl->saveParameter($this, 'seed');
        $this->ctrl->redirectByClass($class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCmdClass()

ilCalendarPresentationGUI::setCmdClass

(

$a_class

)

Definition at line 465 of file class.ilCalendarPresentationGUI.php.

References ILIAS\Repository\ctrl(), and redirectWithParameters().

Referenced by executeCommand(), and forwardToClass().

                                         : void
    {
        // If cmd class == 'ilcalendarpresentationgui' the cmd class is set to the the new forwarded class
        // otherwise e.g ilcalendarmonthgui tries to forward (back) to ilcalendargui.
        if ($this->ctrl->getCmdClass() == strtolower(get_class($this))) {
            $this->redirectWithParameters($a_class);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSideBlocks()

ilCalendarPresentationGUI::showSideBlocks ( )

protected

Definition at line 519 of file class.ilCalendarPresentationGUI.php.

References $ref_id, $seed, ILIAS\Repository\ctrl(), ILIAS\UICore\GlobalTemplate\get(), getRepositoryMode(), ILIAS\UICore\GlobalTemplate\setVariable(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                       : void
    {
        $tpl = new ilTemplate('tpl.cal_side_block.html', true, true, 'components/ILIAS/Calendar');
        if ($this->getRepositoryMode()) {
            $side_cal = new ilCalendarBlockGUI();
        } else {
            $side_cal = new ilPDCalendarBlockGUI();
        }
        $side_cal->setParentGUI("ilCalendarPresentationGUI");
        $side_cal->setForceMonthView(true);
        $side_cal->setRepositoryMode($this->getRepositoryMode());
        $tpl->setVariable('MINICAL', $this->ctrl->getHTML($side_cal));

        $cat = new ilCalendarCategoryGUI($this->user->getId(), $this->seed, $this->ref_id);
        $tpl->setVariable('CATEGORIES', $this->ctrl->getHTML($cat));

        $this->tpl->setRightContent($tpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showToolbarAndSidebar()

ilCalendarPresentationGUI::showToolbarAndSidebar

(

)

Definition at line 779 of file class.ilCalendarPresentationGUI.php.

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

                                           : bool
    {
        #21783
        return !(
            $this->ctrl->getCmdClass() == "ilcalendarappointmentgui" ||
            $this->ctrl->getCmdClass() == 'ilconsultationhoursgui'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showViewSelection()

ilCalendarPresentationGUI::showViewSelection

(

string

$a_active = "cal_list"

)

Definition at line 370 of file class.ilCalendarPresentationGUI.php.

References $ctrl, Vendor\Package\$f, $lng, $toolbar, $ui, ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), ilCtrlInterface\getLinkTargetByClass(), IL_CAL_DATE, IL_CAL_UNIX, ILIAS\Repository\lng(), and ilCtrlInterface\setParameterByClass().

Referenced by executeCommand().

                                                                    : void
    {
        $ui = $this->ui;
        $ctrl = $this->ctrl;
        $lng = $this->lng;
        $toolbar = $this->toolbar;

        $f = $ui->factory();

        $actions = array(
            $this->lng->txt("app_day") => $ctrl->getLinkTargetByClass('ilCalendarDayGUI', ''),
            $this->lng->txt("app_week") => $ctrl->getLinkTargetByClass('ilCalendarWeekGUI', ''),
            $this->lng->txt("app_month") => $ctrl->getLinkTargetByClass('ilCalendarMonthGUI', ''),
            $this->lng->txt("cal_list") => $ctrl->getLinkTargetByClass('ilCalendarInboxGUI', '')
        );


        $view_control = $f->viewControl()->mode($actions, "cal_change_calendar_view")->withActive($this->lng->txt($a_active));
        $toolbar->addComponent($view_control);
        $ctrl->setParameterByClass("ilcalendarappointmentgui", "seed", $this->seed->get(IL_CAL_DATE, ''));
        $ctrl->setParameterByClass("ilcalendarappointmentgui", "app_id", "");
        $ctrl->setParameterByClass("ilcalendarappointmentgui", "dt", "");
        $ctrl->setParameterByClass("ilcalendarappointmentgui", "idate", (new ilDate(time(), IL_CAL_UNIX))->get(IL_CAL_DATE));

        $extra_button_added = false;
        // add appointment
        if ($this->category_id == 0 || $this->actions->checkAddEvent($this->category_id)) {
            $toolbar->addSeparator();
            $extra_button_added = true;
            $add_button = $f->button()->standard(
                $this->lng->txt("cal_add_appointment"),
                $ctrl->getLinkTargetByClass("ilcalendarappointmentgui", "add")
            );
            $toolbar->addComponent($add_button);
        }

        // import appointments
        if ($this->category_id > 0 && $this->actions->checkAddEvent($this->category_id)) {
            if (!$extra_button_added) {
                $toolbar->addSeparator();
            }
            $add_button = $f->button()->standard(
                $this->lng->txt("cal_import_appointments"),
                $ctrl->getLinkTargetByClass("ilcalendarcategorygui", "importAppointments")
            );
            $toolbar->addComponent($add_button);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilCalendarPresentationGUI::$access

protected

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

Referenced by addStandardTabs().

$actions

ilCalendarActions ilCalendarPresentationGUI::$actions

protected

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

$cal_period

int ilCalendarPresentationGUI::$cal_period = 0

protected

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

$cal_settings

ilCalendarSettings ilCalendarPresentationGUI::$cal_settings

protected

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

$cal_view

int ilCalendarPresentationGUI::$cal_view = 0

protected

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

$category_id

int ilCalendarPresentationGUI::$category_id = 0

protected

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

$cats

ilCalendarCategories ilCalendarPresentationGUI::$cats

protected

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

Referenced by __construct().

$ctrl

ilCtrlInterface ilCalendarPresentationGUI::$ctrl

protected

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

Referenced by addCategoryTabs(), prepareOutput(), and showViewSelection().

$help

ilHelpGUI ilCalendarPresentationGUI::$help

protected

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

$http

HttpServices ilCalendarPresentationGUI::$http

protected

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

$lng

ilLanguage ilCalendarPresentationGUI::$lng

protected

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

Referenced by prepareOutput(), and showViewSelection().

$rbacsystem

ilRbacSystem ilCalendarPresentationGUI::$rbacsystem

protected

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

Referenced by addStandardTabs().

$ref_id

int ilCalendarPresentationGUI::$ref_id = 0

protected

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

Referenced by executeCommand(), initAndRedirectToConsultationHours(), and showSideBlocks().

$refinery

RefineryFactory ilCalendarPresentationGUI::$refinery

protected

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

$renderer

UIRenderer ilCalendarPresentationGUI::$renderer

private

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

$repository_mode

bool ilCalendarPresentationGUI::$repository_mode = false

protected

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

Referenced by getRepositoryMode().

$seed

ilDate ilCalendarPresentationGUI::$seed = null

protected

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

Referenced by executeCommand(), getRequestedSeedAsString(), and showSideBlocks().

$tabs_gui

ilTabsGUI ilCalendarPresentationGUI::$tabs_gui

protected

Definition at line 39 of file class.ilCalendarPresentationGUI.php.

Referenced by prepareOutput().

$toolbar

ilToolbarGUI ilCalendarPresentationGUI::$toolbar

protected

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

Referenced by showViewSelection().

$tpl

ilGlobalTemplateInterface ilCalendarPresentationGUI::$tpl

protected

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

Referenced by prepareOutput().

$ui

ILIAS DI UIServices ilCalendarPresentationGUI::$ui

protected

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

Referenced by showViewSelection().

$ui_factory

UIFactory ilCalendarPresentationGUI::$ui_factory

private

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

$user

ilObjUser ilCalendarPresentationGUI::$user

protected

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

Referenced by forwardToClass(), and readLastClass().

---

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

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