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

Inheritance diagram for ilBookingProcessWithoutScheduleGUI:

Collaboration diagram for ilBookingProcessWithoutScheduleGUI:

Public Member Functions
	__construct (ilObjBookingPool $pool, int $booking_object_id, int $context_obj_id=0)

	executeCommand ()

	book ()
	Triggered from object list week view for booking a single object / confirmation for. More...

	assignParticipants ()

	bookMultipleParticipants ()
	Create reservations for a bunch of booking pool participants. More...

	redirectToParticipantsList ()

	saveMultipleBookings ()
	Save multiple users reservations for one booking pool object. More...

	confirmedBooking ($message="")

	displayPostInfo ()

	deliverPostFile ()

	back ()

Protected Member Functions
	showNoPermission ()

	getMessageForm ()

	showMessageForm ()

	saveMessage ()

	showConfirmation ()

Protected Attributes
ILIAS BookingManager Access AccessManager	$access

ILIAS BookingManager Reservations ReservationManager	$reservation

ILIAS BookingManager BookingProcess ProcessUtilGUI	$util_gui

ILIAS BookingManager InternalRepoService	$repo

ILIAS BookingManager BookingProcess BookingProcessManager	$process

ILIAS HTTP Services	$http

ILIAS BookingManager InternalGUIService	$gui

array	$raw_post_data

ILIAS BookingManager StandardGUIRequest	$book_request

ilObjBookingPool	$pool

int	$booking_object_id

int	$user_id_to_book

int	$user_id_assigner

ilBookingHelpAdapter	$help

int	$context_obj_id

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

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.ilBookingProcessWithoutScheduleGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBookingProcessWithoutScheduleGUI::__construct	(	ilObjBookingPool	$pool,
		int	$booking_object_id,
		int	$context_obj_id = `0`
	)

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

References $booking_object_id, $context_obj_id, $DIC, $pool, $user_id_assigner, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC["tpl"];
         $this->lng = $DIC->language();
         $this->tabs_gui = $DIC->tabs();
         $this->user = $DIC->user();
         $this->help = $DIC->bookingManager()->internal()
                           ->gui()->bookingHelp($pool);
         $this->http = $DIC->http();
 
         $this->context_obj_id = $context_obj_id;
 
         $this->book_obj_id = $booking_object_id;
 
         $this->pool = $pool;
 
         $this->book_request = $DIC->bookingManager()
             ->internal()
             ->gui()
             ->standardRequest();
 
         $this->gui = $DIC->bookingManager()
             ->internal()
             ->gui();
 
         $this->repo = $DIC->bookingManager()
                          ->internal()
                          ->repo();
 
         $this->rsv_ids = $this->book_request->getReservationIdsFromString();
 
         $this->raw_post_data = $DIC->http()->request()->getParsedBody();
 
         $this->user_id_assigner = $this->user->getId();
         if ($this->book_request->getBookedUser() > 0) {
             $this->user_id_to_book = $this->book_request->getBookedUser();
         } else {
             $this->user_id_to_book = $this->user_id_assigner; // by default user books his own booking objects.
         }
         $this->ctrl->saveParameter($this, ["bkusr", "returnCmd"]);
 
         $this->process = $DIC->bookingManager()->internal()->domain()->process();
         $this->reservation = $DIC->bookingManager()->internal()->domain()->reservations();
         $this->util_gui = $DIC->bookingManager()->internal()->gui()->process()->ProcessUtilGUI(
             $this->pool,
             $this
         );
         $this->access = $DIC->bookingManager()->internal()->domain()->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignParticipants()

ilBookingProcessWithoutScheduleGUI::assignParticipants ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 223 of file class.ilBookingProcessWithoutScheduleGUI.php.

                                         : void
     {
         $this->util_gui->assignParticipants($this->book_obj_id);
     }

◆ back()

ilBookingProcessWithoutScheduleGUI::back ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 377 of file class.ilBookingProcessWithoutScheduleGUI.php.

References ILIAS\Repository\ctrl().

