ilCalendarAppointmentGUI Class Reference

Administrate calendar appointments. More...

Collaboration diagram for ilCalendarAppointmentGUI:

Public Member Functions
	__construct (ilDate $seed, ilDate $initialDate, $a_appointment_id=0)
	executeCommand ()
	getAppointment ()
	Get current appointment. More...
	editResponsibleUsers ()
	Edit responsible users. More...
	showResponsibleUsersList ($a_grp_id)
	Show responsible uses of a milestone (default set is participants of group) More...
	saveMilestoneResponsibleUsers ()
	Save milestone responsibilites. More...
	confirmUnregister ()
	Confirmation screen to unregister calendar. More...
	book ()
	Confirmation screen for booking of consultation appointment. More...
	bookconfirmed ()
	Book consultation appointment, was confirmed. More...
	cancelBooking ()
	Confirmation screen to cancel consultation appointment or ressource booking depends on calendar category. More...
	cancelConfirmed ()
	Cancel consultation appointment or ressource booking, was confirmed This will delete the calendar entry. More...

Protected Member Functions
	cancel ()
	cancel editing More...
	initForm ($a_mode, $a_as_milestone=false, $a_edit_single_app=false)
	init form More...
	add (ilPropertyFormGUI $form=null)
	add new appointment More...
	addMilestone ()
	add milestone More...
	saveMilestone ()
	save milestone More...
	save ($a_as_milestone=false)
	save appointment More...
	distributeUserNotifications ()
	Send mail to selected users ilObjUser $ilUser. More...
	distributeNotifications ($a_cat_id, $app_id, $a_new_appointment=true)
	Distribute mail notifications. More...
	askEdit ()
	Check edit single apppointment / edit all appointments for recurring appointments. More...
	editSingle ()
	Edit one single appointment ^. More...
	edit ($a_edit_single_app=false, ilPropertyFormGUI $form=null)
	edit appointment More...
	showInfoScreen ()
	show info screen More...
	update ()
	update More...
	askDelete ()
	ask delete More...
	delete ()
	delete More...
	deleteExclude ($a_return=true)
	delete single item of recurrence list More...
	initTimeZone ()
	init timezone More...
	initInitialDate (ilDate $initialDate)
	init initial date More...
	initSeed (ilDate $seed)
	init seed More...
	initAppointment ($a_app_id=0)
	init appointment More...
	load ($a_mode, $a_as_milestone=false)
	load post More...
	loadNotificationRecipients ()
	loadRecurrenceSettings ($a_as_milestone=false)
	load recurrence settings More...
	saveRecurrenceSettings ()
	save recurrence settings More...
	createDefaultCalendar ()
	Create a default calendar. More...
	confirmRegister ()
	Register to an appointment. More...
	register ()
	Register. More...
	unregister ()
	Unregister calendar, was confirmed. More...
	initFormConfirmBooking ()
	calendarEntryToCategory (ilCalendarEntry $entry)
	Get category object of given calendar entry. More...
	doUserAutoComplete ()
	Do auto completion. More...

Protected Attributes
	$seed = null
	$initialDate = null
	$default_fulltime = true
	$app = null
	$rec = null
	$timezone = null
	$tpl
	$lng
	$ctrl
	$request

Private Attributes
	$logger = null

Detailed Description

Administrate calendar appointments.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 12 of file class.ilCalendarAppointmentGUI.php.

Constructor & Destructor Documentation

__construct()

ilCalendarAppointmentGUI::__construct	(	ilDate	$seed,
		ilDate	$initialDate,
			$a_appointment_id = 0
	)

Todo:

make appointment_id required and remove all GET request

public

Parameters

ilDate

seed

Returns

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

References $DIC, $GLOBALS, initAppointment(), initInitialDate(), initSeed(), and initTimeZone().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('dateplaner');
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->logger = $GLOBALS['DIC']->logger()->cal();
        $this->request = $DIC->http()->request();

        $this->initTimeZone();
        $this->initSeed($seed);
        $this->initInitialDate($initialDate);
        $this->initAppointment($a_appointment_id);
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilCalendarAppointmentGUI::add ( ilPropertyFormGUI  $form = null )

protected

add new appointment

Parameters

\ilPropertyFormGUI

$form

protected

Returns

Definition at line 338 of file class.ilCalendarAppointmentGUI.php.

References $DIC, and initForm().

