Booking process ui class. More...

Inheritance diagram for ilBookingProcessWithScheduleGUI:

Collaboration diagram for ilBookingProcessWithScheduleGUI:

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

	executeCommand ()

	week ()
	First step in booking process. More...

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

	assignParticipants ()

	showNumberForm ()

	processNumberForm ()

	checkAvailability (bool $incl_recurrence=true, int $nr=0, string $message="")

	displayPostInfo ()

	deliverPostFile ()

	back ()

Protected Member Functions
	selectObjects ()

	getBookgingObjectTitle ()

	getNumberForm (int $from, int $to)

	getRecurrenceForm ()

	getMissingAvailabilityMessage (array $missing)

	bookAvailableItems (?int $recurrence=null, ?ilDateTime $until=null)

	getBookAvailableTarget (int $obj_id, string $slot, int $recurrence, int $nr, int $until)

Protected Attributes
ilLogger	$log

ILIAS BookingManager BookingProcess ObjectSelectionManager	$object_selection

ILIAS BookingManager Objects ObjectsManager	$object_manager

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

string	$seed

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

Booking process ui class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingProcessWithScheduleGUI::__construct	(	ilObjBookingPool	$pool,
		int	$booking_object_id,
		string	$seed = `""`,
		int	$context_obj_id = `0`
	)

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

References $booking_object_id, $context_obj_id, $DIC, $pool, $seed, $user_id_assigner, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObject\getId(), 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->access = $DIC->access();
         $this->tabs_gui = $DIC->tabs();
         $this->user = $DIC->user();
         $this->http = $DIC->http();
 
         $this->context_obj_id = $context_obj_id;
 
         $this->book_obj_id = $booking_object_id;
 
         $this->pool = $pool;
 
         $this->seed = $seed;
         $internal_service = $DIC->bookingManager()->internal();
         $this->gui = $internal_service->gui();
         $domain = $internal_service->domain();
         $this->book_request = $this->gui->standardRequest();
         $this->help = $this->gui->bookingHelp($pool);
         $this->log = $domain->log();
 
         $this->repo = $internal_service->repo();
 
         $this->object_manager = $domain->objects($pool->getId());
         $this->object_selection = $domain->objectSelection($pool->getId());
 
         $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->ctrl->setParameter($this, "seed", $this->seed);
 
         $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
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignParticipants()

ilBookingProcessWithScheduleGUI::assignParticipants ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

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

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

◆ back()

ilBookingProcessWithScheduleGUI::back ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 538 of file class.ilBookingProcessWithScheduleGUI.php.

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

◆ book()

ilBookingProcessWithScheduleGUI::book ( )

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

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 205 of file class.ilBookingProcessWithScheduleGUI.php.

References $seed, $tpl, ilCalendarUserSettings\_getInstanceByUserId(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), and ILIAS\Repository\user().

                           : void // ok
     {
         $this->log->debug("Step 1, book");
         $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', "book");
 
         if ($this->user_id_to_book !== $this->user_id_assigner) {
             $this->ctrl->setParameter($this, 'bkusr', $this->user_id_to_book);
         }
 
         $user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
 
         $week_gui = new \ILIAS\BookingManager\BookingProcess\WeekGUI(
             $this,
             "book",
             [$obj->getId()],
             $this->pool->getId(),
             $this->seed,
             $user_settings->getWeekStart()
         );
         $tpl->setContent($week_gui->getHTML());
     }

Here is the call graph for this function:

◆ bookAvailableItems()

ilBookingProcessWithScheduleGUI::bookAvailableItems	(	?int	$recurrence = `null`,
		?ilDateTime	$until = `null`
	)

protected

Definition at line 467 of file class.ilBookingProcessWithScheduleGUI.php.

References $message, IL_CAL_UNIX, ILIAS\Repository\int(), and ILIAS\Repository\lng().

                                                                                              : void
     {
         $this->log->debug("bookAvailableItems");
         $obj_id = $this->book_request->getObjectId();
         $from = $this->book_request->getSlotFrom();
         $to = $this->book_request->getSlotTo();
         $nr = $this->book_request->getNr();
         $message = $this->pool->usesMessages()
             ? $this->book_request->getMessage()
             : "";
         if (is_null($recurrence)) {
             $recurrence = (int) $this->book_request->getRecurrence();
         }
         if (is_null($until)) {
             if ($this->book_request->getUntil() > 0) {
                 $until = new ilDateTime($this->book_request->getUntil(), IL_CAL_UNIX);
             }
         }
 
         $booked = $this->process->bookAvailableObjects(
             $obj_id,
             $this->user_id_to_book,
             $this->user_id_assigner,
             $this->context_obj_id,
             $from,
             $to,
             $recurrence,
             $nr,
             $until,
             $message
         );
         if (count($booked) > 0) {
             $this->util_gui->handleBookingSuccess($obj_id, "displayPostInfo", $booked);
         } else {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('book_reservation_failed'), true);
             $this->util_gui->back();
         }
     }

