ilBookingReservationsGUI Class Reference

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

Collaboration diagram for ilBookingReservationsGUI:

Public Member Functions
	__construct (ilObjBookingPool $pool, ilBookingHelpAdapter $help, int $context_obj_id=0)
	executeCommand ()
	log ()
	List reservations. More...
	logDetails ()
	changeStatusObject ()
	Change status of given reservations. More...
	applyLogFilter ()
	resetLogFilter ()
	rsvConfirmCancelUser ()
	(C1) Confirmation screen for canceling booking without schedule from booking objects screen or from participants screen, if only one object has been selected. More...
	rsvCancelUser ()
	(C1.a) Confirmed (C1) More...
	rsvConfirmCancel ()
	(C2) Confirmation screen for canceling booking from reservations screen (with and without schedule) More...
	rsvConfirmCancelAggregation (?array $a_ids=null)
	(C2.a) Cancel aggregated booking from reservations screen (with and without schedule) called in (C2) More...
	rsvConfirmCancelAggregationForm (array $a_ids)
	Form being used in (C2.a) More...
	rsvCancel ()
	(C2.b) Cancel reservations (coming from C2 or C2.a) More...
	rsvConfirmDelete ()
	rsvDelete ()
	displayPostInfo ()
	deliverPostFile ()
	redirectMailToBooker ()

Protected Member Functions
	getLogReservationIds ()
	Reservations IDs as currently provided from. More...
	setHelpId (string $a_id)
	getReservationsTable (?string $reservation_id=null)
	Get reservationsTable. More...
	back ()
	Back to reservation list. More...
	showRerunPreferenceAssignment ()
	confirmResetRun ()
	resetRun ()

Protected Attributes
ILIAS BookingManager BookingProcess ProcessUtilGUI	$util_gui
ILIAS BookingManager Access AccessManager	$access
ilToolbarGUI	$toolbar
ILIAS DI UIServices	$ui
ILIAS BookingManager InternalService	$service
array	$raw_post_data
ILIAS BookingManager StandardGUIRequest	$book_request
ilBookingHelpAdapter	$help
int	$context_obj_id
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ilObjUser	$user
ilObjBookingPool	$pool
int	$ref_id
int	$book_obj_id
int	$pbooked_user
string	$reservation_id
int	$booked_user

Detailed Description

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

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

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilBookingReservationsGUI::__construct	(	ilObjBookingPool	$pool,
		ilBookingHelpAdapter	$help,
		int	$context_obj_id = 0
	)

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

