This class is used for inegration 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, $main_host_ref_id=0)
	Constructor. More...

	executeCommand ()
	Execute command. More...

	initSettingsForm ()
	Init settings form. More...

	saveSettings ()
	Save settings form. More...

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

	showPoolSelector ($return_to)
	Pool selector. More...

	selectPool ()
	Select pool. More...

	setSubTabs ($active)
	Set sub tabs. More...

	show ()
	Show. More...

	settings ()
	Settings. More...

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

Protected Attributes
	$ctrl

	$lng

	$main_tpl

	$parent_gui

	$tabs

	$obj_id

	$ref_id

	$current_settings

	$current_pool_ref_id

	$pool = null

	$toolbar

	$main_host_ref_id = 0

	$pools_selected = false

Detailed Description

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

courses.

ilBookingGatewayGUI: ilPropertyFormGUI, ilBookingObjectServiceGUI, ilBookingReservationsGUI

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

References $_GET, $DIC, $main_host_ref_id, $parent_gui, help(), initPool(), and ilUtil\stripSlashes().

     {
         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->lng->loadLanguageModule("book");
 
         // current parent context (e.g. session in course)
         $this->obj_id = (int) $parent_gui->object->getId();
         $this->ref_id = (int) $parent_gui->object->getRefId();
 
         $this->main_host_ref_id = ($main_host_ref_id == 0)
             ? $this->ref_id
             : $main_host_ref_id;
 
 
         $this->seed = ilUtil::stripSlashes($_GET['seed']);
         $this->sseed = ilUtil::stripSlashes($_GET['sseed']);
 
         $this->toolbar = $DIC->toolbar();
 
         $this->use_book_repo = new ilObjUseBookDBRepository($DIC->database());
 
         if (in_array($_REQUEST["return_to"], ["ilbookingobjectservicegui", "ilbookingreservationsgui"])) {
             $this->return_to = $_REQUEST["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 ( $ids )

protected

Check if all pools have schedules.

Parameters

int[] $ids pool ref ids

Returns: bool

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

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

Referenced by saveSettings().

     {
         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 ( )

Execute command.

Exceptions

ilCtrlException

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

References $ctrl, help(), initSettingsForm(), setSubTabs(), and showPoolSelector().

     {
         $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.

Determin 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 143 of file class.ilBookingGatewayGUI.php.

References $_GET, $_POST, $ctrl, and ilObject\_lookupObjId().

Referenced by __construct().

     {
         $ctrl = $this->ctrl;
 
         $ctrl->saveParameter($this, "pool_ref_id");
         $pool_ref_id = ($_POST["pool_ref_id"] > 0)
             ? (int) $_POST["pool_ref_id"]
             : (int) $_GET["pool_ref_id"];
 
         $book_ref_ids = $this->use_book_repo->getUsedBookingPools(ilObject::_lookupObjId($this->main_host_ref_id));
 
         $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 ( )

Init settings form.

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

References $ctrl, $lng, and ilRepositorySelector2InputGUI\getExplorerGUI().

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

     {
         $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 ( )

Save settings form.

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

References $ctrl, $i, $lng, $main_tpl, checkBookingPoolsForSchedules(), initSettingsForm(), and ilUtil\sendFailure().

     {
         $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(function ($i) {
                     return (int) $i;
                 }, $b_ids)
                 : [];
 
             if (!$this->checkBookingPoolsForSchedules($b_ids)) {
                 ilUtil::sendFailure($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();
 
             ilUtil::sendSuccess($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

Select pool.

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

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

◆ setSubTabs()

ilBookingGatewayGUI::setSubTabs ( $active )

protected

Set sub tabs.

Parameters

$active

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

References $ctrl, $lng, and $tabs.

Referenced by executeCommand(), and settings().

     {
         $tabs = $this->tabs;
         $ctrl = $this->ctrl;
         $lng = $this->lng;
 
         if ($this->pools_selected) {
             $tabs->addSubTab(
                 "book_obj",
                 $lng->txt("book_objects_list"),
                 $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 caller graph for this function:

◆ settings()

ilBookingGatewayGUI::settings ( )

protected

Settings.

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

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

     {
         $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

Show.

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

References $ctrl, and ilUtil\sendFailure().

     {
         $ctrl = $this->ctrl;
         if ($this->pools_selected) {
             $ctrl->redirectByClass("ilbookingobjectservicegui");
         } elseif ($this->ref_id == $this->main_host_ref_id) {
             $ctrl->redirect($this, "settings");
         }
 
         ilUtil::sendFailure($this->lng->txt("book_no_pools_selected"));
     }

Here is the call graph for this function:

◆ showPoolSelector()

ilBookingGatewayGUI::showPoolSelector ( $return_to )

protected

Pool selector.

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

References $ref_id, $si, ilObject\_lookupObjectId(), ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by executeCommand().

     {
         //
         $options = [];
         foreach ($this->use_book_repo->getUsedBookingPools(ilObject::_lookupObjectId($this->main_host_ref_id)) 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");
         }
     }