Referenced by showNoPermission().

                           : void
     {
         $this->ctrl->redirectByClass(\ilObjBookingPoolGUI::class, 'render');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ book()

ilBookingProcessWithoutScheduleGUI::book ( )

Triggered from object list week view for booking a single object / confirmation for.

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 144 of file class.ilBookingProcessWithoutScheduleGUI.php.

References $tpl, $user_id_to_book, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), showConfirmation(), and showMessageForm().

                           : 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->util_gui->setHelpId("book");
 
         $obj = new ilBookingObject($this->book_obj_id);
 
         $this->lng->loadLanguageModule("dateplaner");
         $this->ctrl->setParameter($this, 'object_id', $obj->getId());
         $this->ctrl->setParameter($this, 'returnCmd', "back");
 
         if ($this->user_id_to_book !== $this->user_id_assigner) {
             $this->ctrl->setParameter($this, 'bkusr', $this->user_id_to_book);
         }
 
         if (!$this->access->canManageReservationForUser($this->book_request->getRefId(), $this->user_id_to_book)) {
             return;
         }
 
         if ($this->pool->usesMessages()) {
             $this->showMessageForm();
         } else {
             $this->showConfirmation();
         }
     }

Here is the call graph for this function:

◆ bookMultipleParticipants()

ilBookingProcessWithoutScheduleGUI::bookMultipleParticipants ( )

Create reservations for a bunch of booking pool participants.

Definition at line 231 of file class.ilBookingProcessWithoutScheduleGUI.php.

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

                                               : void
     {
         $participants = $this->book_request->getParticipants();
         if (count($participants) === 0) {
             $this->util_gui->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) {
             if (!$this->access->canManageReservationForUser($this->pool->getRefId(), $id)) {
                 $this->showNoPermission();
                 return;
             }
             $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);
             $this->tpl->setOnScreenMessage("failure", sprintf(
                 $this->lng->txt('book_limit_objects_available'),
                 count($participants),
                 $obj->getTitle(),
                 $available
             ), true);
             $this->ctrl->redirect($this, "redirectToParticipantsList");
         } else {
             $conf->setHeaderText($this->lng->txt('book_confirm_booking_for_users'));
             $conf->addHiddenItem("object_id", $this->book_obj_id);
             $conf->setConfirm($this->lng->txt("assign"), "saveMultipleBookings");
         }
 
         $conf->setCancel($this->lng->txt("cancel"), 'redirectToParticipantsList');
         $this->tpl->setContent($conf->getHTML());
     }

Here is the call graph for this function:

◆ confirmedBooking()

ilBookingProcessWithoutScheduleGUI::confirmedBooking ( $message = "" )

Definition at line 322 of file class.ilBookingProcessWithoutScheduleGUI.php.

References $book_obj_id, $message, ILIAS\Repository\ctrl(), ilBookingReservation\getObjectReservationForUser(), ilBookingReservation\isObjectAvailableNoSchedule(), ILIAS\Repository\lng(), and null.

Referenced by saveMessage().

                                                    : bool
     {
         $success = false;
         $rsv_ids = array();
 
         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->process->bookSingle(
                         $object_id,
                         $this->user_id_to_book,
                         $this->user_id_assigner,
                         $this->context_obj_id,
                         null,
                         null,
                         null,
                         $message
                     );
                     $success = $object_id;
                 } else {
                     // #11852
                     $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed_overbooked'), true);
                     $this->ctrl->redirect($this, 'back');
                 }
             }
         }
 
         if ($success) {
             $this->util_gui->handleBookingSuccess($success, "displayPostInfo", $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:

Here is the caller graph for this function:

◆ deliverPostFile()

ilBookingProcessWithoutScheduleGUI::deliverPostFile ( )

Definition at line 369 of file class.ilBookingProcessWithoutScheduleGUI.php.

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

◆ displayPostInfo()

ilBookingProcessWithoutScheduleGUI::displayPostInfo ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

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

                                      : void
     {
         $this->util_gui->displayPostInfo(
             $this->book_obj_id,
             $this->user_id_assigner,
             "deliverPostFile"
         );
     }

◆ executeCommand()

ilBookingProcessWithoutScheduleGUI::executeCommand ( )

Definition at line 104 of file class.ilBookingProcessWithoutScheduleGUI.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",
                     "displayPostInfo",
                     "deliverPostFile",
                     "redirectToParticipantsList",
                     "saveMessage"
             ))) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getMessageForm()