Referenced by save().

    {
        global $DIC;

        $ilHelp = $DIC->help();

        $ilHelp->setScreenIdComponent("cal");
        $ilHelp->setScreenId("app");
        $ilHelp->setSubScreenId("create");
        
        if (!$form instanceof ilPropertyFormGUI) {
            $this->initForm('create');
        }
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMilestone()

ilCalendarAppointmentGUI::addMilestone ( )

protected

add milestone

protected

Returns

Definition at line 360 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $tpl, and initForm().

Referenced by save().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setScreenIdComponent("cal");
        $ilHelp->setScreenId("app");
        $ilHelp->setSubScreenId("create_milestone");

        $this->initForm('create', true);
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

askDelete()

ilCalendarAppointmentGUI::askDelete ( )

protected

ask delete

protected

Returns

Definition at line 846 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $tpl, ilCalendarRecurrences\_getRecurrences(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\sendQuestion().

    {
        global $DIC;

        $tpl = $DIC['tpl'];

        $this->ctrl->saveParameter(
            $this,
            [
                'seed',
                'app_id',
                'dt',
                'idate'
            ]
        );

        $app_id = (int) ($this->request->getQueryParams()['app_id'] ?? 0);
        if (!$app_id) {
            ilUtil::sendFailure($this->lng->txt('err_check_input'));
            $this->ctrl->returnToParent($this);
        }

        $entry = new ilCalendarEntry($app_id);
        $recs = ilCalendarRecurrences::_getRecurrences($app_id);
        if (
            !count($recs) &&
            !$this->app->isMilestone()
        ) {
            $confirm = new ilConfirmationGUI();
            $confirm->setFormAction($this->ctrl->getFormAction($this));
            $confirm->setHeaderText($this->lng->txt('cal_delete_app_sure'));
            $confirm->setCancel($this->lng->txt('cancel'), 'cancel');
            $confirm->addItem('appointments[]', $this->app->getEntryId(), $this->app->getTitle());
            $confirm->setConfirm($this->lng->txt('delete'), 'delete');
            $this->tpl->setContent($confirm->getHTML());
        } else {
            $table = new ilCalendarRecurrenceTableGUI(
                $this->app,
                $this,
                'askDelete'
            );
            $table->init();
            $table->parse();
            $this->tpl->setContent($table->getHTML());
            ilUtil::sendQuestion($this->lng->txt('cal_delete_app_sure'));
            ilUtil::sendInfo($this->lng->txt('cal_recurrence_confirm_deletion'));
        }
    }

Here is the call graph for this function:

askEdit()

ilCalendarAppointmentGUI::askEdit ( )

protected

Check edit single apppointment / edit all appointments for recurring appointments.

Todo:

works with milestones???

Definition at line 579 of file class.ilCalendarAppointmentGUI.php.

References $GLOBALS, $rec, ilCalendarRecurrences\_getRecurrences(), edit(), and getAppointment().

    {
        // check for recurring entries
        include_once './Services/Calendar/classes/class.ilCalendarRecurrences.php';
        $rec = ilCalendarRecurrences::_getRecurrences($this->getAppointment()->getEntryId());
        if (!$rec) {
            return $this->edit(true);
        }
        // Show edit single/all appointments
        $this->ctrl->saveParameter($this, array('seed','app_id','dt','idate'));

        include_once('./Services/Utilities/classes/class.ilConfirmationGUI.php');
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        #$confirm->setHeaderText($this->lng->txt('cal_edit_app_sure'));
        $confirm->setCancel($this->lng->txt('cancel'), 'cancel');
        $confirm->addItem('appointments[]', $this->app->getEntryId(), $this->app->getTitle());
        $confirm->addButton($this->lng->txt('cal_edit_single'), 'editSingle');
        $confirm->setConfirm($this->lng->txt('cal_edit_recurrences'), 'edit');

        $GLOBALS['DIC']['tpl']->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

book()

ilCalendarAppointmentGUI::book

(

)

Confirmation screen for booking of consultation appointment.

Definition at line 1380 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $DIC, $ilUser, $tpl, ilObjUser\_lookupFullname(), ilDatePresentation\formatPeriod(), and initFormConfirmBooking().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $tpl = $DIC['tpl'];
        
        $entry_id = (int) $_GET['app_id'];
        $this->ctrl->saveParameter($this, 'app_id');
        
        include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
        include_once 'Services/Booking/classes/class.ilBookingEntry.php';
        $entry = new ilCalendarEntry($entry_id);
        $booking = new \ilBookingEntry($entry->getContextId());
        $user = $booking->getObjId();


        $form = $this->initFormConfirmBooking();
        $form->getItemByPostVar('date')->setValue(ilDatePresentation::formatPeriod($entry->getStart(), $entry->getEnd()));
        $form->getItemByPostVar('title')->setValue($entry->getTitle() . " (" . ilObjUser::_lookupFullname($user) . ')');
        
        $tpl->setContent($form->getHTML());
        return true;
    }

Here is the call graph for this function:

bookconfirmed()

ilCalendarAppointmentGUI::bookconfirmed

(

)

Book consultation appointment, was confirmed.

Definition at line 1433 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $GLOBALS, $ilUser, ilConsultationHourUtils\bookAppointment(), initFormConfirmBooking(), ilUtil\sendFailure(), and ilBookingEntry\writeBookingMessage().

    {
        global $DIC;

        $ilUser = $DIC->user();

        $entry = (int) $_REQUEST['app_id'];
        $form = $this->initFormConfirmBooking();
        if ($form->checkInput()) {
            // check if appointment is bookable
            include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
            $cal_entry = new ilCalendarEntry($entry);
            
            include_once './Services/Booking/classes/class.ilBookingEntry.php';
            $booking = new ilBookingEntry($cal_entry->getContextId());
            
            if (!$booking->isAppointmentBookableForUser($entry, $GLOBALS['DIC']['ilUser']->getId())) {
                ilUtil::sendFailure($this->lng->txt('cal_booking_failed_info'), true);
                $this->ctrl->returnToParent($this);
            }
            
            include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourUtils.php';
            ilConsultationHourUtils::bookAppointment($ilUser->getId(), $entry);
            
            include_once './Services/Booking/classes/class.ilBookingEntry.php';
            ilBookingEntry::writeBookingMessage($entry, $ilUser->getId(), $form->getInput('comment'));
        }
        ilUtil::sendSuccess($this->lng->txt('cal_booking_confirmed'), true);
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

calendarEntryToCategory()

ilCalendarAppointmentGUI::calendarEntryToCategory ( ilCalendarEntry  $entry )

protected

Get category object of given calendar entry.

Parameters

ilCalendarEntry

$entry

Returns

ilCalendarCategory

Definition at line 1565 of file class.ilCalendarAppointmentGUI.php.

References ilCalendarEntry\getEntryId(), and ilCalendarCategoryAssignments\getFirstAssignment().

Referenced by cancelBooking(), and cancelConfirmed().

    {
        include_once 'Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
        include_once 'Services/Calendar/classes/class.ilCalendarCategory.php';
        $assignment = new ilCalendarCategoryAssignments($entry->getEntryId());
        $assignment = $assignment->getFirstAssignment();
        return new ilCalendarCategory($assignment);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilCalendarAppointmentGUI::cancel ( )

protected

cancel editing

protected

Parameters

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

    {
        $this->ctrl->returnToParent($this);
    }

cancelBooking()

ilCalendarAppointmentGUI::cancelBooking

(

)

Confirmation screen to cancel consultation appointment or ressource booking depends on calendar category.

Definition at line 1468 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $DIC, $ilUser, $tpl, ilObjUser\_lookupFullname(), calendarEntryToCategory(), ilDatePresentation\formatPeriod(), ilConfirmationGUI\setFormAction(), ilCalendarCategory\TYPE_BOOK, and ilCalendarCategory\TYPE_CH.

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $tpl = $DIC['tpl'];

        $entry = (int) $_GET['app_id'];
    
        include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
        $entry = new ilCalendarEntry($entry);

        $category = $this->calendarEntryToCategory($entry);
        if ($category->getType() == ilCalendarCategory::TYPE_CH) {
            include_once 'Services/Booking/classes/class.ilBookingEntry.php';
            $booking = new ilBookingEntry($entry->getContextId());
            if (!$booking->hasBooked($entry->getEntryId())) {
                $this->ctrl->returnToParent($this);
                return false;
            }

            $entry_title = ' ' . $entry->getTitle() . " (" . ilObjUser::_lookupFullname($booking->getObjId()) . ')';
        } elseif ($category->getType() == ilCalendarCategory::TYPE_BOOK) {
            $entry_title = ' ' . $entry->getTitle();
        } else {
            $this->ctrl->returnToParent($this);
            return false;
        }

        $title = ilDatePresentation::formatPeriod($entry->getStart(), $entry->getEnd());
        
        include_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $conf = new ilConfirmationGUI;
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('cal_cancel_booking_info'));
        $conf->setConfirm($this->lng->txt('cal_cancel_booking'), 'cancelconfirmed');
        $conf->setCancel($this->lng->txt('cancel'), 'cancel');
        $conf->addItem('app_id', $entry->getEntryId(), $title . ' - ' . $entry_title);

        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

cancelConfirmed()

ilCalendarAppointmentGUI::cancelConfirmed

(

)

Cancel consultation appointment or ressource booking, was confirmed This will delete the calendar entry.

Definition at line 1514 of file class.ilCalendarAppointmentGUI.php.

References $_POST, $DIC, $ilUser, calendarEntryToCategory(), ilBookingEntry\cancelBooking(), ilConsultationHourAppointments\getAppointmentIds(), ilBookingReservation\setStatus(), ilBookingReservation\STATUS_CANCELLED, ilCalendarCategory\TYPE_BOOK, and ilCalendarCategory\TYPE_CH.

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        $entry = (int) $_POST['app_id'];

        include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
        $entry = new ilCalendarEntry($entry);
        
        $category = $this->calendarEntryToCategory($entry);
        if ($category->getType() == ilCalendarCategory::TYPE_CH) {
            // find cloned calendar entry in user calendar
            include_once 'Services/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php';
            $apps = ilConsultationHourAppointments::getAppointmentIds(
                $ilUser->getId(),
                $entry->getContextId(),
                $entry->getStart(),
                ilCalendarCategory::TYPE_CH,
                false
            );

            // Fix for wrong, old entries
            foreach ((array) $apps as $own_app) {
                $ref_entry = new ilCalendarEntry($own_app);
                $ref_entry->delete();
            }
            
            include_once 'Services/Booking/classes/class.ilBookingEntry.php';
            $booking = new ilBookingEntry($entry->getContextId());
            $booking->cancelBooking($entry->getEntryId());

        // do NOT delete original entry
        } elseif ($category->getType() == ilCalendarCategory::TYPE_BOOK) {
            $booking = new ilBookingReservation($entry->getContextId());
            $booking->setStatus(ilBookingReservation::STATUS_CANCELLED);
            $booking->update();
            
            $entry->delete();
        }

        ilUtil::sendSuccess($this->lng->txt('cal_cancel_booking_confirmed'), true);
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

confirmRegister()

ilCalendarAppointmentGUI::confirmRegister ( )

protected

Register to an appointment.

Returns

Definition at line 1273 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $DIC, $tpl, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilConfirmationGUI\setFormAction().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        $entry = new ilCalendarEntry((int) $_GET['app_id']);
        $start = ilDatePresentation::formatDate(
            new ilDateTime($_GET['dstart'], IL_CAL_UNIX),
            new ilDateTime($_GET['dend'], IL_CAL_UNIX)
        );
            
        
        include_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $conf = new ilConfirmationGUI;
        
        $this->ctrl->setParameter($this, 'dstart', (int) $_REQUEST['dstart']);
        $this->ctrl->setParameter($this, 'dend', (int) $_REQUEST['dend']);
        
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('cal_confirm_reg_info'));
        $conf->setConfirm($this->lng->txt('cal_reg_register'), 'register');
        $conf->setCancel($this->lng->txt('cancel'), 'cancel');
        $conf->addItem('app_id', $entry->getEntryId(), $entry->getTitle() . ' (' . $start . ')');
        
        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

confirmUnregister()

ilCalendarAppointmentGUI::confirmUnregister

(

)

Confirmation screen to unregister calendar.

Definition at line 1326 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $DIC, $tpl, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilConfirmationGUI\setFormAction().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        
        
        $entry = new ilCalendarEntry((int) $_GET['app_id']);
        $start = ilDatePresentation::formatDate(
            $dstart = new ilDateTime($_GET['dstart'], IL_CAL_UNIX),
            $dend = new ilDateTime($_GET['dend'], IL_CAL_UNIX)
        );
            
        
        include_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $conf = new ilConfirmationGUI;
        
        $this->ctrl->setParameter($this, 'dstart', (int) $_REQUEST['dstart']);
        $this->ctrl->setParameter($this, 'dend', (int) $_REQUEST['dend']);
        
        $conf->setFormAction($this->ctrl->getFormAction($this));
        $conf->setHeaderText($this->lng->txt('cal_confirm_unreg_info'));
        $conf->setConfirm($this->lng->txt('cal_reg_unregister'), 'unregister');
        $conf->setCancel($this->lng->txt('cancel'), 'cancel');
        $conf->addItem('app_id', $entry->getEntryId(), $entry->getTitle() . ' (' . $start . ')');
        
        $tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

createDefaultCalendar()

ilCalendarAppointmentGUI::createDefaultCalendar ( )

protected

Create a default calendar.

protected

Returns

Definition at line 1249 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $ilUser, $lng, ilCalendarCategory\DEFAULT_COLOR, ilCalendarCache\getInstance(), and ilCalendarCategory\TYPE_USR.

Referenced by save(), and update().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];

        $cat = new ilCalendarCategory();
        $cat->setColor(ilCalendarCategory::DEFAULT_COLOR);
        $cat->setType(ilCalendarCategory::TYPE_USR);
        $cat->setTitle($this->lng->txt('cal_default_calendar'));
        $cat->setObjId($ilUser->getId());
        
        // delete calendar cache
        include_once './Services/Calendar/classes/class.ilCalendarCache.php';
        ilCalendarCache::getInstance()->deleteUserEntries($ilUser->getId());

        return $cat->add();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilCalendarAppointmentGUI::delete ( )

protected

delete

protected

Parameters

Definition at line 902 of file class.ilCalendarAppointmentGUI.php.

References $app, ilCalendarCategoryAssignments\_deleteByAppointmentId(), and ilCalendarUserNotification\deleteCalendarEntry().

    {
        $app_ids = (array) ($this->request->getParsedBody()['appointment_ids'] ?? []);
        if (!$app_ids) {
            $this->logger->dump($app_ids);
            $app_ids = (array) ($this->request->getQueryParams()['app_id'] ?? []);
        }
        if (!$app_ids) {
            $this->ctrl->returnToParent($this);
        }
        foreach ($app_ids as $app_id) {
            $app = new ilCalendarEntry($app_id);
            $app->delete();
            
            include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
            ilCalendarCategoryAssignments::_deleteByAppointmentId($app_id);

            include_once './Services/Calendar/classes/class.ilCalendarUserNotification.php';
            ilCalendarUserNotification::deleteCalendarEntry($app_id);
        }
        ilUtil::sendSuccess($this->lng->txt('cal_deleted_app'), true);
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

deleteExclude()

ilCalendarAppointmentGUI::deleteExclude (   $a_return = true )

protected

delete single item of recurrence list

protected

Parameters

Definition at line 933 of file class.ilCalendarAppointmentGUI.php.

References IL_CAL_UNIX, and ilUtil\sendFailure().

    {
        $recurrence_ids = (array) ($this->request->getParsedBody()['recurrence_ids'] ?? []);
        $app_id = (int) ($this->request->getQueryParams()['app_id'] ?? 0);
        if (!count($recurrence_ids)) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'askDelete');
        }
        if (!$app_id) {
            $this->ctrl->returnToParent($this);
        }
        foreach ($recurrence_ids as $rdate) {
            $exclusion = new ilCalendarRecurrenceExclusion();
            $exclusion->setEntryId($app_id);
            $exclusion->setDate(new ilDate($rdate, IL_CAL_UNIX));
            $exclusion->save();
        }
        if ($a_return) {
            ilUtil::sendSuccess($this->lng->txt('cal_deleted_app'), true);
            $this->ctrl->returnToParent($this);
        }
    }

