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

Public Member Functions
	executeCommand ()
	book ()
	First step in booking process. More...
	assignParticipants ()
	bookMultipleParticipants ()
	Create reservations for a bunch of booking pool participants. More...
	redirectToList ()
	saveMultipleBookings ()
	Save multiple users reservations for one booking pool object. More...
	confirmedBooking ()
	processBooking (int $a_object_id, int $a_from=null, int $a_to=null, int $a_group_id=null)
	Book object for date. More...
	confirmBookingNumbers (array $a_objects_counter, int $a_group_id, ilPropertyFormGUI $a_form=null)
	confirmedBookingNumbers ()
	displayPostInfo ()
	Display post booking informations. More...
	deliverPostFile ()
	Deliver post booking file. More...

Protected Member Functions
	back ()
	setHelpId (string $a_id)
	checkPermissionBool (string $a_perm)
	checkPermission (string $a_perm)
	saveParticipant ()
	save booking participant More...
	initBookingNumbersForm (array $a_objects_counter, int $a_group_id, bool $a_reload=false, ?array $new_values=null)
	addDaysDate (string $a_date, int $a_days)
	addDaysStamp (int $a_stamp, int $a_days)
	handleBookingSuccess (int $a_obj_id, array $a_rsv_ids=null)

Protected Attributes
array	$raw_post_data
ILIAS BookingManager StandardGUIRequest	$book_request
ilObjBookingPool	$pool
int	$booking_object_id
int	$user_id_to_book
int	$user_id_assigner
string	$seed
string	$sseed
ilBookingHelpAdapter	$help
int	$context_obj_id
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilAccessHandler	$access
ilTabsGUI	$tabs_gui
ilObjUser	$user
int	$book_obj_id
array	$rsv_ids = []

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 Booking process ui class

Author

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

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

Member Function Documentation

addDaysDate()

ilBookingProcessGUI::addDaysDate ( string  $a_date, int  $a_days  )

protected

Definition at line 961 of file class.ilBookingProcessGUI.php.

Referenced by confirmedBookingNumbers().

     : string {
        $date = date_parse($a_date);
        $stamp = mktime(0, 0, 1, $date["month"], $date["day"] + $a_days, $date["year"]);
        return date("Y-m-d", $stamp);
    }

Here is the caller graph for this function:

addDaysStamp()

ilBookingProcessGUI::addDaysStamp ( int  $a_stamp, int  $a_days  )

protected

Definition at line 970 of file class.ilBookingProcessGUI.php.

Referenced by confirmedBookingNumbers().

     : int {
        $date = getdate($a_stamp);
        return mktime(
            $date["hours"],
            $date["minutes"],
            $date["seconds"],
            $date["mon"],
            $date["mday"] + $a_days,
            $date["year"]
        );
    }

Here is the caller graph for this function:

assignParticipants()

ilBookingProcessGUI::assignParticipants

(

)

Definition at line 487 of file class.ilBookingProcessGUI.php.

