ILIAS\BookingManager\BookingProcess\ProcessUtilGUI Class Reference

Common functions for process GUI classes. More...

Collaboration diagram for ILIAS\BookingManager\BookingProcess\ProcessUtilGUI:

Public Member Functions
	__construct (InternalDomainService $domain_service, InternalGUIService $gui_service, \ilObjBookingPool $pool, object $parent_gui)
	back ()
	setHelpId (string $a_id)
	assignParticipants (int $book_obj_id)
	handleBookingSuccess (int $a_obj_id, string $post_info_cmd, array $a_rsv_ids=null)
	displayPostInfo (int $book_obj_id, int $user_id, string $file_deliver_cmd)
	Display post booking informations. More...
	deliverPostFile (int $book_obj_id, int $user_id)
	Deliver post booking file. More...

Protected Attributes
ILIAS BookingManager StandardGUIRequest	$request
ilCtrl	$ctrl
ilLogger	$log
ilObjBookingPool	$pool
ilBookingHelpAdapter	$help
InternalGUIService	$gui
InternalDomainService	$domain
object	$parent_gui

Detailed Description

Common functions for process GUI classes.

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::__construct	(	InternalDomainService	$domain_service,
		InternalGUIService	$gui_service,
		\ilObjBookingPool	$pool,
		object	$parent_gui
	)

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

References ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\$parent_gui, ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\$pool, ILIAS\BookingManager\InternalGUIService\bookingHelp(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), and ILIAS\BookingManager\InternalDomainService\log().

      {
        $this->gui = $gui_service;
        $this->domain = $domain_service;
        $this->log = $domain_service->log();
        $this->help = $gui_service->bookingHelp($pool);
        $this->parent_gui = $parent_gui;
        $this->pool = $pool;
        $this->ctrl = $this->gui->ctrl();
        $this->request = $this->gui->standardRequest();
    }

Here is the call graph for this function:

Member Function Documentation

assignParticipants()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::assignParticipants

(

int

$book_obj_id

)

Definition at line 78 of file class.ProcessUtilGUI.php.

References $lng.

                                                        : void
    {
        $tabs = $this->gui->tabs();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $main_tpl = $this->gui->mainTemplate();

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

        $table = new \ilBookingAssignParticipantsTableGUI($this->parent_gui, 'assignParticipants', $this->pool->getRefId(), $this->pool->getId(), $book_obj_id);
        $main_tpl->setContent($table->getHTML());
    }

back()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::back

(

)

Definition at line 58 of file class.ProcessUtilGUI.php.

References ILIAS\Repository\ctrl().

Referenced by ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\handleBookingSuccess().

                          : void
    {
        $this->log->debug("back");
        $retCmd = $this->request->getReturnCmd();
        $this->log->debug("returnCmd is " . $retCmd);
        if ($retCmd !== "") {
            $this->ctrl->redirectByClass(get_class($this->parent_gui), $retCmd);
        } else {
            //var_dump(get_class($this->parent_gui));
            //exit;
            $this->ctrl->returnToParent($this->parent_gui);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverPostFile()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::deliverPostFile	(	int	$book_obj_id,
		int	$user_id
	)

Deliver post booking file.

Definition at line 265 of file class.ProcessUtilGUI.php.

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

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

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

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

Here is the call graph for this function:

displayPostInfo()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::displayPostInfo	(	int	$book_obj_id,
		int	$user_id,
		string	$file_deliver_cmd
	)

Display post booking informations.

Definition at line 154 of file class.ProcessUtilGUI.php.

References $id, $lng, $url, ilDatePresentation\formatPeriod(), ilBookingReservation\getObjectReservationForUser(), IL_CAL_UNIX, ILIAS\Repository\int(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

     : void {
        $this->log->debug("displayPostInfo");
        $main_tpl = $this->gui->mainTemplate();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $id = $book_obj_id;
        $request = $this->gui->standardRequest();

        if (!$id) {
            return;
        }

        $rsv_ids = $request->getReservationIdsFromString();

        $tmp = [];
        if ($rsv_ids === [] && $request->getReservationId() !== '') {
            $reservationIdParts = explode('_', $request->getReservationId());

            $user_id = (int) ($reservationIdParts[1] ?? 0);
            $from = (int) ($reservationIdParts[2] ?? 0);

            if ($from > time()) {
                $to = (int) ($reservationIdParts[3] ?? 0);
                $tmp["$from-" . ($to + 1)] = 1;
            }
            $rsv_ids = [0];
        }

        // placeholder

        $book_ids = \ilBookingReservation::getObjectReservationForUser($id, $user_id);
        foreach ($book_ids as $book_id) {
            if (in_array($book_id, $rsv_ids) || count($rsv_ids) === 0) {
                $obj = new \ilBookingReservation($book_id);
                $from = $obj->getFrom();
                $to = $obj->getTo();
                if ($from > time()) {
                    $tmp[$from . "-" . $to + 1] = $tmp[$from . "-" . $to + 1] ?? 0;
                    $tmp[$from . "-" . $to + 1]++;
                }
            }
        }

        $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 = $ctrl->getLinkTarget($this->parent_gui, $file_deliver_cmd);

            $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", $ctrl->getLinkTarget($this->parent_gui, "back"));

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

Here is the call graph for this function:

handleBookingSuccess()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::handleBookingSuccess	(	int	$a_obj_id,
		string	$post_info_cmd,
		array	$a_rsv_ids = null
	)

Definition at line 114 of file class.ProcessUtilGUI.php.

References $lng, and ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\back().

     : void {
        $this->log->debug("handleBookingSuccess");
        $main_tpl = $this->gui->mainTemplate();
        $ctrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $request = $this->gui->standardRequest();

        $main_tpl->setOnScreenMessage('success', $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)) {
                $ctrl->setParameter(
                    $this->parent_gui,
                    'rsv_ids',
                    implode(";", $a_rsv_ids)
                );
            }
            $ctrl->redirect($this->parent_gui, $post_info_cmd);
        } else {
            if ($ctrl->isAsynch()) {
                $this->gui->send("<script>window.location.href = '" .
                    $ctrl->getLinkTarget($this->parent_gui, $request->getReturnCmd()) . "';</script>");
            } else {
                $this->back();
            }
        }
    }

Here is the call graph for this function:

setHelpId()

ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::setHelpId

(

string

$a_id

)

Definition at line 72 of file class.ProcessUtilGUI.php.

References ILIAS\Repository\help().

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

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$ctrl

protected

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

$domain

InternalDomainService ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$domain

protected

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

$gui

InternalGUIService ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$gui

protected

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

$help

ilBookingHelpAdapter ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$help

protected

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

$log

ilLogger ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$log

protected

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

$parent_gui

object ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$parent_gui

protected

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

Referenced by ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\__construct().

$pool

ilObjBookingPool ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$pool

protected

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

Referenced by ILIAS\BookingManager\BookingProcess\ProcessUtilGUI\__construct().

$request

ILIAS BookingManager StandardGUIRequest ILIAS\BookingManager\BookingProcess\ProcessUtilGUI::$request

protected

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

---

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

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