This class is used for integration of the booking manager as a service into other repository objects, e.g. More...

Collaboration diagram for ilBookingGatewayGUI:

Public Member Functions
	__construct (ilObjectGUI $parent_gui, int $main_host_ref_id=0)

	executeCommand ()

	initSettingsForm ()

	saveSettings ()

Protected Member Functions
	initPool ()
	Init pool. More...

	showPoolSelector (string $return_to)

	selectPool ()

	setSubTabs (string $active)

	show ()

	settings ()

	checkBookingPoolsForSchedules (array $ids)
	Check if all pools have schedules. More...

Protected Attributes
BookingManager StandardGUIRequest	$book_request

ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$main_tpl

ilObjectGUI	$parent_gui

ilTabsGUI	$tabs

int	$obj_id

int	$ref_id

ilObjBookingServiceSettings	$current_settings

int	$current_pool_ref_id

ilObjBookingPool	$pool = null

ilToolbarGUI	$toolbar

int	$main_host_ref_id = 0

bool	$pools_selected = false

string	$seed

string	$sseed

ilObjUseBookDBRepository	$use_book_repo

string	$return_to = ""

ilBookingHelpAdapter	$help

Detailed Description

This class is used for integration of the booking manager as a service into other repository objects, e.g.

courses. ilBookingGatewayGUI: ilPropertyFormGUI, ilBookingObjectServiceGUI, ilBookingReservationsGUI

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingGatewayGUI::__construct	(	ilObjectGUI	$parent_gui,
		int	$main_host_ref_id = `0`
	)

Definition at line 50 of file class.ilBookingGatewayGUI.php.

