This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilBookingObjectGUI:

Collaboration diagram for ilBookingObjectGUI:

Public Member Functions
	activateManagement (bool $a_val)

	isManagementActivated ()
	Is management activated? More...

	render ()
	Render list of booking objects uses ilBookingObjectsTableGUI. More...

	applyFilter ()

	resetFilter ()

	create (?ilPropertyFormGUI $a_form=null)
	Render creation form. More...

	edit (?ilPropertyFormGUI $a_form=null)
	Render edit form. More...

	initForm (string $a_mode="create", ?int $id=null)
	Build property form. More...

	save ()

	update ()

	confirmDelete ()

	delete ()

	deliverInfo ()

Protected Member Functions
	getPoolRefId ()

	getPoolObjId ()

	hasPoolSchedule ()
	Has booking pool a schedule? More...

	getPoolOverallLimit ()
	Get booking pool overall limit. More...

	showNoScheduleMessage ()

	returnToPreferences ()

	setHelpId (string $a_id)

Protected Attributes
ILIAS BookingManager Objects ObjectsManager	$objects_manager

ILIAS BookingManager Schedule ScheduleManager	$schedule_manager

ilBookBulkCreationGUI	$bulk_creation_gui

ilObjBookingPool	$pool

ILIAS BookingManager InternalGUIService	$gui

ILIAS BookingManager Access AccessManager	$access

ILIAS BookingManager StandardGUIRequest	$book_request

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilTabsGUI	$tabs

ilBookingHelpAdapter	$help

ilObjectDataCache	$obj_data_cache

ilObjUser	$user

bool	$pool_has_schedule

int	$pool_overall_limit

bool	$pool_uses_preferences = false

bool	$management = true

int	$context_obj_id

int	$object_id

string	$seed

string	$sseed

ilObjBookingPoolGUI	$pool_gui

array	$rsv_ids = []

ilAdvancedMDRecordGUI	$record_gui

int	$ref_id

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilBookingObjectGUI: ilPropertyFormGUI, ilBookingProcessWithScheduleGUI, ilBookingProcessWithoutScheduleGUI ilBookingObjectGUI: ilBookBulkCreationGUI

Definition at line 24 of file class.ilBookingObjectGUI.php.

Member Function Documentation

◆ activateManagement()

ilBookingObjectGUI::activateManagement ( bool $a_val )

Definition at line 119 of file class.ilBookingObjectGUI.php.

Referenced by ilBookingObjectServiceGUI\__construct().

                                                    : void
     {
         $this->management = $a_val;
     }

Here is the caller graph for this function:

◆ applyFilter()

ilBookingObjectGUI::applyFilter ( )

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

References getPoolObjId(), getPoolOverallLimit(), getPoolRefId(), hasPoolSchedule(), isManagementActivated(), and render().

                                  : void
     {
         $table = new ilBookingObjectsTableGUI($this, 'render', $this->getPoolRefId(), $this->getPoolObjId(), $this->hasPoolSchedule(), $this->getPoolOverallLimit(), $this->isManagementActivated());
         $table->resetOffset();
         $table->writeFilterToSession();
         $this->render();
     }

Here is the call graph for this function:

◆ confirmDelete()

ilBookingObjectGUI::confirmDelete ( )

Definition at line 560 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, $tabs, $tpl, ILIAS\Repository\access(), ilTabsGUI\clearTargets(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

                                    : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget($lng->txt('book_back_to_list'), $ilCtrl->getLinkTarget($this, 'render'));
 
         $conf = new ilConfirmationGUI();
         $conf->setFormAction($ilCtrl->getFormAction($this));
         $conf->setHeaderText($lng->txt('book_confirm_delete'));
 
         $type = new ilBookingObject($this->object_id);
         $conf->addItem('object_id', $this->object_id, $type->getTitle());
         $conf->setConfirm($lng->txt('delete'), 'delete');
         $conf->setCancel($lng->txt('cancel'), 'render');
 
         $tpl->setContent($conf->getHTML());
     }

Here is the call graph for this function:

