Booking preferences ui class. More...

Collaboration diagram for ilBookingPreferencesGUI:

Public Member Functions
	__construct (ilObjBookingPool $pool)

	executeCommand ()

	initPreferenceForm ()

	savePreferences ()

Protected Member Functions
	show ()

	listPreferenceOptions (?Form\Standard $form=null)

	renderBookingInfo ()

	listBookingResults ()

Protected Attributes
ObjectsManager	$objects_manager

AccessManager	$access

InternalService	$service

ilCtrl	$ctrl

ilGlobalTemplateInterface	$main_tpl

ilObjBookingPool	$pool

ILIAS DI UIServices	$ui

ilLanguage	$lng

Psr Http Message ServerRequestInterface	$request

ilObjUser	$user

ilBookingPreferencesDBRepository	$repo

Detailed Description

Booking preferences ui class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingPreferencesGUI::__construct ( ilObjBookingPool $pool )

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

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->request = $DIC->http()->request();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->service = $DIC->bookingManager()->internal();
        $this->pool = $pool;
        $this->repo = $this->service->repo()->preferences();
        $this->access = $DIC->bookingManager()->internal()->domain()->access();
        $this->objects_manager = $DIC->bookingManager()->internal()->domain()
            ->objects($pool->getId());
    }

References $DIC, $pool, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObject\getId(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilBookingPreferencesGUI::executeCommand ( )

Definition at line 62 of file class.ilBookingPreferencesGUI.php.

                                    : void
    {
        $ctrl = $this->ctrl;
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("show");
        if ($cmd === "render") {
            $cmd = "show";
        }
        switch ($next_class) {
            default:
                if (in_array($cmd, ["show", "savePreferences"])) {
                    $this->$cmd();
                }
        }
    }

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

Here is the call graph for this function:

◆ initPreferenceForm()

ilBookingPreferencesGUI::initPreferenceForm ( )

Definition at line 104 of file class.ilBookingPreferencesGUI.php.

                                        : Form\Standard
    {
        $ui = $this->ui;
        $f = $ui->factory();
        $ctrl = $this->ctrl;
        $lng = $this->lng;
        $repo = $this->repo;
 
        $preferences = $repo->getPreferencesOfUser($this->pool->getId(), $this->user->getId());
        $preferences = $preferences->getPreferences();
 
        $this->renderBookingInfo();
 
        $fields = [];
        foreach (ilBookingObject::getList($this->pool->getId()) as $book_obj) {
            $checked = isset($preferences[$this->user->getId()]) &&
                in_array((int) $book_obj["booking_object_id"], $preferences[$this->user->getId()], true);
 
            $fields["cb_" . $book_obj["booking_object_id"]] =
                $f->input()->field()->checkbox($book_obj["title"], $book_obj["description"])->withValue($checked);
        }
 
        // section
        $section1 = $f->input()->field()->section($fields, $lng->txt("book_preferences"));
 
        $form_action = $ctrl->getLinkTarget($this, "savePreferences");
        return $f->input()->container()->form()->standard($form_action, ["sec" => $section1]);
    }

References Vendor\Package\$f, $lng, ilCtrl\getLinkTarget(), ilBookingObject\getList(), ilBookingPreferencesDBRepository\getPreferencesOfUser(), and ILIAS\Repository\user().

Referenced by listPreferenceOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listBookingResults()

ilBookingPreferencesGUI::listBookingResults ( )

protected

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

                                           : void
    {
        $main_tpl = $this->main_tpl;
        $lng = $this->lng;
        $repo = $this->repo;
        $ui = $this->ui;
        $ctrl = $this->ctrl;
 
        $info_gui = new ilInfoScreenGUI($this);
 
        // preferences
        $info_gui->addSection($lng->txt("book_your_preferences"));
        $preferences = $repo->getPreferencesOfUser($this->pool->getId(), $this->user->getId());
        $preferences = $preferences->getPreferences();
        $cnt = 1;
        if (isset($preferences[$this->user->getId()])) {
            $book_deleted_object = "[{$this->lng->txt("book_deleted_object")}]";
            foreach ($preferences[$this->user->getId()] as $book_obj_id) {
                $book_obj = new ilBookingObject($book_obj_id);
                $info_gui->addProperty((string) $cnt++, $book_obj->getTitle() ?: $book_deleted_object);
            }
        } else {
            $info_gui->addProperty("", $lng->txt("book_no_preferences_for_you"));
        }
 
        // bookings
        $this->service->domain()->preferences($this->pool)->storeBookings(
            $this->repo->getPreferences($this->pool->getId())
        );
        $bookings = $this->service->domain()->preferences($this->pool)->readBookings();
        $info_gui->addSection($lng->txt("book_your_bookings"));
        $cnt = 1;
        if (isset($bookings[$this->user->getId()])) {
            foreach ($bookings[$this->user->getId()] as $book_obj_id) {
                $book_obj = new ilBookingObject($book_obj_id);
                $post_file = $this->objects_manager->getBookingInfoFilename($book_obj_id);
 
                // post info button
                $post_info_button = "";
                if ($post_file || $book_obj->getPostText()) {
                    $ctrl->setParameterByClass("ilBookingObjectGUI", "object_id", $book_obj_id);
                    $b = $ui->factory()->button()->shy(
                        $lng->txt("book_post_booking_information"),
                        $ctrl->getLinkTargetByClass(["ilBookingObjectGUI", "ilBookingProcessWithoutScheduleGUI"], "displayPostInfo")
                    );
                    $post_info_button = "<br>" . $ui->renderer()->render($b);
                }
                $info_gui->addProperty((string) $cnt++, $book_obj->getTitle() . $post_info_button);
            }
        } else {
            $info_gui->addProperty("", $lng->txt("book_no_bookings_for_you"));
        }
 
        // all users
        if ($this->access->canManageAllReservations($this->pool->getRefId())) {
            $info_gui->addSection($lng->txt("book_all_users"));
            $preferences = $repo->getPreferences($this->pool->getId());
            $preferences = $preferences->getPreferences();
            $book_deleted_object = "[{$this->lng->txt("book_deleted_object")}]";
            $book_deleted_booking = "[{$this->lng->txt("book_deleted_booking")}]";
 
            $markdown = (new DataFactory())->text()->markdown();
 
            foreach ($preferences as $user_id => $obj_ids) {
                $booking_titles = !isset($bookings[$user_id])
                    ? [$book_deleted_booking]
                    : array_map(
                        static fn(int $obj_id): string => (new ilBookingObject($obj_id))->getTitle(),
                        $bookings[$user_id]
                    );
 
                $booking_str = "{$lng->txt("book_log")}: " . implode(", ", $booking_titles);
 
                $preferences_str = "{$lng->txt("book_preferences")}: " . implode(
                    ", ",
                    array_map(
                        fn(int $obj_id): string
                            => (new ilBookingObject($obj_id))->getTitle() ?: $book_deleted_object,
                        $obj_ids
                    )
                );
 
                $info_gui->addProperty(
                    ilUserUtil::getNamePresentation($user_id, false, false, "", true),
                    (string) $markdown->simpleDocument("{$preferences_str}\n{$booking_str}")->toHTML()
                );
            }
        }
 
        $main_tpl->setContent($info_gui->getHTML());
    }

References Vendor\Package\$b, $lng, $user_id, ILIAS\Repository\access(), ilCtrl\getLinkTargetByClass(), ilUserUtil\getNamePresentation(), ilBookingPreferencesDBRepository\getPreferences(), ilBookingPreferencesDBRepository\getPreferencesOfUser(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\UICore\GlobalTemplate\setContent(), ilCtrl\setParameterByClass(), and ILIAS\Repository\user().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listPreferenceOptions()

ilBookingPreferencesGUI::listPreferenceOptions ( ?Form\Standard $form = null )

protected

Definition at line 90 of file class.ilBookingPreferencesGUI.php.

     : void {
        $ui = $this->ui;
        if (count(ilBookingObject::getList($this->pool->getId())) > 0) {
            if (is_null($form)) {
                $form = $this->initPreferenceForm();
            }
            $this->main_tpl->setContent($ui->renderer()->render($form));
        } else {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("book_type_warning"));
        }
    }

References $ui, and initPreferenceForm().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderBookingInfo()

ilBookingPreferencesGUI::renderBookingInfo ( )

protected

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

                                          : void
    {
        $lng = $this->lng;
        $info = $lng->txt("book_preference_info");
        $info = str_replace(["%1", "%2"], [
            $this->pool->getPreferenceNumber(),
            ilDatePresentation::formatDate(
                new ilDateTime($this->pool->getPreferenceDeadline(), IL_CAL_UNIX)
            )
        ], $info);
        $this->main_tpl->setOnScreenMessage('info', $info);
    }

References $info, $lng, ilDatePresentation\formatDate(), and IL_CAL_UNIX.

Here is the call graph for this function:

◆ savePreferences()

ilBookingPreferencesGUI::savePreferences ( )

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

                                     : void
    {
        $preferences = $this->service->domain()->preferences($this->pool);
 
        if (!$preferences->isGivingPreferencesPossible()) {
            return;
        }
 
        $request = $this->request;
        $form = $this->initPreferenceForm();
        $lng = $this->lng;
        $ctrl = $this->ctrl;
        $repo = $this->repo;
 
        if ($request->getMethod() === "POST") {
            $form = $form->withRequest($request);
            $data = $form->getData();
 
            if (is_array($data["sec"])) {
                $obj_ids = [];
                foreach ($data["sec"] as $k => $v) {
                    if ($v === true) {
                        $id = explode("_", $k);
                        $obj_ids[] = (int) $id[1];
                    }
                }
 
                if (count($obj_ids) > $this->pool->getPreferenceNumber()) {
                    $this->main_tpl->setOnScreenMessage('failure', $lng->txt("book_too_many_preferences"), true);
                    $this->listPreferenceOptions($form);
                    return;
                }
 
                if (count($obj_ids) < $this->pool->getPreferenceNumber()) {
                    $this->main_tpl->setOnScreenMessage('failure', $lng->txt("book_not_enough_preferences"), true);
                    $this->listPreferenceOptions($form);
                    return;
                }
 
                $preferences = $this->service->data()->preferences(
                    [$this->user->getId() => $obj_ids]
                );
 
                $repo->savePreferencesOfUser($this->pool->getId(), $this->user->getId(), $preferences);
                $part = new ilBookingParticipant($this->user->getId(), $this->pool->getId());
 
                $titles = implode(", ", array_map(static function ($id) {
                    return ilBookingObject::lookupTitle($id);
                }, $obj_ids));
 
                $this->main_tpl->setOnScreenMessage('success', $lng->txt("book_preferences_saved") . " (" . $titles . ")", true);
            }
        }
        $ctrl->redirect($this, "show");
    }

References $data, $id, $lng, $request, ILIAS\Repository\int(), ilBookingObject\lookupTitle(), ilCtrl\redirect(), ilBookingPreferencesDBRepository\savePreferencesOfUser(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ show()

ilBookingPreferencesGUI::show ( )

protected

Definition at line 79 of file class.ilBookingPreferencesGUI.php.

                             : void
    {
        $preferences = $this->service->domain()->preferences($this->pool);
 
        if ($preferences->isGivingPreferencesPossible()) {
            $this->listPreferenceOptions();
        } else {
            $this->listBookingResults();
        }
    }