References $context_obj_id, $DIC, $help, $pool, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObject\getRefId(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilBookingObject\lookupPoolId(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->pool = $pool;
        $this->ctrl = $DIC->ctrl();
        $this->ref_id = $pool->getRefId();
        $this->lng = $DIC->language();
        $this->access = $DIC->bookingManager()->internal()->domain()->access();
        $this->tabs_gui = $DIC->tabs();
        $this->help = $help;
        $this->user = $DIC->user();
        $this->book_request = $DIC->bookingManager()
                                  ->internal()
                                  ->gui()
                                  ->standardRequest();
        $this->service = $DIC->bookingManager()->internal();
        $this->ui = $DIC->ui();
        $this->toolbar = $DIC->toolbar();

        $this->book_obj_id = $this->book_request->getObjectId();

        $this->context_obj_id = $context_obj_id;

        // user who's reservation is being tackled (e.g. canceled)
        $this->booked_user = $this->book_request->getBookedUser();
        if ($this->booked_user === 0) {
            $this->booked_user = $DIC->user()->getId();
        }
        // we get this from the reservation screen
        $this->reservation_id = $this->book_request->getReservationId();

        $this->ctrl->saveParameter($this, ["object_id", "bkusr"]);

        if ($this->book_request->getObjectId() > 0 && ilBookingObject::lookupPoolId($this->book_request->getObjectId()) !== $this->pool->getId()) {
            throw new ilException("Booking Object ID does not match Booking Pool.");
        }

        $this->raw_post_data = $DIC->http()->request()->getParsedBody();
        $this->util_gui = $DIC->bookingManager()->internal()->gui()->process()->ProcessUtilGUI(
            $this->pool,
            $this
        );
    }

Here is the call graph for this function:

Member Function Documentation

applyLogFilter()

ilBookingReservationsGUI::applyLogFilter

(

)

Definition at line 210 of file class.ilBookingReservationsGUI.php.

References getReservationsTable(), and log().

                                    : void
    {
        $table = $this->getReservationsTable();
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->log();
    }

Here is the call graph for this function:

back()

ilBookingReservationsGUI::back ( )

protected

Back to reservation list.

Definition at line 295 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\ctrl().

Referenced by redirectMailToBooker(), rsvCancelUser(), rsvConfirmCancel(), and rsvConfirmDelete().

                             : void
    {
        $this->ctrl->redirect($this, "log");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

changeStatusObject()

ilBookingReservationsGUI::changeStatusObject

(

)

Change status of given reservations.

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

References ILIAS\Repository\access(), ilBookingReservation\changeStatus(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and log().

                                        : void
    {
        $rsv_ids = $this->book_request->getReservationIds();
        if (count($rsv_ids) === 0) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->log();
        }

        if ($this->access->canManageAllReservations($this->ref_id)) {
            ilBookingReservation::changeStatus(
                $rsv_ids,
                $this->book_request->getStatus()
            );
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'log');
    }

Here is the call graph for this function:

confirmResetRun()

ilBookingReservationsGUI::confirmResetRun ( )

protected

Definition at line 648 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

    {
        if (!$this->access->canManageAllReservations($this->ref_id)) {
            return;
        }
        $this->tabs_gui->activateTab("log");
        $mess = $this->ui->factory()->messageBox()->confirmation($this->lng->txt("book_rerun_confirmation"))->withButtons(
            [
                $this->ui->factory()->button()->standard(
                    $this->lng->txt("book_rerun_assignments"),
                    $this->ctrl->getLinkTarget($this, "resetRun")
                ),
                $this->ui->factory()->button()->standard(
                    $this->lng->txt("cancel"),
                    $this->ctrl->getLinkTarget($this, "log")
                )
            ]
        );
        $this->tpl->setContent(
            $this->ui->renderer()->render($mess)
        );
    }

Here is the call graph for this function:

deliverPostFile()

ilBookingReservationsGUI::deliverPostFile

(

)

Definition at line 698 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\user().

                                     : void
    {
        $this->util_gui->deliverPostFile(
            $this->book_obj_id,
            $this->user->getId()
        );
    }

Here is the call graph for this function:

displayPostInfo()

ilBookingReservationsGUI::displayPostInfo

(

)

Definition at line 688 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
    {
        $this->ctrl->saveParameter($this, "object_id");
        $this->util_gui->displayPostInfo(
            $this->book_obj_id,
            0,
            "deliverPostFile"
        );
    }

Here is the call graph for this function:

executeCommand()

ilBookingReservationsGUI::executeCommand

(

)

Definition at line 110 of file class.ilBookingReservationsGUI.php.

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

                                    : void
    {
        $ctrl = $this->ctrl;

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("log");

        switch ($next_class) {
            default:
                if (in_array($cmd, array("log", "logDetails", "changeStatusObject", "rsvConfirmCancelUser", "rsvCancelUser",
                    "applyLogFilter", "resetLogFilter", "rsvConfirmCancel", "rsvCancel", "back", "rsvConfirmDelete", "rsvDelete", "confirmResetRun", "resetRun", "displayPostInfo", "deliverPostFile", "redirectMailToBooker"))) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

getLogReservationIds()

ilBookingReservationsGUI::getLogReservationIds ( )

protected

Reservations IDs as currently provided from.

Definition at line 98 of file class.ilBookingReservationsGUI.php.

Referenced by redirectMailToBooker(), rsvConfirmCancel(), and rsvConfirmDelete().

                                             : array
    {
        $mrsv = $this->book_request->getReservationIds();
        if (count($mrsv) > 0) {
            return $mrsv;
        }
        if ($this->reservation_id > 0) {
            return array($this->reservation_id);
        }
        return [];
    }

Here is the caller graph for this function:

getReservationsTable()

ilBookingReservationsGUI::getReservationsTable ( ?string  $reservation_id = null )

protected

Get reservationsTable.

Definition at line 145 of file class.ilBookingReservationsGUI.php.

References $book_obj_id, ILIAS\Repository\access(), and null.

Referenced by applyLogFilter(), log(), logDetails(), and resetLogFilter().

     : ilBookingReservationsTableGUI {
        $show_all = ($this->access->canManageAllReservations($this->ref_id) || $this->pool->hasPublicLog());

        $filter = null;
        if ($this->book_obj_id > 0) {
            $filter["object"] = $this->book_obj_id;
        }
        // coming from participants tab to cancel reservations.
        if ($this->book_request->getUserId() > 0) {
            $filter["user_id"] = $this->book_request->getUserId();
        }
        $context_filter = ($this->context_obj_id > 0)
            ? [$this->context_obj_id]
            : null;

        return new ilBookingReservationsTableGUI(
            $this,
            'log',
            $this->ref_id,
            $this->pool,
            $show_all,
            $filter,
            $reservation_id,
            $context_filter
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

log()

ilBookingReservationsGUI::log

(

)

List reservations.

Definition at line 134 of file class.ilBookingReservationsGUI.php.

References $tpl, getReservationsTable(), ILIAS\UICore\GlobalTemplate\setContent(), and showRerunPreferenceAssignment().

Referenced by applyLogFilter(), changeStatusObject(), resetLogFilter(), and rsvCancel().

                         : void
    {
        $tpl = $this->tpl;
        $this->showRerunPreferenceAssignment();
        $table = $this->getReservationsTable();
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logDetails()

ilBookingReservationsGUI::logDetails

(

)

Definition at line 174 of file class.ilBookingReservationsGUI.php.

References $tpl, ILIAS\Repository\ctrl(), getReservationsTable(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setContent().

                                : void
    {
        $tpl = $this->tpl;

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "log")
        );

        $table = $this->getReservationsTable($this->reservation_id);
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

redirectMailToBooker()

ilBookingReservationsGUI::redirectMailToBooker

(

)

Definition at line 706 of file class.ilBookingReservationsGUI.php.

References $id, $user_id, ilObjUser\_lookupLogin(), ILIAS\Repository\access(), back(), ILIAS\Repository\ctrl(), ilBookingReservation\getCancelDetails(), getLogReservationIds(), ilMailFormCall\getRedirectTarget(), ILIAS\Repository\lng(), ilUtil\redirect(), ilMailFormCall\setRecipients(), ilMailFormCall\SIGNATURE_KEY, and ilObjBookingPool\TYPE_FIX_SCHEDULE.

                                          : void
    {
        if (!$this->access->canManageAllReservations($this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this, 'log');
        }

        $ids = $this->getLogReservationIds();
        if (count($ids) === 0) {
            $this->back();
        }

        $users = [];
        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_FIX_SCHEDULE) {
            foreach ($ids as $idx => $id) {
                [$obj_id, $user_id, $from, $to] = explode("_", $id);
                $rsv_ids = ilBookingReservation::getCancelDetails($obj_id, $user_id, $from, $to);
                $rsv_id = $rsv_ids[0];
                $rsv = new ilBookingReservation($rsv_id);
                $users[$rsv->getUserId()] = ilObjUser::_lookupLogin($rsv->getUserId());
            }
        } else {
            foreach ($ids as $idx => $rsv_id) {
                $rsv = new ilBookingReservation($rsv_id);
                $users[$rsv->getUserId()] = ilObjUser::_lookupLogin($rsv->getUserId());
            }
        }
        $logins = implode(",", $users);
        // #16530 - see ilObjCourseGUI::createMailSignature
        $sig = chr(13) . chr(10) . chr(13) . chr(10) . chr(13) . chr(10);
        $sig .= $this->lng->txt('book_mail_permanent_link') . ": ";
        $sig .= chr(13) . chr(10);
        $sig .= ilLink::_getLink($this->book_request->getRefId());
        $sig = rawurlencode(base64_encode($sig));

        ilMailFormCall::setRecipients($users);
        \ilUtil::redirect(ilMailFormCall::getRedirectTarget(
            $this,
            "log",
            array(),
            array(
                'type' => 'new',
                'rcp_to' => $logins,
                ilMailFormCall::SIGNATURE_KEY => $sig
            )
        ));
    }

Here is the call graph for this function:

resetLogFilter()

ilBookingReservationsGUI::resetLogFilter

(

)

Definition at line 218 of file class.ilBookingReservationsGUI.php.

References getReservationsTable(), and log().

                                    : void
    {
        $table = $this->getReservationsTable();
        $table->resetOffset();
        $table->resetFilter();
        $this->log();
    }

Here is the call graph for this function:

resetRun()

ilBookingReservationsGUI::resetRun ( )

protected

Definition at line 671 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ilObjBookingPool\TYPE_NO_SCHEDULE_PREFERENCES.

    {
        if (!$this->access->canManageAllReservations($this->ref_id)) {
            return;
        }
        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_NO_SCHEDULE_PREFERENCES
            && $this->access->canManageAllReservations($this->pool->getRefId())) {
            $pref_manager = $this->service->domain()->preferences($this->pool);
            $repo = $this->service->repo()->preferences();
            $pref_manager->resetRun();
            $pref_manager->storeBookings(
                $repo->getPreferences($this->pool->getId())
            );
        }
        $this->ctrl->redirect($this, "log");
    }

Here is the call graph for this function:

rsvCancel()

ilBookingReservationsGUI::rsvCancel

(

)

(C2.b) Cancel reservations (coming from C2 or C2.a)

Definition at line 477 of file class.ilBookingReservationsGUI.php.

References $ctrl, $id, $lng, $res, $tpl, $user, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), log(), null, rsvConfirmCancelAggregationForm(), ILIAS\UICore\GlobalTemplate\setContent(), ilBookingReservation\STATUS_CANCELLED, ilLanguage\txt(), and ilObjBookingPool\TYPE_NO_SCHEDULE.

                               : void
    {
        $ilUser = $this->user;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        // simple version of reservation id
        $ids = $this->book_request->getReservationIds();

        $rsv_aggr = $this->raw_post_data["rsv_aggr"] ?? null;
        // aggregated version: determine reservation ids
        if (!is_null($rsv_aggr)) {
            $form = $this->rsvConfirmCancelAggregationForm($rsv_aggr);
            if (!$form->checkInput()) {
                $this->tabs_gui->clearTargets();
                $this->tabs_gui->setBackTarget(
                    $lng->txt("back"),
                    $ilCtrl->getLinkTarget($this, "log")
                );

                $tpl->setContent($form->getHTML());
                return;
            }

            $ids = array();
            foreach ($rsv_aggr as $idx => $aggr_ids) {
                $max = $this->book_request->getCancelNr($idx);
                if ($max) {
                    if (!is_array($aggr_ids)) {
                        $ids[] = $aggr_ids;
                    } else {
                        $aggr_ids = array_slice($aggr_ids, 0, $max);
                        $ids = array_merge($ids, $aggr_ids);
                    }
                }
            }
        }

        // for all reservation ids -> set reservation status to cancelled (and remove calendar entry)
        if ($ids) {
            foreach ($ids as $id) {
                $res = new ilBookingReservation($id);

                // either write permission or own booking
                if (!$this->access->canManageReservationForUser($this->ref_id, $res->getUserId())) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                    $this->ctrl->redirect($this, 'log');
                }

                $res->setStatus(ilBookingReservation::STATUS_CANCELLED);
                $res->update();

                if ($this->pool->getScheduleType() !== ilObjBookingPool::TYPE_NO_SCHEDULE) {
                    // remove user calendar entry (#11086)
                    $cal_entry_id = $res->getCalendarEntry();
                    if ($cal_entry_id) {
                        $entry = new ilCalendarEntry($cal_entry_id);
                        $entry->delete();
                    }
                }
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->log();
    }

Here is the call graph for this function:

rsvCancelUser()

ilBookingReservationsGUI::rsvCancelUser

(

)

(C1.a) Confirmed (C1)

Definition at line 266 of file class.ilBookingReservationsGUI.php.

References $book_obj_id, $booked_user, $id, $lng, $user_id, back(), ilBookingReservation\getObjectReservationForUser(), ilBookingReservation\STATUS_CANCELLED, and ilLanguage\txt().

                                   : void
    {
        $lng = $this->lng;

        $id = $this->book_obj_id;
        $user_id = $this->booked_user;

        if (!$id || !$user_id) {
            return;
        }

        $ids = ilBookingReservation::getObjectReservationForUser($id, $user_id);
        $id = current($ids);
        $obj = new ilBookingReservation($id);
        if ($obj->getUserId() !== $user_id) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt('permission_denied'), true);
            $this->back();
        }

        $obj->setStatus(ilBookingReservation::STATUS_CANCELLED);
        $obj->update();

        $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        $this->back();
    }

Here is the call graph for this function:

rsvConfirmCancel()

ilBookingReservationsGUI::rsvConfirmCancel

(

)

(C2) Confirmation screen for canceling booking from reservations screen (with and without schedule)

Definition at line 303 of file class.ilBookingReservationsGUI.php.

References $ctrl, $id, $lng, $tpl, $user, $user_id, ILIAS\Repository\access(), back(), ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), ilBookingReservation\getCancelDetails(), ilBookingObject\getList(), getLogReservationIds(), ilBookingObject\getTitle(), IL_CAL_UNIX, ILIAS\Repository\int(), rsvConfirmCancelAggregation(), ILIAS\UICore\GlobalTemplate\setContent(), setHelpId(), ilLanguage\txt(), and ilObjBookingPool\TYPE_NO_SCHEDULE.

                                      : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilUser = $this->user;

        $ids = $this->getLogReservationIds();
        if (count($ids) === 0) {
            $this->back();
        }
        $max = array();
        foreach ($ids as $idx => $id) {
            if (!is_numeric($id)) {
                [$obj_id, $user_id, $from, $to] = explode("_", $id);

                $valid_ids = array();
                foreach (ilBookingObject::getList($this->pool->getId()) as $item) {
                    $valid_ids[$item["booking_object_id"]] = $item["title"];
                }
                if (array_key_exists($obj_id, $valid_ids) && $from > time() && ($this->access->canManageAllReservations($this->ref_id) || (int) $user_id === $ilUser->getId())) {
                    $rsv_ids = ilBookingReservation::getCancelDetails($obj_id, $user_id, $from, $to);
                    if (!count($rsv_ids)) {
                        unset($ids[$idx]);
                    }
                    if (count($rsv_ids) > 1) {
                        $max[$id] = count($rsv_ids);
                        $ids[$idx] = $rsv_ids;
                    } else {
                        // only 1 in group?  treat as normal reservation
                        $ids[$idx] = array_shift($rsv_ids);
                    }
                } else {
                    unset($ids[$idx]);
                }
            }
        }

        if (!is_array($ids) || !count($ids)) {
            $this->ctrl->redirect($this, 'log');
        }

        // show form instead
        if (count($max) && max($max) > 1) {
            $this->rsvConfirmCancelAggregation($ids);
            return;
        }

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTargetByClass("ilBookingReservationsGUI", "")
        );

        $this->setHelpId("cancel_booking");

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($ilCtrl->getFormAction($this, 'rsvCancel'));
        $conf->setHeaderText($lng->txt('book_confirm_cancel'));
        $conf->setConfirm($lng->txt('book_set_cancel'), 'rsvCancel');
        $conf->setCancel($lng->txt('cancel'), 'back');

        foreach ($ids as $id) {
            $rsv = new ilBookingReservation($id);
            $obj = new ilBookingObject($rsv->getObjectId());

            $details = $obj->getTitle();
            if ($this->pool->getScheduleType() !== ilObjBookingPool::TYPE_NO_SCHEDULE) {
                $details .= ", " . ilDatePresentation::formatPeriod(
                    new ilDateTime($rsv->getFrom(), IL_CAL_UNIX),
                    new ilDateTime($rsv->getTo() + 1, IL_CAL_UNIX)
                );
            }

            $conf->addItem('rsv_id[]', $id, $details);
        }

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

Here is the call graph for this function:

rsvConfirmCancelAggregation()

ilBookingReservationsGUI::rsvConfirmCancelAggregation

(

?array

$a_ids = null

)

(C2.a) Cancel aggregated booking from reservations screen (with and without schedule) called in (C2)

Definition at line 388 of file class.ilBookingReservationsGUI.php.

References $ctrl, $lng, $tpl, rsvConfirmCancelAggregationForm(), ILIAS\UICore\GlobalTemplate\setContent(), setHelpId(), and ilLanguage\txt().

Referenced by rsvConfirmCancel().

                                                                     : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "log")
        );

        $this->setHelpId("cancel_booking");

        // #13511
        $this->tpl->setOnScreenMessage('question', $lng->txt("book_confirm_cancel"));

        $form = $this->rsvConfirmCancelAggregationForm($a_ids);

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