Here is the call graph for this function:

distributeNotifications()

ilCalendarAppointmentGUI::distributeNotifications (   $a_cat_id,   $app_id,   $a_new_appointment = true  )

protected

Distribute mail notifications.

Returns

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

References ilObject\_getAllReferences(), ilCalendarCategories\_getInstance(), ilCalendarMailNotification\TYPE_CRS_NEW_NOTIFICATION, ilCalendarMailNotification\TYPE_CRS_NOTIFICATION, ilCalendarMailNotification\TYPE_GRP_NEW_NOTIFICATION, ilCalendarMailNotification\TYPE_GRP_NOTIFICATION, and ilCalendarCategory\TYPE_OBJ.

Referenced by save(), and update().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
        $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($a_cat_id);
        
        include_once './Services/Calendar/classes/class.ilCalendarMailNotification.php';
        $notification = new ilCalendarMailNotification();
        $notification->setAppointmentId($app_id);
        
        switch ($cat_info['type']) {
            case ilCalendarCategory::TYPE_OBJ:
                
                    switch ($cat_info['obj_type']) {
                        case 'crs':
                            $ref_ids = ilObject::_getAllReferences($cat_info['obj_id']);
                            $ref_id = current($ref_ids);
                            $notification->setRefId($ref_id);
                            $notification->setType(
                                $a_new_appointment ?
                                ilCalendarMailNotification::TYPE_CRS_NEW_NOTIFICATION :
                                ilCalendarMailNotification::TYPE_CRS_NOTIFICATION
                            );
                            break;
                        
                        case 'grp':
                            $ref_ids = ilObject::_getAllReferences($cat_info['obj_id']);
                            $ref_id = current($ref_ids);
                            $notification->setRefId($ref_id);
                            $notification->setType(
                                $a_new_appointment ?
                                ilCalendarMailNotification::TYPE_GRP_NEW_NOTIFICATION :
                                ilCalendarMailNotification::TYPE_GRP_NOTIFICATION
                            );
                            break;
                    }
                    break;
        }

        $notification->send();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

distributeUserNotifications()

ilCalendarAppointmentGUI::distributeUserNotifications ( )

protected

Send mail to selected users ilObjUser $ilUser.

Definition at line 455 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $ilUser, ANONYMOUS_USER_ID, notification(), ilCalendarUserNotification\TYPE_EMAIL, ilCalendarUserNotification\TYPE_USER, ilCalendarMailNotification\TYPE_USER, and ilCalendarMailNotification\TYPE_USER_ANONYMOUS.