Here is the call graph for this function:

◆ checkAvailability()

ilBookingProcessWithScheduleGUI::checkAvailability	(	bool	$incl_recurrence = `true`,
		int	$nr = `0`,
		string	$message = `""`
	)

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

References $message, ILIAS\Repository\ctrl(), getBookAvailableTarget(), getBookgingObjectTitle(), getMissingAvailabilityMessage(), getRecurrenceForm(), IL_CAL_UNIX, ILIAS\Repository\int(), ILIAS\Repository\lng(), and send().

Referenced by processNumberForm().

      : void {
         $this->log->debug("checkAvailability");
         $obj_id = $this->book_request->getObjectId();
         $from = $this->book_request->getSlotFrom();
         $to = $this->book_request->getSlotTo();
         if ($nr === 0) {
             $nr = $this->book_request->getNr();
         }
         if ($message === "" && $this->pool->usesMessages()) {
             $message = $this->book_request->getMessage();
         }
         $recurrence = 0;
         $until_ts = 0;
         if ($incl_recurrence) {
             $form = $this->getRecurrenceForm();
             // recurrence form not valid -> show again
             if (!$form->isValid()) {
                 $this->gui->modal($this->getBookgingObjectTitle())
                           ->form($form)
                           ->send();
             }
 
             $recurrence = (int) $form->getData("recurrence");   // 1, 2 or 4
             $until = $form->getData("until" . $recurrence);
             $until_ts = $until->get(IL_CAL_UNIX);
         }
 
         $this->ctrl->saveParameter($this, ["object_id", "slot", "nr"]);
         if ($this->pool->usesMessages()) {
             $this->ctrl->setParameter(
                 $this,
                 "message",
                 rawurlencode($message)
             );
         }
         $this->ctrl->setParameter($this, "recurrence", $recurrence);
         $this->ctrl->setParameter($this, "until", $until_ts);
         $book_available_target = $this->getBookAvailableTarget(
             $obj_id,
             $this->book_request->getSlot(),
             $recurrence,
             $nr,
             $until_ts
         );
 
         if ($incl_recurrence) {
 
             $missing = $this->process->getRecurrenceMissingAvailability(
                 $obj_id,
                 $from,
                 $to,
                 $recurrence,
                 $nr,
                 $until
             );
 
             // anything missing? -> send missing message
             if (count($missing) > 0) {
                 $html = $this->getMissingAvailabilityMessage($missing);
                 $this->gui->modal($this->getBookgingObjectTitle())
                     ->legacy($html)
                     ->button(
                         $this->lng->txt("book_book_available"),
                         $book_available_target,
                         false
                     )
                     ->send();
             }
         }
         $this->gui->send("<script>window.location.href = '" . $book_available_target . "';</script>");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverPostFile()

ilBookingProcessWithScheduleGUI::deliverPostFile ( )

Definition at line 530 of file class.ilBookingProcessWithScheduleGUI.php.

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

◆ displayPostInfo()

ilBookingProcessWithScheduleGUI::displayPostInfo ( )

Implements ILIAS\BookingManager\BookingProcess\BookingProcessGUI.

Definition at line 521 of file class.ilBookingProcessWithScheduleGUI.php.

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

◆ executeCommand()

ilBookingProcessWithScheduleGUI::executeCommand ( )

Definition at line 110 of file class.ilBookingProcessWithScheduleGUI.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", "week",
                     "assignParticipants",
                     "bookMultipleParticipants",
                     "saveMultipleBookings",
                     "showNumberForm",
                     "processNumberForm",
                     "checkAvailability",
                     "displayPostInfo",
                     "bookAvailableItems",
                     "deliverPostFile",
                     "selectObjects",
                     "redirectToParticipantsList"
             ))) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getBookAvailableTarget()

ilBookingProcessWithScheduleGUI::getBookAvailableTarget	(	int	$obj_id,
		string	$slot,
		int	$recurrence,
		int	$nr,
		int	$until
	)

protected

Definition at line 506 of file class.ilBookingProcessWithScheduleGUI.php.

References ILIAS\Repository\ctrl().