◆ create()

ilBookingObjectGUI::create ( ?ilPropertyFormGUI $a_form = null )

Render creation form.

Definition at line 290 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, $tabs, $tpl, ILIAS\Repository\access(), ilTabsGUI\clearTargets(), initForm(), ILIAS\UICore\GlobalTemplate\setContent(), setHelpId(), and ilLanguage\txt().

Referenced by save().

                                                              : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
         $ilTabs = $this->tabs;
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget($lng->txt('book_back_to_list'), $ilCtrl->getLinkTarget($this, 'render'));
 
         $this->setHelpId('create');
 
         if (!$a_form) {
             $a_form = $this->initForm();
         }
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilBookingObjectGUI::delete ( )

Definition at line 586 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, ILIAS\Repository\access(), and ilLanguage\txt().

                             : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $obj = new ilBookingObject($this->object_id);
         $obj->deleteReservationsAndCalEntries($this->object_id);
         $obj->delete();
 
         $this->tpl->setOnScreenMessage('success', $lng->txt('book_object_deleted'), true);
         $ilCtrl->setParameter($this, 'object_id', "");
         $ilCtrl->redirect($this, 'render');
     }

Here is the call graph for this function:

◆ deliverInfo()

ilBookingObjectGUI::deliverInfo ( )

Definition at line 605 of file class.ilBookingObjectGUI.php.

References $id, and $object_id.

                                  : void
     {
         $id = $this->object_id;
         if (!$id) {
             return;
         }
 
         $this->objects_manager->deliverObjectInfo($id);
     }

◆ edit()

ilBookingObjectGUI::edit ( ?ilPropertyFormGUI $a_form = null )

Render edit form.

Definition at line 315 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, $tabs, $tpl, ILIAS\Repository\access(), initForm(), ILIAS\UICore\GlobalTemplate\setContent(), setHelpId(), and ilLanguage\txt().

Referenced by update().

                                                            : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
         $lng = $this->lng;
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget($lng->txt('book_back_to_list'), $ilCtrl->getLinkTarget($this, 'render'));
 
         $this->setHelpId('edit');
 
         if (!$a_form) {
             $a_form = $this->initForm('edit', $this->object_id);
         }
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPoolObjId()

ilBookingObjectGUI::getPoolObjId ( )

protected

Definition at line 137 of file class.ilBookingObjectGUI.php.

Referenced by applyFilter(), initForm(), render(), resetFilter(), and save().

                                      : int
     {
         return $this->pool_gui->getObject()->getId();
     }

Here is the caller graph for this function:

◆ getPoolOverallLimit()

ilBookingObjectGUI::getPoolOverallLimit ( )

protected

Get booking pool overall limit.

Definition at line 153 of file class.ilBookingObjectGUI.php.

References $ctrl, ILIAS\Repository\ctrl(), ilCtrl\getNextClass(), hasPoolSchedule(), initForm(), and null.