Referenced by save(), and update().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        include_once './Services/Calendar/classes/class.ilCalendarMailNotification.php';
        $notification = new ilCalendarMailNotification();
        $notification->setAppointmentId($this->app->getEntryId());
        
        foreach ($this->notification->getRecipients() as $rcp) {
            switch ($rcp['type']) {
                case ilCalendarUserNotification::TYPE_USER:
                    $notification->setSender(ANONYMOUS_USER_ID);
                    $notification->setRecipients(array($rcp['usr_id']));
                    $notification->setType(ilCalendarMailNotification::TYPE_USER);
                    break;

                case ilCalendarUserNotification::TYPE_EMAIL:
                    $notification->setSender(ANONYMOUS_USER_ID);
                    $notification->setRecipients(array($rcp['email']));
                    $notification->setType(ilCalendarMailNotification::TYPE_USER_ANONYMOUS);
                    break;
            }
            $notification->send();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUserAutoComplete()

ilCalendarAppointmentGUI::doUserAutoComplete ( )

protected

Do auto completion.

Returns

void

Definition at line 1578 of file class.ilCalendarAppointmentGUI.php.

References $_GET, exit, and ilUserAutoComplete\MAX_ENTRIES.

    {
        if (!isset($_GET['autoCompleteField'])) {
            $a_fields = array('login','firstname','lastname','email');
        } else {
            $a_fields = array((string) $_GET['autoCompleteField']);
        }

        include_once './Services/User/classes/class.ilUserAutoComplete.php';
        $auto = new ilUserAutoComplete();
        $auto->setSearchFields($a_fields);
        $auto->enableFieldSearchableCheck(true);
        $auto->setMoreLinkAvailable(true);

        if (($_REQUEST['fetchall'])) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }

        echo $auto->getList($_REQUEST['query']);
        exit();
    }

edit()

ilCalendarAppointmentGUI::edit (   $a_edit_single_app = false, ilPropertyFormGUI  $form = null  )

protected

edit appointment

protected

Parameters

bool	singel appointment

Definition at line 620 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $GLOBALS, $ilErr, $ilUser, $tpl, ilDateTime\_equals(), ilCalendarCategories\_getInstance(), ilCalendarCategoryAssignments\_lookupCategory(), getAppointment(), IL_CAL_DAY, IL_CAL_UNIX, initForm(), and showInfoScreen().

Referenced by askEdit(), editSingle(), and update().

    {
        global $DIC;

        $tpl = $DIC->ui()->mainTemplate();
        $ilUser = $DIC['ilUser'];
        $ilErr = $DIC['ilErr'];
        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setScreenIdComponent("cal");
        $ilHelp->setScreenId("app");
        if ($this->app->isMilestone()) {
            $ilHelp->setSubScreenId("edit_milestone");
        } else {
            $ilHelp->setSubScreenId("edit");
        }

        include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
        include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');

        $GLOBALS['DIC']['ilCtrl']->saveParameter($this, array('seed','app_id','dt','idate'));

        if ($_REQUEST['rexl']) {
            $GLOBALS['DIC']['ilCtrl']->setParameter($this, 'rexl', 1);
            // Calculate new appointment time
            $duration = $this->getAppointment()->getEnd()->get(IL_CAL_UNIX) - $this->getAppointment()->getStart()->get(IL_CAL_UNIX);
            include_once './Services/Calendar/classes/class.ilCalendarRecurrenceCalculator.php';
            $calc = new ilCalendarRecurrenceCalculator($this->getAppointment(), $this->rec);
            
            $current_date = new ilDateTime($_REQUEST['dt'], IL_CAL_UNIX);

            $yesterday = clone $current_date;
            $yesterday->increment(IL_CAL_DAY, -1);
            $tomorrow = clone $current_date;
            $tomorrow->increment(IL_CAL_DAY, 1);
            

            foreach ($calc->calculateDateList($current_date, $tomorrow, 1) as $date_entry) {
                if (ilDateTime::_equals($current_date, $date_entry, IL_CAL_DAY)) {
                    $this->getAppointment()->setStart(new ilDateTime($date_entry->get(IL_CAL_UNIX), IL_CAL_UNIX));
                    $this->getAppointment()->setEnd(new ilDateTime($date_entry->get(IL_CAL_UNIX) + $duration, IL_CAL_UNIX));
                    break;
                }
            }
            
            // Finally reset recurrence
            $this->rec = new ilCalendarRecurrence();
        }
        
        $cat_id = ilCalendarCategoryAssignments::_lookupCategory($this->app->getEntryId());
        $cats = ilCalendarCategories::_getInstance($ilUser->getId());
        
        if (!$cats->isVisible($cat_id)) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->WARNING);
            return false;
        }
        if (!$cats->isEditable($cat_id) or $this->app->isAutoGenerated()) {
            $this->showInfoScreen();
            return true;
        }
        if (!$form instanceof ilPropertyFormGUI) {
            $this->initForm('edit', $this->app->isMilestone(), $a_edit_single_app);
        }
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editResponsibleUsers()

ilCalendarAppointmentGUI::editResponsibleUsers

(

)

Edit responsible users.

Definition at line 532 of file class.ilCalendarAppointmentGUI.php.

References ilCalendarCategories\_getInstance(), ilCalendarCategoryAssignments\_lookupCategory(), and showResponsibleUsersList().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        $cat_id = ilCalendarCategoryAssignments::_lookupCategory($this->app->getEntryId());
        include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
        $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);

        $this->showResponsibleUsersList($cat_info['obj_id']);
    }

Here is the call graph for this function:

editSingle()

ilCalendarAppointmentGUI::editSingle ( )

protected

Edit one single appointment ^.

Definition at line 605 of file class.ilCalendarAppointmentGUI.php.

References $GLOBALS, and edit().

    {
        $_REQUEST['rexl'] = 1;
        $GLOBALS['DIC']['ilCtrl']->setParameter($this, 'rexcl', 1);
        $this->edit(true);
    }

Here is the call graph for this function:

executeCommand()

ilCalendarAppointmentGUI::executeCommand

(

)

Definition at line 60 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $ilSetting, $ilUser, and $tpl.

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        
        
        // Clear tabs and set back target
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt('cal_back_to_cal'),
            $this->ctrl->getLinkTarget($this, 'cancel')
        );

        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            
            default:
                $cmd = $this->ctrl->getCmd("add");
                $this->$cmd();
                break;
        }
    }

getAppointment()

ilCalendarAppointmentGUI::getAppointment

(

)

Get current appointment.

Returns

ilCalendarEntry

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

References $app.

Referenced by askEdit(), edit(), and update().

    {
        return $this->app;
    }

Here is the caller graph for this function:

initAppointment()

ilCalendarAppointmentGUI::initAppointment (   $a_app_id = 0 )

protected

init appointment

protected

Parameters

int	appointment id

Returns

Definition at line 1012 of file class.ilCalendarAppointmentGUI.php.

References $initialDate, ilCalendarRecurrences\_getFirstRecurrence(), IL_CAL_HOUR, and notification().