Referenced by checkAvailability().

      : string {
         $this->ctrl->setParameter($this, "obj_id", $obj_id);
         $this->ctrl->setParameter($this, "slot", $slot);
         $this->ctrl->setParameter($this, "recurrence", $recurrence);
         $this->ctrl->setParameter($this, "nr", $nr);
         $this->ctrl->setParameter($this, "until", $until);
         return $this->ctrl->getLinkTarget($this, "bookAvailableItems");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBookgingObjectTitle()

ilBookingProcessWithScheduleGUI::getBookgingObjectTitle ( )

protected

Definition at line 261 of file class.ilBookingProcessWithScheduleGUI.php.

Referenced by checkAvailability(), processNumberForm(), and showNumberForm().

                                                : string
     {
         return (new ilBookingObject($this->book_obj_id))->getTitle();
     }

Here is the caller graph for this function:

◆ getMissingAvailabilityMessage()

ilBookingProcessWithScheduleGUI::getMissingAvailabilityMessage ( array $missing )

protected

Definition at line 453 of file class.ilBookingProcessWithScheduleGUI.php.

References Vendor\Package\$f, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by checkAvailability().

                                                                     : string
     {
         $f = $this->gui->ui()->factory();
         $box = $f->messageBox()->failure($this->lng->txt("book_missing_availability"));
         $items = array_map(function ($i) {
             $from = ilDatePresentation::formatDate(new ilDateTime($i["from"], IL_CAL_UNIX));
             $to = ilDatePresentation::formatDate(new ilDateTime($i["to"], IL_CAL_UNIX));
             return $from . " - " . $to . " : " . str_replace("$1", $i["missing"], $this->lng->txt("book_missing_items"));
         }, $missing);
 
         $list = $f->listing()->unordered($items);
         return $this->gui->ui()->renderer()->render([$box, $list]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumberForm()

ilBookingProcessWithScheduleGUI::getNumberForm	(	int	$from,
		int	$to
	)

protected

Exceptions

ilCtrlException
ilDateTimeException

Definition at line 271 of file class.ilBookingProcessWithScheduleGUI.php.

References ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by processNumberForm(), and showNumberForm().

      : \ILIAS\Repository\Form\FormAdapterGUI {
         $counter = $this->reservation->getAvailableNr($this->book_request->getObjectId(), $from, $to);
         $period = ilDatePresentation::formatPeriod(
             new ilDateTime($from, IL_CAL_UNIX),
             new ilDateTime($to, IL_CAL_UNIX)
         );
         $this->ctrl->setParameter($this, "slot", $from . "_" . $to);
         $form = $this->gui->form([self::class], "processNumberForm")
             ->asyncModal()
             ->section(
                 "props",
                 $this->lng->txt("book_confirm_booking_schedule_number_of_objects"),
                 $this->lng->txt("book_confirm_booking_schedule_number_of_objects_info")
             )
             ->number("nr", $period, "", 1, 1, $counter)
             ->radio("recurrence", $this->lng->txt("book_recurrence"), "", "0")
             ->radioOption("0", $this->lng->txt("book_no_recurrence"))
             ->radioOption("1", $this->lng->txt("book_book_recurrence"));
         if ($this->pool->usesMessages()) {
             $form = $form->textarea(
                 "message",
                 $this->lng->txt("book_message"),
                 $this->lng->txt("book_message_info")
             );
         }
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecurrenceForm()

ilBookingProcessWithScheduleGUI::getRecurrenceForm ( )

protected

Definition at line 356 of file class.ilBookingProcessWithScheduleGUI.php.

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

Referenced by checkAvailability(), and processNumberForm().

                                           : \ILIAS\Repository\Form\FormAdapterGUI
     {
         $this->lng->loadLanguageModule("dateplaner");
         $today = new ilDate(time(), IL_CAL_UNIX);
         $form = $this->gui->form([self::class], "checkAvailability")
                           ->section(
                               "props",
                               $this->lng->txt("book_confirm_booking_schedule_number_of_objects"),
                               $this->lng->txt("book_confirm_booking_schedule_number_of_objects_info")
                           )
                           ->switch("recurrence", $this->lng->txt("cal_recurrences"), "", "1")
                           ->group("1", $this->lng->txt("cal_weekly"))
                           ->date("until1", $this->lng->txt("cal_repeat_until"), "", $today)
                           ->group("2", $this->lng->txt("r_14"))
                           ->date("until2", $this->lng->txt("cal_repeat_until"), "", $today)
                           ->group("4", $this->lng->txt("r_4_weeks"))
                           ->date("until4", $this->lng->txt("cal_repeat_until"), "", $today)
                           ->end();
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processNumberForm()

ilBookingProcessWithScheduleGUI::processNumberForm ( )

Definition at line 302 of file class.ilBookingProcessWithScheduleGUI.php.

References $message, checkAvailability(), ILIAS\Repository\ctrl(), getBookgingObjectTitle(), getNumberForm(), and getRecurrenceForm().

                                        : void
     {
         $this->log->debug("processNumberForm");
         //get the user who will get the booking.
         if ($this->book_request->getBookedUser() > 0) {
             $this->user_id_to_book = $this->book_request->getBookedUser();
         }
         $slot = $this->book_request->getSlot();
         $from = $this->book_request->getSlotFrom();
         $to = $this->book_request->getSlotTo();
         $obj_id = $this->book_request->getObjectId();
 
         if ($this->user_id_assigner !== $this->user_id_to_book) {
             $this->ctrl->setParameterByClass(self::class, "bkusr", $this->user_id_to_book);
         }
         $this->ctrl->setParameterByClass(self::class, "slot", $slot);
 
         // form not valid -> show again
         $form = $this->getNumberForm($from, $to);
         if (!$form->isValid()) {
             $this->gui->modal($this->getBookgingObjectTitle())
                       ->form($form)
                       ->send();
         }
 
         $message = $this->pool->usesMessages()
             ? $form->getData("message")
             : "";
 
         // recurrence? -> show recurrence form
         $recurrence = $form->getData("recurrence");
         if ($recurrence === "1") {
             if ($this->pool->usesMessages()) {
                 $this->ctrl->setParameterByClass(
                     self::class,
                     "message",
                     rawurlencode($message)
                 );
             }
             $this->ctrl->setParameterByClass(self::class, "object_id", $this->book_request->getObjectId());
             $this->ctrl->setParameterByClass(self::class, "nr", (int) $form->getData("nr"));
             $form = $this->getRecurrenceForm();
             $this->gui->modal($this->getBookgingObjectTitle())
                       ->form($form)
                       ->send();
         }
         $this->checkAvailability(
             false,
             $form->getData("nr"),
             $message
         );
     }

Here is the call graph for this function:

◆ selectObjects()

ilBookingProcessWithScheduleGUI::selectObjects ( )

protected

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

References ILIAS\Repository\ctrl().

                                       : void
     {
         $this->log->debug("selectObjects");
         $obj_ids = $this->book_request->getObjectIds();
         $this->object_selection->setSelectedObjects($obj_ids);
         $this->ctrl->redirect($this, "week");
     }

Here is the call graph for this function:

◆ showNumberForm()

ilBookingProcessWithScheduleGUI::showNumberForm ( )

Definition at line 244 of file class.ilBookingProcessWithScheduleGUI.php.

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

                                     : void
     {
         $this->log->debug("showNumberForm");
         $object_id = $this->book_obj_id;
         $from = $this->book_request->getSlotFrom();
         $to = $this->book_request->getSlotTo() - 1;
         $this->tabs_gui->clearTargets();
         $this->tabs_gui->setBackTarget(
             $this->lng->txt('book_back_to_list'),
             $this->ctrl->getLinkTarget($this, 'back')
         );
         $form = $this->getNumberForm($from, $to);
         $this->gui->modal($this->getBookgingObjectTitle())
             ->form($form)
             ->send();
     }

Here is the call graph for this function:

◆ week()

ilBookingProcessWithScheduleGUI::week ( )

First step in booking process.

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

References Vendor\Package\$bar, $seed, $tpl, ilCalendarUserSettings\_getInstanceByUserId(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), ilGlobalTemplateInterface\setRightContent(), and ILIAS\Repository\user().

                           : void // ok
     {
         $tpl = $this->tpl;
         $this->log->debug("Step 0, week");
 
         //$this->tabs_gui->clearTargets();
         //$this->tabs_gui->setBackTarget($this->lng->txt('book_back_to_list'), $this->ctrl->getLinkTarget($this, 'back'));
 
         $this->util_gui->setHelpId("week");
         $this->ctrl->setParameter($this, 'returnCmd', "week");
 
         if ($this->user_id_to_book !== $this->user_id_assigner) {
             $this->ctrl->setParameter($this, 'bkusr', $this->user_id_to_book);
         }
         $user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->user->getId());
 
         $week_gui = new \ILIAS\BookingManager\BookingProcess\WeekGUI(
             $this,
             "week",
             $this->object_selection->getSelectedObjects(),
             $this->pool->getId(),
             $this->seed,
             $user_settings->getWeekStart()
         );
         $tpl->setContent($week_gui->getHTML());
 
         $bar = $this->gui->toolbar();
         $list_link = $this->ctrl->getLinkTargetByClass("ilObjBookingPoolGUI", "render");
         $week_link = $this->ctrl->getLinkTargetByClass("ilBookingProcessWithScheduleGUI", "week");
         $mode_control = $this->gui->ui()->factory()->viewControl()->mode([
             $this->lng->txt("book_list") => $list_link,
             $this->lng->txt("book_week") => $week_link
         ], $this->lng->txt("book_view"))->withActive($this->lng->txt("book_week"));
         $bar->addComponent($mode_control);
 
         $list_gui = new \ILIAS\BookingManager\BookingProcess\ObjectSelectionListGUI(
             $this->pool->getId(),
             $this->ctrl->getFormAction($this, "selectObjects")
         );
         $tpl->setRightContent($list_gui->render());
     }