Here is the call graph for this function:

Here is the caller graph for this function:

rsvConfirmCancelAggregationForm()

ilBookingReservationsGUI::rsvConfirmCancelAggregationForm

(

array

$a_ids

)

Form being used in (C2.a)

Definition at line 413 of file class.ilBookingReservationsGUI.php.

References $id, ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), ilBookingObject\getTitle(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilDatePresentation\setUseRelativeDates().

Referenced by rsvCancel(), and rsvConfirmCancelAggregation().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "rsvCancel"));
        $form->setTitle($this->lng->txt("book_confirm_cancel_aggregation"));

        ilDatePresentation::setUseRelativeDates(false);

        foreach ($a_ids as $idx => $ids) {
            $first = $ids;
            if (is_array($ids)) {
                $first = array_shift($first);
            }

            $rsv = new ilBookingReservation($first);
            $obj = new ilBookingObject($rsv->getObjectId());

            $caption = $obj->getTitle() . ", " . ilDatePresentation::formatPeriod(
                new ilDateTime($rsv->getFrom(), IL_CAL_UNIX),
                new ilDateTime($rsv->getTo() + 1, IL_CAL_UNIX)
            );

            // #17869
            if (is_array($ids)) {
                $caption .= " (" . count($ids) . ")";
            }

            $item = new ilNumberInputGUI($caption, "rsv_id_" . $idx);
            $item->setRequired(true);
            $item->setMinValue(0);
            $item->setSize(4);
            $form->addItem($item);

            if (is_array($ids)) {
                $item->setMaxValue(count($ids));

                foreach ($ids as $id) {
                    $hidden = new ilHiddenInputGUI("rsv_aggr[" . $idx . "][]");
                    $hidden->setValue($id);
                    $form->addItem($hidden);
                }
            } else {
                $item->setMaxValue(1);

                $hidden = new ilHiddenInputGUI("rsv_aggr[" . $idx . "]");
                $hidden->setValue($ids);
                $form->addItem($hidden);
            }

            if ($this->book_request->getCancelNr($idx)) {
                $item->setValue($this->book_request->getCancelNr($idx));
            }
        }

        $form->addCommandButton("rsvCancel", $this->lng->txt("confirm"));
        $form->addCommandButton("log", $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rsvConfirmCancelUser()

ilBookingReservationsGUI::rsvConfirmCancelUser

(

)

(C1) Confirmation screen for canceling booking without schedule from booking objects screen or from participants screen, if only one object has been selected.

If the process is started form the booking objects screen, the current user is the owner of the reservation.

From the participants screen the user id is provided as bkusr

Definition at line 239 of file class.ilBookingReservationsGUI.php.

References $book_obj_id, $ctrl, $id, $lng, $tpl, ILIAS\UICore\GlobalTemplate\setContent(), setHelpId(), and ilLanguage\txt().

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $id = $this->book_obj_id;
        if (!$id) {
            return;
        }

        $this->setHelpId("cancel_booking");

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($ilCtrl->getFormAction($this));
        $conf->setHeaderText($lng->txt('book_confirm_cancel'));

        $type = new ilBookingObject($id);
        $conf->addItem('object_id', $id, $type->getTitle());
        $conf->setConfirm($lng->txt('book_set_cancel'), 'rsvCancelUser');
        $conf->setCancel($lng->txt('cancel'), 'back');

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

Here is the call graph for this function:

rsvConfirmDelete()

ilBookingReservationsGUI::rsvConfirmDelete

(

)

Definition at line 545 of file class.ilBookingReservationsGUI.php.

References $DIC, $id, $user_id, ILIAS\Repository\access(), back(), ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), ilBookingReservation\getCancelDetails(), getLogReservationIds(), ilBookingObject\getTitle(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilObjBookingPool\TYPE_FIX_SCHEDULE.

                                      : void
    {
        global $DIC;
        if (!$this->access->canManageAllReservations($this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this, 'log');
        }

        $ids = $this->getLogReservationIds();
        if (count($ids) === 0) {
            $this->back();
        }

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "log")
        );

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this, 'rsvDelete'));
        $conf->setHeaderText($this->lng->txt('book_confirm_delete'));
        $conf->setConfirm($this->lng->txt('book_set_delete'), 'rsvDelete');
        $conf->setCancel($this->lng->txt('cancel'), 'log');

        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_FIX_SCHEDULE) {
            foreach ($ids as $idx => $id) {
                [$obj_id, $user_id, $from, $to] = explode("_", $id);
                $rsv_ids = ilBookingReservation::getCancelDetails($obj_id, $user_id, $from, $to);
                $rsv_id = $rsv_ids[0];

                $rsv = new ilBookingReservation($rsv_id);
                $obj = new ilBookingObject($rsv->getObjectId());

                $details = sprintf($this->lng->txt('X_reservations_of'), count($rsv_ids)) . ' ' . $obj->getTitle();
                $details .= ", " . ilDatePresentation::formatPeriod(
                    new ilDateTime($rsv->getFrom(), IL_CAL_UNIX),
                    new ilDateTime($rsv->getTo() + 1, IL_CAL_UNIX)
                );
                $conf->addItem('mrsv[]', $id, $details);
            }
        } else {
            foreach ($ids as $idx => $rsv_id) {
                $rsv = new ilBookingReservation($rsv_id);
                $obj = new ilBookingObject($rsv->getObjectId());
                $details = sprintf($this->lng->txt('X_reservations_of'), 1) . ' ' . $obj->getTitle();
                $conf->addItem('mrsv[]', $rsv_id, $details);
            }
        }
        $this->tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