ilBookingProcessWithoutScheduleGUI::getMessageForm ( )

protected

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

References ILIAS\Repository\lng().

Referenced by saveMessage(), and showMessageForm().

                                        : \ILIAS\Repository\Form\FormAdapterGUI
     {
         $obj = new ilBookingObject($this->book_obj_id);
         return $this->gui->form([self::class], "saveMessage", $this->lng->txt("book_book"))
             ->section("main", $this->lng->txt("book_booking") . ": " . $obj->getTitle())
             ->textarea(
                 "message",
                 $this->lng->txt("book_message"),
                 $this->lng->txt("book_message_info")
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParticipantsList()

ilBookingProcessWithoutScheduleGUI::redirectToParticipantsList ( )

Definition at line 275 of file class.ilBookingProcessWithoutScheduleGUI.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ saveMessage()

ilBookingProcessWithoutScheduleGUI::saveMessage ( )

protected

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

References confirmedBooking(), ILIAS\Repository\ctrl(), getMessageForm(), and ILIAS\Repository\lng().

                                     : void
     {
         $this->ctrl->saveParameter($this, ['object_id', 'returnCmd', 'bkusr']);
         $form = $this->getMessageForm();
         if (!$form->isValid()) {
             $this->tabs_gui->clearTargets();
             $this->tabs_gui->setBackTarget($this->lng->txt('book_back_to_list'), $this->ctrl->getLinkTarget($this, 'back'));
             $this->tpl->setContent($form->render());
             return;
         }
         $this->confirmedBooking($form->getData("message"));
     }

Here is the call graph for this function:

◆ saveMultipleBookings()

ilBookingProcessWithoutScheduleGUI::saveMultipleBookings ( )

Save multiple users reservations for one booking pool object.

Todo:: check if object/user exist in the DB,

Definition at line 284 of file class.ilBookingProcessWithoutScheduleGUI.php.

References $id, ILIAS\Repository\access(), ILIAS\Repository\lng(), and showNoPermission().

                                           : 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->util_gui->back();
         }
         $rsv_ids = array();
         foreach ($participants as $id) {
             if (!$this->access->canManageReservationForUser($this->pool->getRefId(), $id)) {
                 $this->showNoPermission();
                 return;
             }
             $this->user_id_to_book = $id;
             $rsv_ids[] = $this->process->bookSingle(
                 $this->book_obj_id,
                 $this->user_id_to_book,
                 $this->user_id_assigner,
                 $this->context_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->util_gui->back();
     }

Here is the call graph for this function:

◆ showConfirmation()

ilBookingProcessWithoutScheduleGUI::showConfirmation ( )

protected

Definition at line 204 of file class.ilBookingProcessWithoutScheduleGUI.php.

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

Referenced by book().

                                          : void
     {
         $tpl = $this->tpl;
 
         $obj = new ilBookingObject($this->book_obj_id);
 
         $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:

◆ showMessageForm()

ilBookingProcessWithoutScheduleGUI::showMessageForm ( )

protected

Definition at line 186 of file class.ilBookingProcessWithoutScheduleGUI.php.

References getMessageForm().

Referenced by book().

                                         : void
     {
         $this->tpl->setContent($this->getMessageForm()->render());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showNoPermission()

ilBookingProcessWithoutScheduleGUI::showNoPermission ( )

protected

Definition at line 129 of file class.ilBookingProcessWithoutScheduleGUI.php.

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

Referenced by bookMultipleParticipants(), and saveMultipleBookings().

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