References $DIC, $parent_gui, ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ILIAS\Repository\help(), initPool(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->parent_gui = $parent_gui;
         $this->tabs = $DIC->tabs();
         $this->book_request = $DIC->bookingManager()
                                   ->internal()
                                   ->gui()
                                   ->standardRequest();
 
         $this->lng->loadLanguageModule("book");
 
         // current parent context (e.g. session in course)
         $this->obj_id = $parent_gui->getObject()->getId();
         $this->ref_id = $parent_gui->getObject()->getRefId();
 
         $this->main_host_ref_id = ($main_host_ref_id === 0)
             ? $this->ref_id
             : $main_host_ref_id;
 
 
         $this->seed = $this->book_request->getSeed();
         $this->sseed = $this->book_request->getSSeed();
 
         $this->toolbar = $DIC->toolbar();
 
         $this->use_book_repo = new ilObjUseBookDBRepository($DIC->database());
 
         $req_return_to = $this->book_request->getReturnTo();
         if (in_array($req_return_to, ["ilbookingobjectservicegui", "ilbookingreservationsgui"])) {
             $this->return_to = $req_return_to;
         }
 
         // get current settings
         $handler = new BookingManager\getObjectSettingsCommandHandler(
             new BookingManager\getObjectSettingsCommand($this->obj_id),
             $this->use_book_repo
         );
         $this->current_settings = $handler->handle()->getSettings();
 
         $this->initPool();
 
         if (is_object($this->pool)) {
             $this->help = new ilBookingHelpAdapter($this->pool, $DIC["ilHelp"]);
             $DIC["ilHelp"]->setScreenIdComponent("book");
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkBookingPoolsForSchedules()

ilBookingGatewayGUI::checkBookingPoolsForSchedules ( array $ids )

protected

Check if all pools have schedules.

Parameters

int[] $ids pool ref ids

Definition at line 332 of file class.ilBookingGatewayGUI.php.

References ilObject\_lookupObjectId(), and ilBookingSchedule\hasExistingSchedules().

Referenced by saveSettings().

                                                                 : bool
     {
         foreach ($ids as $pool_ref_id) {
             if (!ilBookingSchedule::hasExistingSchedules(ilObject::_lookupObjectId($pool_ref_id))) {
                 return false;
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBookingGatewayGUI::executeCommand ( )

Exceptions

ilCtrlException
ilException

Definition at line 141 of file class.ilBookingGatewayGUI.php.

References $ctrl, ILIAS\Repository\ctrl(), ilCtrl\forwardCommand(), ilCtrl\getCmd(), ilCtrl\getNextClass(), ILIAS\Repository\help(), initSettingsForm(), ilCtrl\setReturn(), setSubTabs(), and showPoolSelector().

                                     : void
     {
         $ctrl = $this->ctrl;
 
         $next_class = $ctrl->getNextClass($this);
         $cmd = $ctrl->getCmd("show");
 
         switch ($next_class) {
             case "ilpropertyformgui":
                 $form = $this->initSettingsForm();
                 $ctrl->setReturn($this, 'settings');
                 $ctrl->forwardCommand($form);
                 break;
 
             case "ilbookingobjectservicegui":
                 $this->setSubTabs("book_obj");
                 $this->showPoolSelector("ilbookingobjectservicegui");
                 $book_ser_gui = new ilBookingObjectServiceGUI(
                     $this->ref_id,
                     $this->current_pool_ref_id,
                     $this->use_book_repo,
                     $this->seed,
                     $this->sseed,
                     $this->help
                 );
                 $ctrl->forwardCommand($book_ser_gui);
                 break;
 
             case "ilbookingreservationsgui":
                 $this->showPoolSelector("ilbookingreservationsgui");
                 $this->setSubTabs("reservations");
                 $res_gui = new ilBookingReservationsGUI($this->pool, $this->help, $this->obj_id);
                 $this->ctrl->forwardCommand($res_gui);
                 break;
 
 
             default:
                 if (in_array($cmd, array("show", "settings", "saveSettings", "selectPool"))) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ initPool()

ilBookingGatewayGUI::initPool ( )

protected

Init pool.

Determine the current pool in $this->current_pool_ref_id. Host objects (e.g. courses) may use multiple booking pools. This method determines the current selected pool (stored in request parameter "pool_ref_id") within the host object user interface. If no pool has been selected yet, the first one attached to the host object is choosen. If no pools are attached to the host object at all we get a 0 ID.

Definition at line 112 of file class.ilBookingGatewayGUI.php.

References $ctrl, ilObject\_lookupObjId(), ilCtrl\saveParameter(), and ilCtrl\setParameter().

Referenced by __construct().

                                  : void
     {
         $ctrl = $this->ctrl;
 
         $ctrl->saveParameter($this, "pool_ref_id");
         $pool_ref_id = $this->book_request->getPoolRefId();
 
         $book_ref_ids = $this->use_book_repo->getUsedBookingPools(ilObject::_lookupObjId($this->main_host_ref_id), false);
 
         $this->pools_selected = (count($book_ref_ids) > 0);
 
         if (!in_array($pool_ref_id, $book_ref_ids)) {
             if (count($book_ref_ids) > 0) {
                 $pool_ref_id = current($book_ref_ids);
             } else {
                 $pool_ref_id = 0;
             }
         }
         $this->current_pool_ref_id = $pool_ref_id;
         if ($this->current_pool_ref_id > 0) {
             $this->pool = new ilObjBookingPool($this->current_pool_ref_id);
             $ctrl->setParameter($this, "pool_ref_id", $this->current_pool_ref_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilBookingGatewayGUI::initSettingsForm ( )

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

References $ctrl, $lng, ilRepositorySelector2InputGUI\getExplorerGUI(), ilCtrl\getFormAction(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by executeCommand(), saveSettings(), and settings().

                                       : ilPropertyFormGUI
     {
         $ctrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = new ilPropertyFormGUI();
 
         // booking tools
         $repo = new ilRepositorySelector2InputGUI($this->lng->txt("objs_book"), "booking_obj_ids", true);
         $repo->getExplorerGUI()->setSelectableTypes(["book"]);
         $repo->getExplorerGUI()->setTypeWhiteList(
             ["book", "root", "cat", "grp", "fold", "crs"]
         );
         $form->addItem($repo);
         $repo->setValue($this->current_settings->getUsedBookingObjectIds());
 
         $form->addCommandButton("saveSettings", $lng->txt("save"));
 
         $form->setTitle($lng->txt("book_pool_selection"));
         $form->setFormAction($ctrl->getFormAction($this));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

ilBookingGatewayGUI::saveSettings ( )

Definition at line 289 of file class.ilBookingGatewayGUI.php.

References $ctrl, $i, $lng, $main_tpl, $use_book_repo, checkBookingPoolsForSchedules(), initSettingsForm(), ilCtrl\redirect(), and ilLanguage\txt().

                                   : void
     {
         $ctrl = $this->ctrl;
         $lng = $this->lng;
         $main_tpl = $this->main_tpl;
 
         $form = $this->initSettingsForm();
         if ($form->checkInput()) {
             $b_ids = $form->getInput("booking_obj_ids");
             $b_ids = is_array($b_ids)
                 ? array_map(static function ($i) {
                     return (int) $i;
                 }, $b_ids)
                 : [];
 
             if (!$this->checkBookingPoolsForSchedules($b_ids)) {
                 $this->main_tpl->setOnScreenMessage('failure', $lng->txt("book_all_pools_need_schedules"));
                 $form->setValuesByPost();
                 $main_tpl->setContent($form->getHTML());
                 return;
             }
 
             $cmd = new BookingManager\saveObjectSettingsCommand(new ilObjBookingServiceSettings(
                 $this->obj_id,
                 $b_ids
             ));
 
             $repo = $this->use_book_repo;
             $handler = new BookingManager\saveObjectSettingsCommandHandler($cmd, $repo);
             $handler->handle();
 
             $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
             $ctrl->redirect($this, "");
         } else {
             $form->setValuesByPost();
             $main_tpl->setContent($form->getHTML());
         }
     }

Here is the call graph for this function:

◆ selectPool()

ilBookingGatewayGUI::selectPool ( )

protected

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

References ILIAS\Repository\ctrl().

                                    : void
     {
         if ($this->return_to !== "") {
             $this->ctrl->redirectByClass($this->return_to);
         }
     }

Here is the call graph for this function:

◆ setSubTabs()

ilBookingGatewayGUI::setSubTabs ( string $active )

protected

Definition at line 211 of file class.ilBookingGatewayGUI.php.

References $ctrl, $lng, $tabs, ilTabsGUI\activateSubTab(), ilTabsGUI\addSubTab(), ilCtrl\getLinkTarget(), ilCtrl\getLinkTargetByClass(), and ilLanguage\txt().

Referenced by executeCommand(), and settings().

      : void {
         $tabs = $this->tabs;
         $ctrl = $this->ctrl;
         $lng = $this->lng;
 
         if ($this->pools_selected) {
             $tabs->addSubTab(
                 "book_obj",
                 $lng->txt("book_booking_objects"),
                 $ctrl->getLinkTargetByClass("ilbookingobjectservicegui", "")
             );
             $tabs->addSubTab(
                 "reservations",
                 $lng->txt("book_log"),
                 $ctrl->getLinkTargetByClass("ilbookingreservationsgui", "")
             );
         }
         if ($this->ref_id === $this->main_host_ref_id) {
             $tabs->addSubTab(
                 "settings",
                 $lng->txt("settings"),
                 $ctrl->getLinkTarget($this, "settings")
             );
         }
 
         $tabs->activateSubTab($active);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

ilBookingGatewayGUI::settings ( )

protected

Definition at line 257 of file class.ilBookingGatewayGUI.php.

References $main_tpl, initSettingsForm(), and setSubTabs().

                                  : void
     {
         $this->setSubTabs("settings");
         $main_tpl = $this->main_tpl;
         $form = $this->initSettingsForm();
         $main_tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ show()

ilBookingGatewayGUI::show ( )

protected

Definition at line 241 of file class.ilBookingGatewayGUI.php.

References $ctrl, ILIAS\Repository\lng(), ilCtrl\redirect(), and ilCtrl\redirectByClass().

                              : void
     {
         $ctrl = $this->ctrl;
         if ($this->pools_selected) {
             $ctrl->redirectByClass("ilbookingobjectservicegui");
         } elseif ($this->ref_id === $this->main_host_ref_id) {
             $ctrl->redirect($this, "settings");
         }
 
         $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("book_no_pools_selected"));
     }

Here is the call graph for this function:

◆ showPoolSelector()

ilBookingGatewayGUI::showPoolSelector ( string $return_to )

protected

Definition at line 184 of file class.ilBookingGatewayGUI.php.

References $ref_id, ilObject\_lookupObjectId(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by executeCommand().

      : void {
         //
         $options = [];
         foreach ($this->use_book_repo->getUsedBookingPools(ilObject::_lookupObjectId($this->main_host_ref_id), false) as $ref_id) {
             $options[$ref_id] = ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id));
         }
 
         $this->ctrl->setParameter($this, "return_to", $return_to);
         if (count($options) > 0) {
             $si = new ilSelectInputGUI("", "pool_ref_id");
             $si->setOptions($options);
             $si->setValue($this->current_pool_ref_id);
             $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
             $this->toolbar->addInputItem($si, false);
             $this->toolbar->addFormButton($this->lng->txt("book_select_pool"), "selectPool");
         }
     }