rsvDelete()

ilBookingReservationsGUI::rsvDelete

(

)

Definition at line 597 of file class.ilBookingReservationsGUI.php.

References $DIC, $id, $res, $user_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilBookingReservation\getCancelDetails(), ILIAS\Repository\lng(), ilObjBookingPool\TYPE_FIX_SCHEDULE, and ilObjBookingPool\TYPE_NO_SCHEDULE.

                               : void
    {
        global $DIC;
        $get = $DIC->http()->request()->getParsedBody()['mrsv'];
        if ($get) {
            foreach ($get as $id) {
                if ($this->pool->getScheduleType() == ilObjBookingPool::TYPE_FIX_SCHEDULE) {
                    list($obj_id, $user_id, $from, $to) = explode("_", $id);
                    $rsv_ids = ilBookingReservation::getCancelDetails($obj_id, $user_id, $from, $to);
                } else {
                    $rsv_ids = [$id];
                }

                foreach ($rsv_ids as $rsv_id) {
                    $res = new ilBookingReservation($rsv_id);
                    $obj = new ilBookingObject($res->getObjectId());
                    if (!$this->access->canManageAllReservations($this->ref_id) || $obj->getPoolId() !== $this->pool->getId()) {
                        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                        $this->ctrl->redirect($this, 'log');
                    }
                    if ($this->pool->getScheduleType() !== ilObjBookingPool::TYPE_NO_SCHEDULE) {
                        $cal_entry_id = $res->getCalendarEntry();
                        if ($cal_entry_id) {
                            $entry = new ilCalendarEntry($cal_entry_id);
                            $entry->delete();
                        }
                    }
                    $res->delete();
                }
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('reservation_deleted'), true);
        $this->ctrl->redirect($this, 'log');
    }

Here is the call graph for this function:

setHelpId()

ilBookingReservationsGUI::setHelpId ( string  $a_id )

protected

Definition at line 126 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\help().

Referenced by rsvConfirmCancel(), rsvConfirmCancelAggregation(), and rsvConfirmCancelUser().

                                              : void
    {
        $this->help->setHelpId($a_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showRerunPreferenceAssignment()

ilBookingReservationsGUI::showRerunPreferenceAssignment ( )

protected

Definition at line 632 of file class.ilBookingReservationsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), ilObjBookingPool\TYPE_NO_SCHEDULE_PREFERENCES, and ILIAS\Repository\ui().

Referenced by log().

                                                      : void
    {
        if (!$this->access->canManageAllReservations($this->ref_id)) {
            return;
        }
        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_NO_SCHEDULE_PREFERENCES) {
            $pref_manager = $this->service->domain()->preferences($this->pool);
            if ($pref_manager->hasRun()) {
                $this->toolbar->addComponent($this->ui->factory()->button()->standard(
                    $this->lng->txt("book_rerun_assignments"),
                    $this->ctrl->getLinkTarget($this, "confirmResetRun")
                ));
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ILIAS BookingManager Access AccessManager ilBookingReservationsGUI::$access

protected

Definition at line 26 of file class.ilBookingReservationsGUI.php.

$book_obj_id

int ilBookingReservationsGUI::$book_obj_id

protected

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

Referenced by getReservationsTable(), rsvCancelUser(), and rsvConfirmCancelUser().

$book_request

ILIAS BookingManager StandardGUIRequest ilBookingReservationsGUI::$book_request

protected

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

$booked_user

int ilBookingReservationsGUI::$booked_user

protected

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

Referenced by rsvCancelUser().

$context_obj_id

int ilBookingReservationsGUI::$context_obj_id

protected

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

Referenced by __construct().

$ctrl

ilCtrl ilBookingReservationsGUI::$ctrl

protected

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

Referenced by executeCommand(), rsvCancel(), rsvConfirmCancel(), rsvConfirmCancelAggregation(), and rsvConfirmCancelUser().

$help

ilBookingHelpAdapter ilBookingReservationsGUI::$help

protected

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

Referenced by __construct().

$lng

ilLanguage ilBookingReservationsGUI::$lng

protected

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

Referenced by rsvCancel(), rsvCancelUser(), rsvConfirmCancel(), rsvConfirmCancelAggregation(), and rsvConfirmCancelUser().

$pbooked_user

int ilBookingReservationsGUI::$pbooked_user

protected

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

$pool

ilObjBookingPool ilBookingReservationsGUI::$pool

protected

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

Referenced by __construct().

$raw_post_data

array ilBookingReservationsGUI::$raw_post_data

protected

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

$ref_id

int ilBookingReservationsGUI::$ref_id

protected

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

$reservation_id

string ilBookingReservationsGUI::$reservation_id

protected

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

$service

ILIAS BookingManager InternalService ilBookingReservationsGUI::$service

protected

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

$tabs_gui

ilTabsGUI ilBookingReservationsGUI::$tabs_gui

protected

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

$toolbar

ilToolbarGUI ilBookingReservationsGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilBookingReservationsGUI::$tpl

protected

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

Referenced by log(), logDetails(), rsvCancel(), rsvConfirmCancel(), rsvConfirmCancelAggregation(), and rsvConfirmCancelUser().

$ui

ILIAS DI UIServices ilBookingReservationsGUI::$ui

protected

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

$user

ilObjUser ilBookingReservationsGUI::$user

protected

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

Referenced by rsvCancel(), and rsvConfirmCancel().

$util_gui

ILIAS BookingManager BookingProcess ProcessUtilGUI ilBookingReservationsGUI::$util_gui

protected

Definition at line 25 of file class.ilBookingReservationsGUI.php.

---

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

• components/ILIAS/BookingManager/Reservations/class.ilBookingReservationsGUI.php