Referenced by applyFilter(), render(), and resetFilter().

                                             : ?int
     {
         return $this->hasPoolSchedule()
             ? null
             : $this->pool_gui->getObject()->getOverallLimit();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPoolRefId()

ilBookingObjectGUI::getPoolRefId ( )

protected

Definition at line 132 of file class.ilBookingObjectGUI.php.

Referenced by applyFilter(), render(), and resetFilter().

                                      : int
     {
         return $this->pool_gui->getRefId();
     }

Here is the caller graph for this function:

◆ hasPoolSchedule()

ilBookingObjectGUI::hasPoolSchedule ( )

protected

Has booking pool a schedule?

Definition at line 145 of file class.ilBookingObjectGUI.php.

References ilObjBookingPool\TYPE_FIX_SCHEDULE.

Referenced by applyFilter(), getPoolOverallLimit(), initForm(), render(), resetFilter(), save(), and update().

                                         : bool
     {
         return ($this->pool_gui->getObject()->getScheduleType() === ilObjBookingPool::TYPE_FIX_SCHEDULE);
     }

Here is the caller graph for this function:

◆ initForm()

ilBookingObjectGUI::initForm	(	string	$a_mode = `"create"`,
		?int	$id = `null`
	)

Build property form.

Definition at line 345 of file class.ilBookingObjectGUI.php.

References $ctrl, $id, $lng, $obj_data_cache, $post, getPoolObjId(), hasPoolSchedule(), ilAdvancedMDRecordGUI\MODE_EDITOR, ilFileInputGUI\setAllowDeletion(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setRequired(), and ilLanguage\txt().

Referenced by create(), edit(), getPoolOverallLimit(), save(), and update().

      : ilPropertyFormGUI {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilObjDataCache = $this->obj_data_cache;
 
         $form_gui = new ilPropertyFormGUI();
 
         $title = new ilTextInputGUI($lng->txt("title"), "title");
         $title->setRequired(true);
         $title->setSize(40);
         $title->setMaxLength(120);
         $form_gui->addItem($title);
 
         $desc = new ilTextAreaInputGUI($lng->txt("description"), "desc");
         $desc->setCols(70);
         $desc->setRows(15);
         $desc->setMaxNumOfChars(1000);
         $form_gui->addItem($desc);
 
         $file = new ilFileInputGUI($lng->txt("book_additional_info_file"), "file");
         $file->setAllowDeletion(true);
         $form_gui->addItem($file);
 
         $nr = new ilNumberInputGUI($lng->txt("booking_nr_of_items"), "items");
         $nr->setRequired(true);
         $nr->setSize(3);
         $nr->setMaxLength(3);
         $nr->setSuffix($lng->txt("book_booking_objects"));
         $form_gui->addItem($nr);
 
         if ($this->hasPoolSchedule()) {
             $options = array();
             foreach ($this->schedule_manager->getScheduleList() as $schedule_id => $schedule_title) {
                 $options[$schedule_id] = $schedule_title;
             }
             $schedule = new ilSelectInputGUI($lng->txt("book_schedule"), "schedule");
             $schedule->setRequired(true);
             $schedule->setOptions($options);
             $form_gui->addItem($schedule);
         }
 
         $post = new ilFormSectionHeaderGUI();
         $post->setTitle($lng->txt("book_post_booking_information"));
         $form_gui->addItem($post);
 
         $pdesc = new ilTextAreaInputGUI($lng->txt("book_post_booking_text"), "post_text");
         $pdesc->setCols(70);
         $pdesc->setRows(15);
         $pdesc->setInfo($lng->txt("book_post_booking_text_info"));
         $form_gui->addItem($pdesc);
 
         $pfile = new ilFileInputGUI($lng->txt("book_post_booking_file"), "post_file");
         $pfile->setAllowDeletion(true);
         $form_gui->addItem($pfile);
 
         // #18214 - should also work for new objects
         $this->record_gui = new ilAdvancedMDRecordGUI(
             ilAdvancedMDRecordGUI::MODE_EDITOR,
             "book",
             $this->getPoolObjId(),
             "bobj",
             (int) $id
         );
         $this->record_gui->setPropertyForm($form_gui);
         $this->record_gui->parse();
 
         if ($a_mode === "edit") {
             $form_gui->setTitle($lng->txt("book_edit_object"));
 
             $item = new ilHiddenInputGUI('object_id');
             $item->setValue($id);
             $form_gui->addItem($item);
 
             $obj = new ilBookingObject($id);
             $title->setValue($obj->getTitle());
             $desc->setValue($obj->getDescription());
             $nr->setValue($obj->getNrOfItems());
             $pdesc->setValue($obj->getPostText());
             $file->setValue($this->objects_manager->getObjectInfoFilename($id));
             $pfile->setValue($this->objects_manager->getBookingInfoFilename($id));
 
             if (isset($schedule)) {
                 $schedule->setValue($obj->getScheduleId());
             }
 
             $form_gui->addCommandButton("update", $lng->txt("save"));
         } else {
             $form_gui->setTitle($lng->txt("book_add_object"));
             $form_gui->addCommandButton("save", $lng->txt("save"));
             $form_gui->addCommandButton("render", $lng->txt("cancel"));
         }
         $form_gui->setFormAction($ilCtrl->getFormAction($this));
 
         return $form_gui;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isManagementActivated()

ilBookingObjectGUI::isManagementActivated ( )

Is management activated?

Definition at line 127 of file class.ilBookingObjectGUI.php.

References $management.

Referenced by applyFilter(), render(), and resetFilter().

                                            : bool
     {
         return $this->management;
     }

Here is the caller graph for this function:

◆ render()

ilBookingObjectGUI::render ( )

Render list of booking objects uses ilBookingObjectsTableGUI.

Definition at line 235 of file class.ilBookingObjectGUI.php.

References Vendor\Package\$bar, $ctrl, $lng, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getPoolObjId(), getPoolOverallLimit(), getPoolRefId(), hasPoolSchedule(), isManagementActivated(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\setContent(), ILIAS\UICore\GlobalTemplate\setPermanentLink(), showNoScheduleMessage(), and ilLanguage\txt().

Referenced by applyFilter(), and resetFilter().

                             : void
     {
         $this->showNoScheduleMessage();
 
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $bar = "";
 
         if ($this->isManagementActivated() && $this->access->canManageObjects($this->getPoolRefId())) {
             $bar = new ilToolbarGUI();
             $bar->addButton($lng->txt('book_add_object'), $ilCtrl->getLinkTarget($this, 'create'));
 
             // bulk creation
             $this->bulk_creation_gui->modifyToolbar($bar);
 
             if ($this->hasPoolSchedule()) {
                 $bar->addSeparator();
                 $list_link = $this->ctrl->getLinkTarget($this, "");
                 $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"));
                 $bar->addComponent($mode_control);
             }
             $bar = $bar->getHTML();
         }
 
         $tpl->setPermanentLink('book', $this->getPoolRefId());
 
         $table = new ilBookingObjectsTableGUI($this, 'render', $this->getPoolRefId(), $this->getPoolObjId(), $this->hasPoolSchedule(), $this->getPoolOverallLimit(), $this->isManagementActivated());
         $tpl->setContent($bar . $table->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilBookingObjectGUI::resetFilter ( )

Definition at line 279 of file class.ilBookingObjectGUI.php.

References getPoolObjId(), getPoolOverallLimit(), getPoolRefId(), hasPoolSchedule(), isManagementActivated(), and render().

                                  : void
     {
         $table = new ilBookingObjectsTableGUI($this, 'render', $this->getPoolRefId(), $this->getPoolObjId(), $this->hasPoolSchedule(), $this->getPoolOverallLimit(), $this->isManagementActivated());
         $table->resetOffset();
         $table->resetFilter();
         $this->render();
     }

Here is the call graph for this function:

◆ returnToPreferences()

ilBookingObjectGUI::returnToPreferences ( )

protected

Definition at line 226 of file class.ilBookingObjectGUI.php.

References ILIAS\Repository\ctrl().

                                             : void
     {
         $this->ctrl->redirectByClass("ilBookingPreferencesGUI");
     }

Here is the call graph for this function:

◆ save()

ilBookingObjectGUI::save ( )

Definition at line 444 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, $valid, ILIAS\Repository\access(), create(), getPoolObjId(), hasPoolSchedule(), initForm(), null, and ilLanguage\txt().

                           : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = $this->initForm();
         if ($form->checkInput()) {
             $valid = true;
             if ($this->record_gui &&
                 !$this->record_gui->importEditFormPostValues()) {
                 $valid = false;
             }
             if ($valid) {
                 $obj = new ilBookingObject();
                 $obj->setPoolId($this->getPoolObjId());
                 $obj->setTitle($form->getInput("title"));
                 $obj->setDescription($form->getInput("desc"));
                 $obj->setNrOfItems($form->getInput("items"));
                 $obj->setPostText($form->getInput("post_text"));
 
                 if ($this->hasPoolSchedule()) {
                     $obj->setScheduleId($form->getInput("schedule"));
                 }
 
                 $obj->save();
 
                 $file = $form->getItemByPostVar("file");
                 if ($_FILES["file"]["tmp_name"]) {
                     $this->objects_manager->importObjectInfoFromLegacyUpload($obj->getId(), $_FILES["file"]);
                 } elseif ($file !== null && $file->getDeletionFlag()) {
                     $this->objects_manager->deleteObjectInfo($obj->getId());
                 }
 
                 $pfile = $form->getItemByPostVar("post_file");
                 if ($_FILES["post_file"]["tmp_name"]) {
                     $this->objects_manager->importBookingInfoFromLegacyUpload($obj->getId(), $_FILES["post_file"]);
                 } elseif ($pfile !== null && $pfile->getDeletionFlag()) {
                     $this->objects_manager->deleteBookingInfo($obj->getId());
                 }
 
                 $obj->update();
 
                 if ($this->record_gui) {
                     $this->record_gui->writeEditForm(null, $obj->getId());
                 }
 
                 $this->tpl->setOnScreenMessage('success', $lng->txt("book_object_added"), true);
                 $ilCtrl->redirect($this, "render");
             }
         }
 
         $form->setValuesByPost();
         $this->create($form);
     }

Here is the call graph for this function:

◆ setHelpId()

ilBookingObjectGUI::setHelpId ( string $a_id )

protected

Definition at line 337 of file class.ilBookingObjectGUI.php.

References ILIAS\Repository\help().

Referenced by create(), and edit().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showNoScheduleMessage()

ilBookingObjectGUI::showNoScheduleMessage ( )

protected

Definition at line 221 of file class.ilBookingObjectGUI.php.

Referenced by render().

                                               : void
     {
         $this->pool_gui->showNoScheduleMessage();
     }

Here is the caller graph for this function:

◆ update()

ilBookingObjectGUI::update ( )

Definition at line 503 of file class.ilBookingObjectGUI.php.

References $ctrl, $lng, $valid, ILIAS\Repository\access(), edit(), hasPoolSchedule(), initForm(), null, and ilLanguage\txt().

                             : void
     {
         if (!$this->access->canManageObjects($this->ref_id)) {
             return;
         }
 
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $form = $this->initForm('edit', $this->object_id);
         if ($form->checkInput()) {
             $valid = true;
             if ($this->record_gui &&
                 !$this->record_gui->importEditFormPostValues()) {
                 $valid = false;
             }
 
             if ($valid) {
                 $obj = new ilBookingObject($this->object_id);
                 $obj->setTitle($form->getInput("title"));
                 $obj->setDescription($form->getInput("desc"));
                 $obj->setNrOfItems($form->getInput("items"));
                 $obj->setPostText($form->getInput("post_text"));
 
                 $file = $form->getItemByPostVar("file");
                 if ($_FILES["file"]["tmp_name"]) {
                     $this->objects_manager->importObjectInfoFromLegacyUpload($obj->getId(), $_FILES["file"]);
                 } elseif ($file !== null && $file->getDeletionFlag()) {
                     $this->objects_manager->deleteObjectInfo($obj->getId());
                 }
 
                 $pfile = $form->getItemByPostVar("post_file");
                 if ($_FILES["post_file"]["tmp_name"]) {
                     $this->objects_manager->importBookingInfoFromLegacyUpload($obj->getId(), $_FILES["post_file"]);
                 } elseif ($pfile !== null && $pfile->getDeletionFlag()) {
                     $this->objects_manager->deleteBookingInfo($obj->getId());
                 }
 
                 if ($this->hasPoolSchedule()) {
                     $obj->setScheduleId($form->getInput("schedule"));
                 }
 
                 $obj->update();
 
                 if ($this->record_gui) {
                     $this->record_gui->writeEditForm();
                 }
 
                 $this->tpl->setOnScreenMessage('success', $lng->txt("book_object_updated"), true);
                 $ilCtrl->redirect($this, "edit");
             }
         }
 
         $form->setValuesByPost();
         $this->edit($form);
     }