References $book_obj_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                        : void
    {
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget($this->lng->txt('book_back_to_list'), $this->ctrl->getLinkTarget($this, 'back'));

        $table = new ilBookingAssignParticipantsTableGUI($this, 'assignParticipants', $this->pool->getRefId(), $this->pool->getId(), $this->book_obj_id);

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

Here is the call graph for this function:

back()

ilBookingProcessGUI::back ( )

protected

Definition at line 113 of file class.ilBookingProcessGUI.php.

References ILIAS\Repository\ctrl().

Referenced by bookMultipleParticipants(), checkPermission(), confirmedBookingNumbers(), handleBookingSuccess(), and saveMultipleBookings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

book()

ilBookingProcessGUI::book

(

)

First step in booking process.

Definition at line 149 of file class.ilBookingProcessGUI.php.

References $i, $id, $ilUser, $tpl, $user, ilCalendarUtil\_buildWeekDayList(), ilCalendarAppointmentColors\_getColorsByType(), ilCalendarUserSettings\_getInstanceByUserId(), ilCalendarUtil\_numericDayToString(), ilCalendarUtil\_numericMonthToString(), ilCalendarUtil\calculateFontColor(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilBookingSchedule\getAvailabilityFrom(), ilBookingSchedule\getAvailabilityTo(), ilBookingReservation\getAvailableObject(), ilBookingSchedule\getDeadline(), ilBookingSchedule\getDefinition(), ilBookingSchedule\getRaster(), IL_CAL_DATE, IL_CAL_FKT_GETDATE, IL_CAL_UNIX, ILIAS\Repository\int(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), setHelpId(), ilCalendarSettings\TIME_FORMAT_12, ilCalendarSettings\TIME_FORMAT_24, ilObjBookingPool\TYPE_FIX_SCHEDULE, ilDateTime\WEEK, and ilDateTime\YEAR.

Referenced by confirmedBooking().

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

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

        $this->setHelpId("book");

        $obj = new ilBookingObject($this->book_obj_id);

        $this->lng->loadLanguageModule("dateplaner");
        $this->ctrl->setParameter($this, 'object_id', $obj->getId());

        if ($this->user_id_to_book !== $this->user_id_assigner) {
            $this->ctrl->setParameter($this, 'bkusr', $this->user_id_to_book);
        }

        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_FIX_SCHEDULE) {
            $schedule = new ilBookingSchedule($obj->getScheduleId());

            $tpl->setContent($this->renderSlots($schedule, array($obj->getId()), $obj->getTitle()));
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setHeaderText($this->lng->txt("book_confirm_booking_no_schedule"));

            $cgui->setFormAction($this->ctrl->getFormAction($this));
            $cgui->setCancel($this->lng->txt("cancel"), "back");
            $cgui->setConfirm($this->lng->txt("confirm"), "confirmedBooking");

            $cgui->addItem("object_id", $obj->getId(), $obj->getTitle());

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

Here is the call graph for this function:

Here is the caller graph for this function:

bookMultipleParticipants()

ilBookingProcessGUI::bookMultipleParticipants

(

)

Create reservations for a bunch of booking pool participants.

Definition at line 500 of file class.ilBookingProcessGUI.php.

References $id, $name, ilObjUser\_lookupFullname(), back(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilBookingReservation\numAvailableFromObjectNoSchedule().

                                              : void
    {
        $participants = $this->book_request->getParticipants();
        if (count($participants) === 0) {
            $this->back();
            return;
        }

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

        $conf = new ilConfirmationGUI();
        $conf->setFormAction($this->ctrl->getFormAction($this));

        //add user list as items.
        foreach ($participants as $id) {
            $name = ilObjUser::_lookupFullname($id);
            $conf->addItem("participants[]", $id, $name);
        }

        $available = ilBookingReservation::numAvailableFromObjectNoSchedule($this->book_obj_id);
        if (count($participants) > $available) {
            $obj = new ilBookingObject($this->book_obj_id);
            $conf->setHeaderText(
                sprintf(
                    $this->lng->txt('book_limit_objects_available'),
                    count($participants),
                    $obj->getTitle(),
                    $available
                )
            );
        } else {
            $conf->setHeaderText($this->lng->txt('book_confirm_booking_no_schedule'));
            $conf->addHiddenItem("object_id", $this->book_obj_id);
            $conf->setConfirm($this->lng->txt("assign"), "saveMultipleBookings");
        }

        $conf->setCancel($this->lng->txt("cancel"), 'redirectToList');
        $this->tpl->setContent($conf->getHTML());
    }

Here is the call graph for this function:

checkPermission()

ilBookingProcessGUI::checkPermission ( string  $a_perm )

protected

Definition at line 133 of file class.ilBookingProcessGUI.php.

References back(), checkPermissionBool(), and ILIAS\Repository\lng().

Referenced by processBooking().

                                                      : void
    {
        if (!$this->checkPermissionBool($a_perm)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_permission"), true);
            $this->back();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermissionBool()

ilBookingProcessGUI::checkPermissionBool ( string  $a_perm )

protected

Definition at line 123 of file class.ilBookingProcessGUI.php.

References $access.

Referenced by checkPermission().

                                                          : bool
    {
        $ilAccess = $this->access;

        if (!$ilAccess->checkAccess($a_perm, "", $this->pool->getRefId())) {
            return false;
        }
        return true;
    }

Here is the caller graph for this function:

confirmBookingNumbers()

ilBookingProcessGUI::confirmBookingNumbers	(	array	$a_objects_counter,
		int	$a_group_id,
		ilPropertyFormGUI	$a_form = null
	)

Definition at line 708 of file class.ilBookingProcessGUI.php.

References $tpl, ILIAS\Repository\ctrl(), initBookingNumbersForm(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

Referenced by confirmedBooking(), and confirmedBookingNumbers().

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

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

        if (!$a_form) {
            $a_form = $this->initBookingNumbersForm($a_objects_counter, $a_group_id);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

confirmedBooking()

ilBookingProcessGUI::confirmedBooking

(

)

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

References $book_obj_id, Vendor\Package\$f, book(), confirmBookingNumbers(), ILIAS\Repository\ctrl(), ilBookingReservation\getAvailableObject(), ilBookingObject\getNrOfItemsForObjects(), ilBookingReservation\getObjectReservationForUser(), handleBookingSuccess(), ILIAS\Repository\int(), ilBookingReservation\isObjectAvailableNoSchedule(), ILIAS\Repository\lng(), processBooking(), saveParticipant(), and ilObjBookingPool\TYPE_FIX_SCHEDULE.

                                      : bool
    {
        $success = false;
        $rsv_ids = array();

        if ($this->pool->getScheduleType() !== ilObjBookingPool::TYPE_FIX_SCHEDULE) {
            if ($this->book_obj_id > 0) {
                $object_id = $this->book_obj_id;
                if ($object_id) {
                    if (ilBookingReservation::isObjectAvailableNoSchedule($object_id) &&
                        count(ilBookingReservation::getObjectReservationForUser($object_id, $this->user_id_to_book)) === 0) { // #18304
                        $rsv_ids[] = $this->processBooking($object_id);
                        $success = $object_id;
                    } else {
                        // #11852
                        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed_overbooked'), true);
                        $this->ctrl->redirect($this, 'back');
                    }
                }
            }
        } else {
            $dates = $this->book_request->getDates();
            if (count($dates) === 0) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
                $this->book();
                return false;
            }

            // single object reservation(s)
            if ($this->book_obj_id > 0) {
                $confirm = array();

                $object_id = $this->book_obj_id;
                $group_id = null;
                if ($object_id) {
                    $nr = ilBookingObject::getNrOfItemsForObjects(array($object_id));
                    // needed for recurrence
                    $f = new ilBookingReservationDBRepositoryFactory();
                    $repo = $f->getRepo();
                    $group_id = $repo->getNewGroupId();
                    foreach ($dates as $date) {
                        $fromto = explode('_', $date);
                        $from = (int) $fromto[0];
                        $to = (int) $fromto[1] - 1;

                        $counter = ilBookingReservation::getAvailableObject(array($object_id), $from, $to, false, true);
                        $counter = $counter[$object_id];
                        if ($counter) {
                            // needed for recurrence
                            $confirm[$object_id . "_" . $from . "_" . ($to + 1)] = $counter;
                        }
                    }
                }

                if (count($confirm)) {
                    $this->confirmBookingNumbers($confirm, $group_id);
                    return false;
                }
            }
        }

        if ($success) {
            $this->saveParticipant();
            $this->handleBookingSuccess($success, $rsv_ids);
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed'), true);
            $this->ctrl->redirect($this, 'book');
        }
        return true;
    }

Here is the call graph for this function:

confirmedBookingNumbers()

ilBookingProcessGUI::confirmedBookingNumbers

(

)

Definition at line 828 of file class.ilBookingProcessGUI.php.

References $id, $parts, addDaysDate(), addDaysStamp(), back(), confirmBookingNumbers(), ilBookingReservation\getAvailableObject(), handleBookingSuccess(), IL_CAL_DATE, initBookingNumbersForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilCalendarUtil\parseIncomingDate(), processBooking(), and saveParticipant().

                                             : void
    {

        //get the user who will get the booking.
        if ($this->book_request->getBookedUser() > 0) {
            $this->user_id_to_book = $this->book_request->getBookedUser();
        }

        // convert post data to initial form config
        $counter = array();
        $current_first = $obj_id = null;
        foreach (array_keys($this->raw_post_data) as $id) {
            if (str_starts_with($id, "conf_nr__")) {
                $id = explode("_", substr($id, 9));
                $counter[$id[0] . "_" . $id[1] . "_" . $id[2]] = (int) $id[3];
                if (!$current_first) {
                    $current_first = date("Y-m-d", $id[1]);
                }
            }
        }

        // recurrence

        // checkInput() has not been called yet, so we have to improvise
        $rece = $this->book_request->getRece();
        $recm = $this->book_request->getRecm();
        $end = ilCalendarUtil::parseIncomingDate($rece, false);

        $new_values = [];

        if ((int) $recm > 0 && $end && $current_first) {
            ksort($counter);
            $end = $end->get(IL_CAL_DATE);
            $cycle = (int) $recm * 7;
            $cut = 0;
            $org = $counter;
            while ($cut < 1000 && $this->addDaysDate($current_first, $cycle) <= $end) {
                $cut++;
                $current_first = null;
                foreach ($org as $item_id => $max) {
                    $parts = explode("_", $item_id);
                    $obj_id = $parts[0];

                    $from = $this->addDaysStamp($parts[1], $cycle * $cut);
                    $to = $this->addDaysStamp($parts[2], $cycle * $cut);

                    $new_item_id = $obj_id . "_" . $from . "_" . $to;

                    // form reload because of validation errors
                    if (!isset($counter[$new_item_id]) && date("Y-m-d", $to) <= $end) {
                        // get max available for added dates
                        $new_max = ilBookingReservation::getAvailableObject(array($obj_id), $from, $to - 1, false, true);
                        $new_max = (int) $new_max[$obj_id];

                        $counter[$new_item_id] = $new_max;

                        if (!$current_first) {
                            $current_first = date("Y-m-d", $from);
                        }

                        // clone input
                        $new_values["conf_nr__" . $new_item_id . "_" . $new_max] =
                            $_POST["conf_nr__" . $item_id . "_" . $max];
                    }
                }
            }
        }

        $group_id = $this->book_request->getGroupId();

        $form = $this->initBookingNumbersForm($counter, $group_id, true, $new_values);
        if ($form->checkInput()) {
            $success = false;
            $rsv_ids = array();
            foreach ($counter as $id => $all_nr) {
                $book_nr = $form->getInput("conf_nr__" . $id . "_" . $all_nr);
                $parts = explode("_", $id);
                $obj_id = $parts[0];
                $from = $parts[1];
                $to = $parts[2] - 1;

                // get currently available slots
                $counter = ilBookingReservation::getAvailableObject(array($obj_id), $from, $to, false, true);
                $counter = $counter[$obj_id];
                if ($counter) {
                    // we can only book what is left
                    $book_nr = min($book_nr, $counter);
                    for ($loop = 0; $loop < $book_nr; $loop++) {
                        $rsv_ids[] = $this->processBooking($obj_id, $from, $to, $group_id);
                        $success = $obj_id;
                    }
                }
            }
            if ($success) {
                $this->saveParticipant();
                $this->handleBookingSuccess($success, $rsv_ids);
            } else {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed'), true);
                $this->back();
            }
        } else {
            // ilDateTimeInputGUI does NOT add hidden values on disabled!

            $rece_array = explode(".", $rece);

            $rece_day = str_pad($rece_array[0], 2, "0", STR_PAD_LEFT);
            $rece_month = str_pad($rece_array[1], 2, "0", STR_PAD_LEFT);
            $rece_year = $rece_array[2];

            // ilDateTimeInputGUI will choke on POST array format
            //$_POST["rece"] = null;

            $form->setValuesByPost();

            $rece_date = new ilDate($rece_year . "-" . $rece_month . "-" . $rece_day, IL_CAL_DATE);

            $rece = $form->getItemByPostVar("rece");
            if ($rece !== null) {
                $rece->setDate($rece_date);
            }
            $recm = $form->getItemByPostVar("recm");
            if ($recm !== null) {
                $recm->setHideSubForm((int) $form->getInput("recm") < 1);
            }

            $hidden_date = new ilHiddenInputGUI("rece");
            $hidden_date->setValue($rece_date);
            $form->addItem($hidden_date);

            $this->confirmBookingNumbers($counter, $group_id, $form);
        }
    }

Here is the call graph for this function:

deliverPostFile()

ilBookingProcessGUI::deliverPostFile

(

)

Deliver post booking file.

Definition at line 1105 of file class.ilBookingProcessGUI.php.

References $book_obj_id, $id, $user_id_assigner, ilFileDelivery\deliverFileLegacy(), and ilBookingReservation\getObjectReservationForUser().

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

        $book_ids = ilBookingReservation::getObjectReservationForUser($id, $this->user_id_assigner);
        $book_id = current($book_ids);
        $obj = new ilBookingReservation($book_id);
        if ($obj->getUserId() !== $this->user_id_assigner) {
            return;
        }

        $obj = new ilBookingObject($id);
        $file = $obj->getPostFileFullPath();
        if ($file) {
            ilFileDelivery::deliverFileLegacy($file, $obj->getPostFile());
        }
    }

Here is the call graph for this function:

displayPostInfo()

ilBookingProcessGUI::displayPostInfo

(

)

Display post booking informations.

Definition at line 1013 of file class.ilBookingProcessGUI.php.

References $book_obj_id, $ctrl, $id, ILIAS\LTI\ToolProvider\$key, $lng, $tpl, $url, ilDatePresentation\formatPeriod(), ilBookingReservation\getObjectReservationForUser(), IL_CAL_UNIX, ilGlobalTemplateInterface\setContent(), ilDatePresentation\setUseRelativeDates(), ilLanguage\txt(), and ilDatePresentation\useRelativeDates().

                                     : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $id = $this->book_obj_id;
        if (!$id) {
            return;
        }
        // placeholder
        $book_ids = ilBookingReservation::getObjectReservationForUser($id, $this->user_id_assigner);
        $tmp = array();
        foreach ($book_ids as $book_id) {
            if (in_array($book_id, $this->rsv_ids) || count($this->rsv_ids) === 0) {
                $obj = new ilBookingReservation($book_id);
                $from = $obj->getFrom();
                $to = $obj->getTo();
                if ($from > time()) {
                    $key = $from . "-" . $to;
                    if (!isset($tmp[$key])) {
                        $tmp[$key] = 0;
                    }
                    $tmp[$key]++;
                }
            }
        }

        $olddt = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);

        $period = array();
        ksort($tmp);
        foreach ($tmp as $time => $counter) {
            $time = explode("-", $time);
            $time = ilDatePresentation::formatPeriod(
                new ilDateTime($time[0], IL_CAL_UNIX),
                new ilDateTime($time[1], IL_CAL_UNIX)
            );
            if ($counter > 1) {
                $time .= " (" . $counter . ")";
            }
            $period[] = $time;
        }
        $book_id = array_shift($book_ids);

        ilDatePresentation::setUseRelativeDates($olddt);


        /*
        #23578 since Booking pool participants.
        $obj = new ilBookingReservation($book_id);
        if ($obj->getUserId() != $ilUser->getId())
        {
            return;
        }
        */

        $obj = new ilBookingObject($id);
        $pfile = $obj->getPostFile();
        $ptext = $obj->getPostText();

        $mytpl = new ilTemplate('tpl.booking_reservation_post.html', true, true, 'Modules/BookingManager/BookingProcess');
        $mytpl->setVariable("TITLE", $lng->txt('book_post_booking_information'));

        if ($ptext) {
            // placeholder
            $ptext = str_replace(
                ["[OBJECT]", "[PERIOD]"],
                [$obj->getTitle(), implode("<br />", $period)],
                $ptext
            );

            $mytpl->setVariable("POST_TEXT", nl2br($ptext));
        }

        if ($pfile) {
            $url = $ilCtrl->getLinkTarget($this, 'deliverPostFile');

            $mytpl->setVariable("DOWNLOAD", $lng->txt('download'));
            $mytpl->setVariable("URL_FILE", $url);
            $mytpl->setVariable("TXT_FILE", $pfile);
        }

        $mytpl->setVariable("TXT_SUBMIT", $lng->txt('ok'));
        $mytpl->setVariable("URL_SUBMIT", $ilCtrl->getLinkTarget($this, "back"));

        $tpl->setContent($mytpl->get());
    }

Here is the call graph for this function:

executeCommand()

ilBookingProcessGUI::executeCommand

(

)

Definition at line 89 of file class.ilBookingProcessGUI.php.

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

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

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("show");
        switch ($next_class) {
            default:
                if (in_array($cmd, array("book", "back",
                    "assignParticipants",
                    "bookMultipleParticipants",
                    "saveMultipleBookings",
                    "confirmedBooking",
                    "confirmBookingNumbers",
                    "confirmedBookingNumbers",
                    "displayPostInfo",
                    "deliverPostFile"
            ))) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

handleBookingSuccess()

ilBookingProcessGUI::handleBookingSuccess ( int  $a_obj_id, array  $a_rsv_ids = null  )

protected

Definition at line 989 of file class.ilBookingProcessGUI.php.

References back(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by confirmedBooking(), and confirmedBookingNumbers().

     : void {
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('book_reservation_confirmed'), true);

        // show post booking information?
        $obj = new ilBookingObject($a_obj_id);
        $pfile = $obj->getPostFile();
        $ptext = $obj->getPostText();

        if (trim($ptext) || $pfile) {
            if (count($a_rsv_ids)) {
                $this->ctrl->setParameter($this, 'rsv_ids', implode(";", $a_rsv_ids));
            }
            $this->ctrl->redirect($this, 'displayPostInfo');
        } else {
            $this->back();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initBookingNumbersForm()

ilBookingProcessGUI::initBookingNumbersForm ( array  $a_objects_counter, int  $a_group_id, bool  $a_reload = false, ?array  $new_values = null  )

protected

Exceptions

ilCtrlException
ilDateTimeException

Definition at line 729 of file class.ilBookingProcessGUI.php.

References $id, ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by confirmBookingNumbers(), and confirmedBookingNumbers().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "confirmedBooking"));
        $form->setTitle($this->lng->txt("book_confirm_booking_schedule_number_of_objects"));
        $form->setDescription($this->lng->txt("book_confirm_booking_schedule_number_of_objects_info"));

        $section = false;
        $min_date = null;
        foreach ($a_objects_counter as $id => $counter) {
            $id = explode("_", $id);
            $book_id = $id[0] . "_" . $id[1] . "_" . $id[2] . "_" . $counter;

            $obj = new ilBookingObject($id[0]);

            if (!$section) {
                $section = new ilFormSectionHeaderGUI();
                $section->setTitle($obj->getTitle());
                $form->addItem($section);

                $section = true;
            }

            $period = /* $this->lng->txt("book_period").": ". */
                ilDatePresentation::formatPeriod(
                    new ilDateTime($id[1], IL_CAL_UNIX),
                    new ilDateTime($id[2], IL_CAL_UNIX)
                );

            $nr_field = new ilNumberInputGUI($period, "conf_nr__" . $book_id);
            $nr_field->setValue(1);
            $nr_field->setSize(3);
            $nr_field->setMaxValue($counter);
            $nr_field->setMinValue($counter ? 1 : 0);
            $nr_field->setRequired(true);
            if (!is_null($new_values) && isset($new_values["conf_nr__" . $book_id])) {
                $nr_field->setRequestParam(
                    "conf_nr__" . $book_id,
                    $new_values["conf_nr__" . $book_id]
                );
            }
            $form->addItem($nr_field);

            if (!$min_date || $id[1] < $min_date) {
                $min_date = $id[1];
            }
        }

        // recurrence
        $this->lng->loadLanguageModule("dateplaner");
        $rec_mode = new ilSelectInputGUI($this->lng->txt("cal_recurrences"), "recm");
        $rec_mode->setRequired(true);
        $rec_mode->setOptions(array(
            "-1" => $this->lng->txt("cal_no_recurrence"),
            1 => $this->lng->txt("cal_weekly"),
            2 => $this->lng->txt("r_14"),
            4 => $this->lng->txt("r_4_weeks")
        ));
        $form->addItem($rec_mode);

        $rec_end = new ilDateTimeInputGUI($this->lng->txt("cal_repeat_until"), "rece");
        $rec_end->setRequired(true);
        $rec_mode->addSubItem($rec_end);

        if (!$a_reload) {
            // show date only if active recurrence
            $rec_mode->setHideSubForm(true, '>= 1');

            if ($min_date) {
                $rec_end->setDate(new ilDateTime($min_date, IL_CAL_UNIX));
            }
        } else {
            // recurrence may not be changed on reload
            $rec_mode->setDisabled(true);
            $rec_end->setDisabled(true);
        }

        if ($a_group_id) {
            $grp = new ilHiddenInputGUI("grp_id");
            $grp->setValue($a_group_id);
            $form->addItem($grp);
        }

        if ($this->user_id_assigner !== $this->user_id_to_book) {
            $usr = new ilHiddenInputGUI("bkusr");
            $usr->setValue($this->user_id_to_book);
            $form->addItem($usr);
        }

        $form->addCommandButton("confirmedBookingNumbers", $this->lng->txt("confirm"));
        $form->addCommandButton("back", $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

processBooking()

ilBookingProcessGUI::processBooking	(	int	$a_object_id,
		int	$a_from = null,
		int	$a_to = null,
		int	$a_group_id = null
	)

Book object for date.

Returns

int reservation id

Exceptions

ilDateTimeException

Definition at line 663 of file class.ilBookingProcessGUI.php.

References ilCalendarCategoryAssignments\addAssignment(), checkPermission(), IL_CAL_UNIX, ilCalendarUtil\initDefaultCalendarByType(), ILIAS\Repository\lng(), and ilCalendarCategory\TYPE_BOOK.

Referenced by confirmedBooking(), confirmedBookingNumbers(), and saveMultipleBookings().

     : int {
        // #11995
        $this->checkPermission('read');

        $reservation = new ilBookingReservation();
        $reservation->setObjectId($a_object_id);
        $reservation->setUserId($this->user_id_to_book);
        $reservation->setAssignerId($this->user_id_assigner);
        $reservation->setFrom((int) $a_from);
        $reservation->setTo((int) $a_to);
        $reservation->setGroupId((int) $a_group_id);
        $reservation->setContextObjId($this->context_obj_id);
        $reservation->save();

        if ($a_from) {
            $this->lng->loadLanguageModule('dateplaner');
            $def_cat = ilCalendarUtil::initDefaultCalendarByType(ilCalendarCategory::TYPE_BOOK, $this->user_id_to_book, $this->lng->txt('cal_ch_personal_book'), true);

            $object = new ilBookingObject($a_object_id);

            $entry = new ilCalendarEntry();
            $entry->setStart(new ilDateTime($a_from, IL_CAL_UNIX));
            $entry->setEnd(new ilDateTime($a_to, IL_CAL_UNIX));
            $entry->setTitle($this->lng->txt('book_cal_entry') . ' ' . $object->getTitle());
            $entry->setContextId($reservation->getId());
            $entry->save();

            $assignment = new ilCalendarCategoryAssignments($entry->getEntryId());
            if ($def_cat !== null) {
                $assignment->addAssignment($def_cat->getCategoryID());
            }
        }

        return $reservation->getId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToList()

ilBookingProcessGUI::redirectToList

(

)

Definition at line 541 of file class.ilBookingProcessGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $this->ctrl->redirect($this, 'assignParticipants');
    }

Here is the call graph for this function:

saveMultipleBookings()

ilBookingProcessGUI::saveMultipleBookings

(

)

Save multiple users reservations for one booking pool object.

Todo:

check if object/user exist in the DB,

Definition at line 550 of file class.ilBookingProcessGUI.php.

References $id, back(), ILIAS\Repository\lng(), and processBooking().

                                          : void
    {
        $participants = $this->book_request->getParticipants();
        $object_id = $this->book_request->getObjectId();
        if (count($participants) > 0 && $object_id > 0) {
            $this->book_obj_id = $object_id;
        } else {
            $this->back();
        }
        $rsv_ids = array();
        foreach ($participants as $id) {
            $this->user_id_to_book = $id;
            $rsv_ids[] = $this->processBooking($this->book_obj_id);
        }

        if (count($rsv_ids)) {
            $this->tpl->setOnScreenMessage('success', "booking_multiple_succesfully");
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed_overbooked'), true);
        }
        $this->back();
    }

Here is the call graph for this function:

saveParticipant()

ilBookingProcessGUI::saveParticipant ( )

protected

save booking participant

Definition at line 653 of file class.ilBookingProcessGUI.php.

Referenced by confirmedBooking(), and confirmedBookingNumbers().

                                        : void
    {
        $participant = new ilBookingParticipant($this->user_id_to_book, $this->pool->getId());
    }

Here is the caller graph for this function:

setHelpId()

ilBookingProcessGUI::setHelpId ( string  $a_id )

protected

Definition at line 118 of file class.ilBookingProcessGUI.php.

References ILIAS\Repository\help().

Referenced by book().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilBookingProcessGUI::$access

protected

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

Referenced by checkPermissionBool().

$book_obj_id

int ilBookingProcessGUI::$book_obj_id

protected

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

Referenced by assignParticipants(), confirmedBooking(), deliverPostFile(), and displayPostInfo().

$book_request

ILIAS BookingManager StandardGUIRequest ilBookingProcessGUI::$book_request

protected

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

$booking_object_id

int ilBookingProcessGUI::$booking_object_id

protected

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

$context_obj_id

int ilBookingProcessGUI::$context_obj_id

protected

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

$ctrl

ilCtrl ilBookingProcessGUI::$ctrl

protected

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

Referenced by displayPostInfo(), and executeCommand().

$help

ilBookingHelpAdapter ilBookingProcessGUI::$help

protected

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

$lng

ilLanguage ilBookingProcessGUI::$lng

protected

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

Referenced by displayPostInfo().

$pool

ilObjBookingPool ilBookingProcessGUI::$pool

protected

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

$raw_post_data

array ilBookingProcessGUI::$raw_post_data

protected

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

$rsv_ids

array ilBookingProcessGUI::$rsv_ids = []

protected

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

$seed

string ilBookingProcessGUI::$seed

protected

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

$sseed

string ilBookingProcessGUI::$sseed

protected

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

$tabs_gui

ilTabsGUI ilBookingProcessGUI::$tabs_gui

protected

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

$tpl

ilGlobalTemplateInterface ilBookingProcessGUI::$tpl

protected

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

Referenced by book(), confirmBookingNumbers(), and displayPostInfo().

$user

ilObjUser ilBookingProcessGUI::$user

protected

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

Referenced by book().

$user_id_assigner

int ilBookingProcessGUI::$user_id_assigner

protected

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

Referenced by deliverPostFile().

$user_id_to_book

int ilBookingProcessGUI::$user_id_to_book

protected

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

---

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

• Modules/BookingManager/BookingProcess/class.ilBookingProcessGUI.php