Referenced by __construct().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
        include_once('./Services/Calendar/classes/class.ilCalendarRecurrences.php');
        $this->app = new ilCalendarEntry($a_app_id);

        include_once './Services/Calendar/classes/class.ilCalendarUserNotification.php';
        $this->notification = new ilCalendarUserNotification($this->app->getEntryId());
        
        if (!$a_app_id) {
            $start = clone $this->initialDate;
            $this->app->setStart($start);

            $seed_end = clone $this->initialDate;
            if ($this->default_fulltime) {
                #$seed_end->increment(IL_CAL_DAY,1);
            } else {
                $seed_end->increment(IL_CAL_HOUR, 1);
            }
            $this->app->setEnd($seed_end);
            $this->app->setFullday($this->default_fulltime);
            
            $this->rec = new ilCalendarRecurrence();
        } else {
            $this->rec = ilCalendarRecurrences::_getFirstRecurrence($this->app->getEntryId());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilCalendarAppointmentGUI::initForm (   $a_mode,   $a_as_milestone = false,   $a_edit_single_app = false  )

protected

init form

protected

Parameters

string

mode ('edit' | 'create')

Returns

Definition at line 115 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $_POST, $DIC, $i, $ilUser, $rec, XapiProxy\$resp, $tpl, $type, ilCalendarCategories\_getInstance(), ilCalendarSettings\_getInstance(), ilCalendarCategories\_lookupCategoryIdByObjId(), ilObjUser\_lookupLogin(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilCalendarCategoryAssignments\getFirstAssignment(), ilYuiUtil\initDomEvent(), notification(), ilDateTimeInputGUI\setDate(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setValue(), ilCalendarUserNotification\TYPE_EMAIL, ilCalendarCategory\TYPE_OBJ, and ilCalendarUserNotification\TYPE_USER.

Referenced by add(), addMilestone(), edit(), and load().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $tpl = $DIC['tpl'];
        
        $this->form = new ilPropertyFormGUI();
        
        include_once('./Services/YUI/classes/class.ilYuiUtil.php');
        ilYuiUtil::initDomEvent();
        $resp_info = false;
        switch ($a_mode) {
            case 'create':
                $this->ctrl->saveParameter($this, array('seed','idate'));
                $this->form->setFormAction($this->ctrl->getFormAction($this));
                if ($a_as_milestone) {
                    $this->form->setTitle($this->lng->txt('cal_new_ms'));
                    $this->form->addCommandButton('saveMilestone', $this->lng->txt('cal_add_milestone'));
                    $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
                } else {
                    $this->form->setTitle($this->lng->txt('cal_new_app'));
                    $this->form->addCommandButton('save', $this->lng->txt('cal_add_appointment'));
                    $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
                }
                break;

            case 'edit':
                if ($a_as_milestone) {
                    $this->form->setTitle($this->lng->txt('cal_edit_milestone'));
                } else {
                    $this->form->setTitle($this->lng->txt('cal_edit_appointment'));
                }
                $this->ctrl->saveParameter($this, array('seed','app_id','idate'));
                $this->form->setFormAction($this->ctrl->getFormAction($this));
                
                $ass = new ilCalendarCategoryAssignments($this->app->getEntryId());
                $cat = $ass->getFirstAssignment();
                include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
                $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat);
                $type = ilObject::_lookupType($cat_info['obj_id']);
                if ($a_as_milestone && $cat_info['type'] == ilCalendarCategory::TYPE_OBJ
                    && ($type == "grp" || $type == "crs")) {
                    $resp_info = true;
                    $this->form->addCommandButton('editResponsibleUsers', $this->lng->txt('cal_change_responsible_users'));
                }
                $this->form->addCommandButton('update', $this->lng->txt('save'));
                // $this->form->addCommandButton('askDelete',$this->lng->txt('delete'));
                $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
                break;
        }
        // title
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setValue($this->app->getTitle());
        $title->setRequired(true);
        $title->setMaxLength(128);
        $title->setSize(32);
        $this->form->addItem($title);
        
        // calendar selection
        $calendar = new ilSelectInputGUI($this->lng->txt('cal_category_selection'), 'calendar');
        if ($_POST['category']) {
            $calendar->setValue((int) $_POST['calendar']);
            $selected_calendar = (int) $_POST['calendar'];
        } elseif ($_GET['category_id']) {
            $calendar->setValue((int) $_GET['category_id']);
            $selected_calendar = (int) $_GET['category_id'];
        } elseif ($a_mode == 'edit') {
            $ass = new ilCalendarCategoryAssignments($this->app->getEntryId());
            $cat = $ass->getFirstAssignment();
            $calendar->setValue($cat);
            $selected_calendar = $cat;
        } elseif (isset($_GET['ref_id'])) {
            include_once('./Services/Calendar/classes/class.ilCalendarCategories.php');
            $obj_cal = ilObject::_lookupObjId($_GET['ref_id']);
            $calendar->setValue(ilCalendarCategories::_lookupCategoryIdByObjId($obj_cal));
            $selected_calendar = ilCalendarCategories::_lookupCategoryIdByObjId($obj_cal);
            $cats = ilCalendarCategories::_getInstance($ilUser->getId());
            $cats->readSingleCalendar($selected_calendar);
        } else {
            $cats = ilCalendarCategories::_getInstance($ilUser->getId());
            $categories = $cats->prepareCategoriesOfUserForSelection();
            $selected_calendar = key((array) $categories);
            $calendar->setValue($selected_calendar);
        }
        $calendar->setRequired(true);
        $cats = ilCalendarCategories::_getInstance($ilUser->getId());
        $calendar->setOptions($cats->prepareCategoriesOfUserForSelection());
        
        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
        if (ilCalendarSettings::_getInstance()->isNotificationEnabled()) {
            $notification_cals = $cats->getNotificationCalendars();
            $notification_cals = count($notification_cals) ? implode(',', $notification_cals) : '';
            $calendar->addCustomAttribute("onchange=\"ilToggleNotification([" . $notification_cals . "]);\"");
        }
        $this->form->addItem($calendar);
        
        if (!$a_as_milestone) {
            include_once './Services/Form/classes/class.ilDateDurationInputGUI.php';
            $tpl->addJavaScript('./Services/Form/js/date_duration.js');
            $dur = new ilDateDurationInputGUI($this->lng->txt('cal_fullday'), 'event');
            $dur->setRequired(true);
            $dur->enableToggleFullTime(
                $this->lng->txt('cal_fullday_title'),
                $this->app->isFullday() ? true : false
            );
            $dur->setShowTime(true);
            $dur->setStart($this->app->getStart());
            $dur->setEnd($this->app->getEnd());
            $this->form->addItem($dur);

            // recurrence
            include_once('./Services/Calendar/classes/Form/class.ilRecurrenceInputGUI.php');
            $rec = new ilRecurrenceInputGUI($this->lng->txt('cal_recurrences'), 'frequence');
            $rec->setRecurrence($this->rec);
            $this->form->addItem($rec);

            // location
            $where = new ilTextInputGUI($this->lng->txt('cal_where'), 'location');
            $where->setValue($this->app->getLocation());
            $where->setMaxLength(128);
            $where->setSize(32);
            $this->form->addItem($where);
        } else {
            $deadline = new ilDateTimeInputGUI($this->lng->txt('cal_deadline'), 'event_start');
            $deadline->setDate($this->app->getStart());
            $deadline->setShowTime(false);
            $deadline->setMinuteStepSize(5);
            $this->form->addItem($deadline);
            
            // completion
            $completion_vals = array();
            for ($i = 0; $i <= 100; $i += 5) {
                $completion_vals[$i] = $i . " %";
            }
            $compl = new ilSelectInputGUI(
                $this->lng->txt('cal_task_completion'),
                'completion'
            );
            $compl->setOptions($completion_vals);
            $compl->setValue($this->app->getCompletion());
            $this->form->addItem($compl);
        }
        
        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $desc->setValue($this->app->getDescription());
        $desc->setRows(5);
        $this->form->addItem($desc);

        if ($a_as_milestone && $a_mode == "edit" && $resp_info) {
            // users responsible
            $users = $this->app->readResponsibleUsers();
            $resp = new ilNonEditableValueGUI($this->lng->txt('cal_responsible'), "", true);
            $delim = "";
            foreach ($users as $r) {
                $value .= $delim . $r["lastname"] . ", " . $r["firstname"] . " [" . $r["login"] . "]";
                $delim = "<br />";
            }
            if (count($users) > 0) {
                $resp->setValue($value);
            } else {
                $resp->setValue("-");
            }

            $this->form->addItem($resp);
        }
        

        if (ilCalendarSettings::_getInstance()->isUserNotificationEnabled()) {
            $notu = new ilTextWizardInputGUI($this->lng->txt('cal_user_notification'), 'notu');
            $notu->setInfo($this->lng->txt('cal_user_notification_info'));
            $notu->setSize(20);
            $notu->setMaxLength(64);

            $values = array();
            foreach ($this->notification->getRecipients() as $rcp) {
                switch ($rcp['type']) {
                    case ilCalendarUserNotification::TYPE_USER:
                        $values[] = ilObjUser::_lookupLogin($rcp['usr_id']);
                        break;

                    case ilCalendarUserNotification::TYPE_EMAIL:
                        $values[] = $rcp['email'];
                        break;
                }
            }
            if (count($values)) {
                $notu->setValues($values);
            } else {
                $notu->setValues(array(''));
            }
            $this->form->addItem($notu);
        }

        // Notifications
        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
        if (ilCalendarSettings::_getInstance()->isNotificationEnabled() and count($cats->getNotificationCalendars())) {
            $selected_cal = new ilCalendarCategory($selected_calendar);
            $disabled = true;
            if ($selected_cal->getType() == ilCalendarCategory::TYPE_OBJ) {
                if (ilObject::_lookupType($selected_cal->getObjId()) == 'crs' or ilObject::_lookupType($selected_cal->getObjId()) == 'grp') {
                    $disabled = false;
                }
            }

            $tpl->addJavaScript('./Services/Calendar/js/toggle_notification.js');
            $not = new ilCheckboxInputGUI($this->lng->txt('cal_cg_notification'), 'not');
            $not->setInfo($this->lng->txt('cal_notification_info'));
            $not->setValue(1);
            $not->setChecked($this->app->isNotificationEnabled());
            $not->setDisabled($disabled);
            $this->form->addItem($not);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormConfirmBooking()

ilCalendarAppointmentGUI::initFormConfirmBooking ( )

protected

Returns

ilPropertyFormGUI

Definition at line 1409 of file class.ilCalendarAppointmentGUI.php.

References $message.

Referenced by book(), and bookconfirmed().

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->addCommandButton('bookconfirmed', $this->lng->txt('cal_confirm_booking'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));
        
        $date = new ilNonEditableValueGUI($this->lng->txt('appointment'), 'date');
        $form->addItem($date);
        
        $title = new ilNonEditableValueGUI($this->lng->txt('title'), 'title');
        $form->addItem($title);
        
        $message = new ilTextAreaInputGUI($this->lng->txt('cal_ch_booking_message_tbl'), 'comment');
        $message->setRows(5);
        $form->addItem($message);
        
        return $form;
    }

Here is the caller graph for this function:

initInitialDate()

ilCalendarAppointmentGUI::initInitialDate ( ilDate  $initialDate )

protected

init initial date

Parameters

ilDate

$initialDate

Definition at line 976 of file class.ilCalendarAppointmentGUI.php.

References $_GET, $initialDate, $timezone, ilDate\get(), IL_CAL_DATE, and IL_CAL_DATETIME.

Referenced by __construct().

    {
        if (!isset($_GET['hour'])) {
            $this->initialDate = clone $initialDate;
            $this->default_fulltime = true;
        } else {
            if ((int) $_GET['hour'] < 10) {
                $time = '0' . (int) $_GET['hour'] . ':00:00';
            } else {
                $time = (int) $_GET['hour'] . ':00:00';
            }
            $this->initialDate = new ilDateTime($initialDate->get(IL_CAL_DATE) . ' ' . $time, IL_CAL_DATETIME, $this->timezone);
            $this->default_fulltime = false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSeed()

ilCalendarAppointmentGUI::initSeed ( ilDate  $seed )

protected

init seed

protected

Parameters

Definition at line 999 of file class.ilCalendarAppointmentGUI.php.

References $seed.

Referenced by __construct().

    {
        $this->seed = clone $seed;
        $this->default_fulltime = true;
    }

Here is the caller graph for this function:

initTimeZone()

ilCalendarAppointmentGUI::initTimeZone ( )

protected

init timezone

protected

Parameters

Definition at line 963 of file class.ilCalendarAppointmentGUI.php.

References $DIC, and $ilUser.

Referenced by __construct().

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        $this->timezone = $ilUser->getTimeZone();
    }

Here is the caller graph for this function:

load()

ilCalendarAppointmentGUI::load (   $a_mode,   $a_as_milestone = false  )

protected

load post

protected

Parameters

Definition at line 1047 of file class.ilCalendarAppointmentGUI.php.

References $_POST, initForm(), loadNotificationRecipients(), loadRecurrenceSettings(), and ilUtil\stripSlashes().

Referenced by save(), and update().

    {
        // needed for date handling
        $this->initForm($a_mode, $a_as_milestone);
        $this->form->checkInput();
        
        if ($a_as_milestone) {
            $this->app->setMilestone(true);
            $this->app->setCompletion(ilUtil::stripSlashes($_POST['completion']));
        }
        
        $this->app->setTitle(ilUtil::stripSlashes($_POST['title']));
        $this->app->setLocation(ilUtil::stripSlashes($_POST['location']));
        $this->app->setDescription(ilUtil::stripSlashes($_POST['description']));
        $this->app->setTitle(ilUtil::stripSlashes($_POST['title']));
        $this->app->enableNotification((int) $_POST['not']);
        
        if ($a_as_milestone) {  // milestones are always fullday events
            $start = $this->form->getItemByPostVar('event_start');
            $start = $start->getDate();
            
            $this->app->setFullday(true);
            
            // for milestones is end date = start date
            $this->app->setStart($start);
            $this->app->setEnd($start);
        } else {
            $period = $this->form->getItemByPostVar('event');
            $start = $period->getStart();
            $end = $period->getEnd();
            
            $this->app->setFullday($start instanceof ilDate);
            $this->app->setStart($start);
            $this->app->setEnd($end);
        }

        $this->loadNotificationRecipients();
        $this->loadRecurrenceSettings($a_as_milestone = false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadNotificationRecipients()

ilCalendarAppointmentGUI::loadNotificationRecipients ( )

protected

Definition at line 1087 of file class.ilCalendarAppointmentGUI.php.

References $_POST, ilObjUser\_loginExists(), notification(), ilUtil\stripSlashes(), ilCalendarUserNotification\TYPE_EMAIL, and ilCalendarUserNotification\TYPE_USER.

Referenced by load().

    {
        $this->notification->setRecipients(array());

        foreach ((array) $_POST['notu'] as $rcp) {
            $rcp = trim(ilUtil::stripSlashes($rcp));
            $usr_id = ilObjUser::_loginExists($rcp);

            if (strlen($rcp) == 0) {
                continue;
            }

            if ($usr_id) {
                $this->notification->addRecipient(
                    ilCalendarUserNotification::TYPE_USER,
                    $usr_id
                );
            } else {
                $this->notification->addRecipient(
                    ilCalendarUserNotification::TYPE_EMAIL,
                    0,
                    $rcp
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadRecurrenceSettings()

ilCalendarAppointmentGUI::loadRecurrenceSettings (   $a_as_milestone = false )

protected

load recurrence settings

protected

Returns

Definition at line 1120 of file class.ilCalendarAppointmentGUI.php.

References $_POST, IL_CAL_FREQ_DAILY, IL_CAL_FREQ_MONTHLY, IL_CAL_FREQ_WEEKLY, IL_CAL_FREQ_YEARLY, and ilUtil\stripSlashes().

Referenced by load().

    {
        $this->rec->reset();
        
        switch ($_POST['frequence']) {
            case IL_CAL_FREQ_DAILY:
                $this->rec->setFrequenceType($_POST['frequence']);
                $this->rec->setInterval((int) $_POST['count_DAILY']);
                break;
            
            case IL_CAL_FREQ_WEEKLY:
                $this->rec->setFrequenceType($_POST['frequence']);
                $this->rec->setInterval((int) $_POST['count_WEEKLY']);
                if (is_array($_POST['byday_WEEKLY'])) {
                    $this->rec->setBYDAY(ilUtil::stripSlashes(implode(',', $_POST['byday_WEEKLY'])));
                }
                break;

            case IL_CAL_FREQ_MONTHLY:
                $this->rec->setFrequenceType($_POST['frequence']);
                $this->rec->setInterval((int) $_POST['count_MONTHLY']);
                switch ((int) $_POST['subtype_MONTHLY']) {
                    case 0:
                        // nothing to do;
                        break;
                    
                    case 1:
                        switch ((int) $_POST['monthly_byday_day']) {
                            case 8:
                                // Weekday
                                $this->rec->setBYSETPOS((int) $_POST['monthly_byday_num']);
                                $this->rec->setBYDAY('MO,TU,WE,TH,FR');
                                break;
                                
                            case 9:
                                // Day of month
                                $this->rec->setBYMONTHDAY((int) $_POST['monthly_byday_num']);
                                break;
                                
                            default:
                                $this->rec->setBYDAY((int) $_POST['monthly_byday_num'] . $_POST['monthly_byday_day']);
                                break;
                        }
                        break;
                    
                    case 2:
                        $this->rec->setBYMONTHDAY((int) $_POST['monthly_bymonthday']);
                        break;
                }
                break;
            
            case IL_CAL_FREQ_YEARLY:
                $this->rec->setFrequenceType($_POST['frequence']);
                $this->rec->setInterval((int) $_POST['count_YEARLY']);
                switch ((int) $_POST['subtype_YEARLY']) {
                    case 0:
                        // nothing to do;
                        break;
                    
                    case 1:
                        $this->rec->setBYMONTH((int) $_POST['yearly_bymonth_byday']);
                        $this->rec->setBYDAY((int) $_POST['yearly_byday_num'] . $_POST['yearly_byday']);
                        break;
                    
                    case 2:
                        $this->rec->setBYMONTH((int) $_POST['yearly_bymonth_by_monthday']);
                        $this->rec->setBYMONTHDAY((int) $_POST['yearly_bymonthday']);
                        break;
                }
                break;
        }
        
        // UNTIL
        switch ((int) $_POST['until_type']) {
            case 1:
                $this->rec->setFrequenceUntilDate(null);
                // nothing to do
                break;
                
            case 2:
                $this->rec->setFrequenceUntilDate(null);
                $this->rec->setFrequenceUntilCount((int) $_POST['count']);
                break;
                
            case 3:
                $dt = new ilDateTimeInputGUI('', 'until_end');
                $dt->setRequired(true);
                if ($dt->checkInput()) {
                    $this->rec->setFrequenceUntilCount(0);
                    $this->rec->setFrequenceUntilDate($dt->getDate());
                }
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

register()

ilCalendarAppointmentGUI::register ( )

protected

Register.

Returns

Definition at line 1305 of file class.ilCalendarAppointmentGUI.php.

References $_POST, $DIC, $ilUser, and IL_CAL_UNIX.

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        include_once './Services/Calendar/classes/class.ilCalendarRegistration.php';
        $reg = new ilCalendarRegistration((int) $_POST['app_id']);
        $reg->register(
            $ilUser->getId(),
            new ilDateTime((int) $_REQUEST['dstart'], IL_CAL_UNIX),
            new ilDateTime((int) $_REQUEST['dend'], IL_CAL_UNIX)
        );

        ilUtil::sendSuccess($this->lng->txt('cal_reg_registered'), true);
        $this->ctrl->returnToParent($this);
    }

save()

ilCalendarAppointmentGUI::save (   $a_as_milestone = false )

protected

save appointment

protected

Definition at line 390 of file class.ilCalendarAppointmentGUI.php.

References $_POST, $DIC, $ilErr, $type, ilCalendarCategories\_getInstance(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), add(), ilCalendarCategoryAssignments\addAssignment(), addMilestone(), createDefaultCalendar(), distributeNotifications(), distributeUserNotifications(), load(), notification(), saveRecurrenceSettings(), ilUtil\sendFailure(), showResponsibleUsersList(), and ilCalendarCategory\TYPE_OBJ.

Referenced by saveMilestone().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        
        $this->load('create', $a_as_milestone);
        
        if ($this->app->validate() and $this->notification->validate()) {
            if (!(int) $_POST['calendar']) {
                $cat_id = $this->createDefaultCalendar();
            } else {
                $cat_id = (int) $_POST['calendar'];
            }
            
            $this->app->save();
            $this->notification->setEntryId($this->app->getEntryId());
            $this->notification->save();
            $this->rec->setEntryId($this->app->getEntryId());
            $this->saveRecurrenceSettings();
            
            include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
            $ass = new ilCalendarCategoryAssignments($this->app->getEntryId());
            $ass->addAssignment($cat_id);
            
            // Send notifications
            include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
            if (ilCalendarSettings::_getInstance()->isNotificationEnabled() and (bool) $_POST['not']) {
                $this->distributeNotifications($cat_id, $this->app->getEntryId(), true);
            }
            if (ilCalendarSettings::_getInstance()->isUserNotificationEnabled()) {
                $this->distributeUserNotifications();
            }

            include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
            $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);
            $type = ilObject::_lookupType($cat_info['obj_id']);
            
            if ($a_as_milestone && $cat_info['type'] == ilCalendarCategory::TYPE_OBJ
                && ($type == "grp" || $type == "crs")) {
                ilUtil::sendSuccess($this->lng->txt('cal_created_milestone_resp_q'), true);
                return $this->showResponsibleUsersList($cat_info['obj_id']);
            } elseif ($a_as_milestone) {
                ilUtil::sendSuccess($this->lng->txt('cal_created_milestone'), true);
                $this->ctrl->returnToParent($this);
            } else {
                ilUtil::sendSuccess($this->lng->txt('cal_created_appointment'), true);
                $this->ctrl->returnToParent($this);
            }
        } else {
            $this->form->setValuesByPost();
            ilUtil::sendFailure($ilErr->getMessage());
            return $this->add($this->form);
        }
        if ($a_as_milestone) {
            $this->addMilestone();
        } else {
            $this->add();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveMilestone()

ilCalendarAppointmentGUI::saveMilestone ( )

protected

save milestone

protected

Definition at line 380 of file class.ilCalendarAppointmentGUI.php.

References save().

    {
        $this->save(true);
    }

Here is the call graph for this function:

saveMilestoneResponsibleUsers()

ilCalendarAppointmentGUI::saveMilestoneResponsibleUsers

(

)

Save milestone responsibilites.

Definition at line 565 of file class.ilCalendarAppointmentGUI.php.

References $_POST, and $DIC.

    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];

        $this->app->writeResponsibleUsers($_POST["user_id"]);
        $ilCtrl->returnToParent($this);
    }

saveRecurrenceSettings()

ilCalendarAppointmentGUI::saveRecurrenceSettings ( )

protected

save recurrence settings

protected

Parameters

Definition at line 1222 of file class.ilCalendarAppointmentGUI.php.

References $_POST.

Referenced by save(), and update().

    {
        switch ($_POST['frequence']) {
            case 'NONE':
            case '':
                // No recurrence => delete if there is an recurrence rule
                if ($this->rec->getRecurrenceId()) {
                    $this->rec->delete();
                }
                break;
            
            default:
                if ($this->rec->getRecurrenceId()) {
                    $this->rec->update();
                } else {
                    $this->rec->save();
                }
                break;
        }
    }

Here is the caller graph for this function:

showInfoScreen()

ilCalendarAppointmentGUI::showInfoScreen ( )

protected

show info screen

protected

Returns

Definition at line 693 of file class.ilCalendarAppointmentGUI.php.

References $DIC, $ilUser, $tpl, $type, ilObject\_getAllReferences(), ilCalendarCategories\_getInstance(), ilLink\_getStaticLink(), ilCalendarCategoryAssignments\_lookupCategory(), ilObject\_lookupType(), ilDatePresentation\formatPeriod(), and ilCalendarCategory\TYPE_OBJ.

Referenced by edit().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $ilUser = $DIC['ilUser'];
        
        include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));

        if ($this->app->isMilestone()) {
            $info->addSection($this->lng->txt('cal_ms_details'));
        } else {
            $info->addSection($this->lng->txt('cal_details'));
        }

        // Appointment
        $info->addProperty(
            $this->lng->txt('appointment'),
            ilDatePresentation::formatPeriod(
                $this->app->getStart(),
                $this->app->getEnd()
            )
        );
        $info->addProperty($this->lng->txt('title'), $this->app->getPresentationTitle());

        // Description
        if (strlen($desc = $this->app->getDescription())) {
            $info->addProperty($this->lng->txt('description'), $desc);
        }
        
        // Location
        if (strlen($loc = $this->app->getLocation())) {
            $info->addProperty($this->lng->txt('cal_where'), $loc);
        }

        // completion
        if ($this->app->isMilestone() && $this->app->getCompletion() > 0) {
            $info->addProperty(
                $this->lng->txt('cal_task_completion'),
                $this->app->getCompletion() . " %"
            );
        }

        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        $cat_id = ilCalendarCategoryAssignments::_lookupCategory($this->app->getEntryId());
        $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);
        $type = ilObject::_lookupType($cat_info['obj_id']);
        if ($this->app->isMilestone() && $cat_info['type'] == ilCalendarCategory::TYPE_OBJ
            && ($type == "grp" || $type == "crs")) {
            // users responsible
            $users = $this->app->readResponsibleUsers();
            $delim = "";
            foreach ($users as $r) {
                $value .= $delim . $r["lastname"] . ", " . $r["firstname"] . " [" . $r["login"] . "]";
                $delim = "<br />";
            }
            if (count($users) > 0) {
                $info->addProperty(
                    $this->lng->txt('cal_responsible'),
                    $value
                );
            }
        }

        $category = new ilCalendarCategory($cat_id);
        
        if ($category->getType() == ilCalendarCategory::TYPE_OBJ) {
            $info->addSection($this->lng->txt('additional_info'));
            
            $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);
            $refs = ilObject::_getAllReferences($cat_info['obj_id']);
            
            include_once('./Services/Link/classes/class.ilLink.php');
            $href = ilLink::_getStaticLink(current($refs), ilObject::_lookupType($cat_info['obj_id']), true);
            $info->addProperty($this->lng->txt('perma_link'), '<a class="small" href="' . $href . '" target="_top">' . $href . '</a>');
        }
            
        $tpl->setContent($info->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showResponsibleUsersList()

ilCalendarAppointmentGUI::showResponsibleUsersList

(

$a_grp_id

)

Show responsible uses of a milestone (default set is participants of group)

Definition at line 546 of file class.ilCalendarAppointmentGUI.php.

References $DIC, and $tpl.

Referenced by editResponsibleUsers(), and save().

    {
        global $DIC;

        $tpl = $DIC['tpl'];

        include_once("./Services/Calendar/classes/class.ilMilestoneResponsiblesTableGUI.php");
        $table_gui = new ilMilestoneResponsiblesTableGUI(
            $this,
            "",
            $a_grp_id,
            $this->app->getEntryId()
        );
        $tpl->setContent($table_gui->getHTML());
    }

Here is the caller graph for this function:

unregister()

ilCalendarAppointmentGUI::unregister ( )

protected

Unregister calendar, was confirmed.

Returns

Definition at line 1359 of file class.ilCalendarAppointmentGUI.php.

References $_POST, $DIC, $ilUser, and IL_CAL_UNIX.

    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        include_once './Services/Calendar/classes/class.ilCalendarRegistration.php';
        $reg = new ilCalendarRegistration((int) $_POST['app_id']);
        $reg->unregister(
            $ilUser->getId(),
            new ilDateTime((int) $_REQUEST['dstart'], IL_CAL_UNIX),
            new ilDateTime((int) $_REQUEST['dend'], IL_CAL_UNIX)
        );

        ilUtil::sendSuccess($this->lng->txt('cal_reg_unregistered'), true);
        $this->ctrl->returnToParent($this);
    }

update()

ilCalendarAppointmentGUI::update ( )

protected

update

protected

Returns

Definition at line 781 of file class.ilCalendarAppointmentGUI.php.

References $_POST, $DIC, $ilErr, ilCalendarSettings\_getInstance(), createDefaultCalendar(), ilCalendarCategoryAssignments\deleteAssignments(), distributeNotifications(), distributeUserNotifications(), edit(), ilDatePresentation\formatDate(), getAppointment(), IL_CAL_UNIX, load(), notification(), saveRecurrenceSettings(), and ilUtil\sendFailure().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];

        $single_editing = ($_REQUEST['rexl'] ? true : false);
        
        $this->load('edit', $this->app->isMilestone());
        if ($this->app->validate() and $this->notification->validate()) {
            if (!(int) $_POST['calendar']) {
                $cat_id = $this->createDefaultCalendar();
            } else {
                $cat_id = (int) $_POST['calendar'];
            }
            
            if ($single_editing) {
                $original_id = $this->getAppointment()->getEntryId();
                $this->getAppointment()->save();
                $selected_ut = (int) ($this->request->getQueryParams()['dt'] ?? 0);
                if ($selected_ut > 0) {
                    $exclusion = new ilCalendarRecurrenceExclusion();
                    $exclusion->setEntryId($original_id);
                    $exclusion->setDate(new ilDate($selected_ut, IL_CAL_UNIX));
                    $this->logger->dump($this->getAppointment()->getEntryId());
                    $this->logger->dump(ilDatePresentation::formatDate(new ilDate($selected_ut, IL_CAL_UNIX)));
                    $exclusion->save();
                }
                $this->rec = new ilCalendarRecurrence();
                $this->rec->setEntryId($this->getAppointment()->getEntryId());
            } else {
                $this->getAppointment()->update();
            }
            $this->notification->save();
            $this->saveRecurrenceSettings();
            include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
            $ass = new ilCalendarCategoryAssignments($this->app->getEntryId());
            $this->logger->debug($this->app->getEntryId());
            $ass->deleteAssignments();
            $ass->addAssignment($cat_id);
            
            // Send notifications
            include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
            if (ilCalendarSettings::_getInstance()->isNotificationEnabled() and (bool) $_POST['not']) {
                $this->distributeNotifications($cat_id, $this->app->getEntryId(), false);
            }
            if (ilCalendarSettings::_getInstance()->isUserNotificationEnabled()) {
                $this->distributeUserNotifications();
            }
            
            ilUtil::sendSuccess($this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->returnToParent($this);
        } else {
            $this->form->setValuesByPost();
            ilUtil::sendFailure($ilErr->getMessage());
        }
        $this->edit(false, $this->form);
    }

Here is the call graph for this function:

Field Documentation

$app

ilCalendarAppointmentGUI::$app = null

protected

Definition at line 18 of file class.ilCalendarAppointmentGUI.php.

Referenced by delete(), and getAppointment().

$ctrl

ilCalendarAppointmentGUI::$ctrl

protected

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

$default_fulltime

ilCalendarAppointmentGUI::$default_fulltime = true

protected

Definition at line 16 of file class.ilCalendarAppointmentGUI.php.

$initialDate

ilCalendarAppointmentGUI::$initialDate = null

protected

Definition at line 15 of file class.ilCalendarAppointmentGUI.php.

Referenced by initAppointment(), and initInitialDate().

$lng

ilCalendarAppointmentGUI::$lng

protected

Definition at line 23 of file class.ilCalendarAppointmentGUI.php.

Referenced by createDefaultCalendar().

$logger

ilCalendarAppointmentGUI::$logger = null

private

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

$rec

ilCalendarAppointmentGUI::$rec = null

protected

Definition at line 19 of file class.ilCalendarAppointmentGUI.php.

Referenced by askEdit(), and initForm().

$request

ilCalendarAppointmentGUI::$request

protected

Definition at line 29 of file class.ilCalendarAppointmentGUI.php.

$seed

ilCalendarAppointmentGUI::$seed = null

protected

Definition at line 14 of file class.ilCalendarAppointmentGUI.php.

Referenced by initSeed().

$timezone

ilCalendarAppointmentGUI::$timezone = null

protected

Definition at line 20 of file class.ilCalendarAppointmentGUI.php.

Referenced by initInitialDate().

$tpl

ilCalendarAppointmentGUI::$tpl

protected

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

Referenced by addMilestone(), askDelete(), book(), cancelBooking(), confirmRegister(), confirmUnregister(), edit(), executeCommand(), initForm(), showInfoScreen(), and showResponsibleUsersList().

---

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

• Services/Calendar/classes/class.ilCalendarAppointmentGUI.php