ilBookingScheduleGUI Class Reference

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

Collaboration diagram for ilBookingScheduleGUI:

Public Member Functions
	__construct (ilObjBookingPoolGUI $a_parent_obj)
	executeCommand ()
	render ()
	Render list of booking schedules uses ilBookingSchedulesTableGUI. More...
	create ()
	Render creation form. More...
	edit ()
	Render edit form. More...
	initForm (string $a_mode="create", ?int $id=null)
	Build property form. More...
	save ()
	update ()
	confirmDelete ()
	Confirm delete. More...
	delete ()
	Delete schedule. More...

Protected Member Functions
	formToObject (ilPropertyFormGUI $form, ilBookingSchedule $schedule)
	Set form data into schedule object. More...

Protected Attributes
ILIAS BookingManager StandardGUIRequest	$book_request
ilGlobalTemplateInterface	$tpl
ilTabsGUI	$tabs
ilCtrl	$ctrl
ilLanguage	$lng
ilAccessHandler	$access
ilHelpGUI	$help
ilObjectDataCache	$obj_data_cache
int	$schedule_id
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 Class ilBookingScheduleGUI

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilBookingScheduleGUI:

Definition at line 25 of file class.ilBookingScheduleGUI.php.

Constructor & Destructor Documentation

__construct()

ilBookingScheduleGUI::__construct

(

ilObjBookingPoolGUI

$a_parent_obj

)

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

References $DIC, ilObject\_lookupObjId(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectGUI\getRefId(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilBookingSchedule\lookupPoolId(), and ILIAS\Repository\tabs().

      {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->help = $DIC["ilHelp"];
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->ref_id = $a_parent_obj->getRefId();
        $this->book_request = $DIC->bookingManager()
                                  ->internal()
                                  ->gui()
                                  ->standardRequest();
        $this->schedule_id = $this->book_request->getScheduleId();

        if ($this->schedule_id > 0 && ilBookingSchedule::lookupPoolId($this->schedule_id) !== ilObject::_lookupObjId($this->ref_id)) {
            throw new ilPermissionException("Schedule pool id does not match pool id.");
        }

    }

Here is the call graph for this function:

Member Function Documentation

confirmDelete()

ilBookingScheduleGUI::confirmDelete

(

)

Confirm delete.

Definition at line 347 of file class.ilBookingScheduleGUI.php.

References $ctrl, $help, $lng, $tpl, $type, ilGlobalTemplateInterface\setContent(), ilHelpGUI\setSubScreenId(), and ilLanguage\txt().

                                   : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilHelp = $this->help;

        $ilHelp->setSubScreenId("delete");


        $conf = new ilConfirmationGUI();
        $conf->setFormAction($ilCtrl->getFormAction($this));
        $conf->setHeaderText($lng->txt('book_confirm_delete'));

        $type = new ilBookingSchedule($this->schedule_id);
        $conf->addItem('schedule_id', $this->schedule_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()

ilBookingScheduleGUI::create

(

)

Render creation form.

Definition at line 110 of file class.ilBookingScheduleGUI.php.

References $ctrl, $help, $lng, $tabs, $tpl, initForm(), ilGlobalTemplateInterface\setContent(), ilHelpGUI\setScreenIdComponent(), and ilLanguage\txt().

                            : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget($lng->txt('book_back_to_list'), $ilCtrl->getLinkTarget($this, 'render'));
        $ilHelp->setScreenIdComponent("book");
        $ilHelp->setScreenId("schedules");
        $ilHelp->setSubScreenId("create");

        $form = $this->initForm();
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

delete()

ilBookingScheduleGUI::delete

(

)

Delete schedule.

Definition at line 372 of file class.ilBookingScheduleGUI.php.

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

                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $obj = new ilBookingSchedule($this->schedule_id);
        $obj->delete();

        $this->tpl->setOnScreenMessage('success', $lng->txt('book_schedule_deleted'), true);
        $ilCtrl->redirect($this, 'render');
    }

Here is the call graph for this function:

edit()

ilBookingScheduleGUI::edit

(

)

Render edit form.

Definition at line 131 of file class.ilBookingScheduleGUI.php.

References $ctrl, $help, $lng, $tabs, $tpl, initForm(), ilGlobalTemplateInterface\setContent(), ilHelpGUI\setScreenIdComponent(), and ilLanguage\txt().

                          : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget($lng->txt('book_back_to_list'), $ilCtrl->getLinkTarget($this, 'render'));
        $ilHelp->setScreenIdComponent("book");
        $ilHelp->setScreenId("schedules");
        $ilHelp->setSubScreenId("edit");

        $form = $this->initForm('edit', $this->schedule_id);
        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilBookingScheduleGUI::executeCommand

(

)

Definition at line 63 of file class.ilBookingScheduleGUI.php.

References $ctrl, and ilCtrl\getNextClass().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass($this);

        switch ($next_class) {
            default:
                $cmd = $ilCtrl->getCmd("render");
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

formToObject()

ilBookingScheduleGUI::formToObject ( ilPropertyFormGUI  $form, ilBookingSchedule  $schedule  )

protected

Set form data into schedule object.

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

References $obj_data_cache, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilBookingSchedule\setAvailabilityFrom(), ilBookingSchedule\setAvailabilityTo(), ilBookingSchedule\setDeadline(), ilBookingSchedule\setDefinitionBySlots(), ilBookingSchedule\setPoolId(), and ilBookingSchedule\setTitle().

Referenced by save(), and update().

     : void {
        $ilObjDataCache = $this->obj_data_cache;

        $schedule->setTitle($form->getInput("title"));
        $schedule->setPoolId($ilObjDataCache->lookupObjId($this->ref_id));

        $from = $form->getItemByPostVar("from");
        if ($from !== null) {
            $schedule->setAvailabilityFrom($from->getDate());
        }

        $to = $form->getItemByPostVar("to");
        if ($to !== null) {
            $schedule->setAvailabilityTo($to->getDate());
        }

        switch ($form->getInput("deadline_opts")) {
            case "slot_start":
                $schedule->setDeadline(0);
                break;

            case "hours":
                $schedule->setDeadline($form->getInput("deadline"));
                break;

            case "slot_end":
                $schedule->setDeadline(-1);
                break;
        }

        /*
        if($form->getInput("type") == "flexible")
        {
            $schedule->setRaster($form->getInput("raster"));
            $schedule->setMinRental($form->getInput("rent_min"));
            $schedule->setMaxRental($form->getInput("rent_max"));
            $schedule->setAutoBreak($form->getInput("break"));
        }
        else
        {
            $schedule->setRaster(NULL);
            $schedule->setMinRental(NULL);
            $schedule->setMaxRental(NULL);
            $schedule->setAutoBreak(NULL);
        }
        */

        $days = $form->getInput("days");
        $schedule->setDefinitionBySlots($days);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

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

Build property form.

Definition at line 152 of file class.ilBookingScheduleGUI.php.

References $ctrl, $id, $lng, ilLanguage\loadLanguageModule(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilDateTimeInputGUI\setShowTime(), and ilLanguage\txt().

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

     : ilPropertyFormGUI {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $lng->loadLanguageModule("dateplaner");

        $form_gui = new ilPropertyFormGUI();

        $title = new ilTextInputGUI($lng->txt("title"), "title");
        $title->setRequired(true);
        $title->setSize(40);
        $title->setMaxLength(120);
        $form_gui->addItem($title);

        $definition = new ilScheduleInputGUI($lng->txt("book_schedule_days"), "days");
        $definition->setInfo($lng->txt("book_schedule_days_info"));
        $definition->setRequired(true);
        $form_gui->addItem($definition);

        $deadline_opts = new ilRadioGroupInputGUI($lng->txt("book_deadline_options"), "deadline_opts");
        $deadline_opts->setRequired(true);
        $form_gui->addItem($deadline_opts);

        $deadline_time = new ilRadioOption($lng->txt("book_deadline_hours"), "hours");
        $deadline_opts->addOption($deadline_time);

        $deadline = new ilNumberInputGUI($lng->txt("book_deadline"), "deadline");
        $deadline->setInfo($lng->txt("book_deadline_info"));
        $deadline->setSuffix($lng->txt("book_hours"));
        $deadline->setMinValue(1);
        $deadline->setSize(3);
        $deadline->setMaxLength(3);
        $deadline_time->addSubItem($deadline);

        $deadline_start = new ilRadioOption($lng->txt("book_deadline_slot_start"), "slot_start");
        $deadline_opts->addOption($deadline_start);

        $deadline_slot = new ilRadioOption($lng->txt("book_deadline_slot_end"), "slot_end");
        $deadline_opts->addOption($deadline_slot);

        if ($a_mode === "edit") {
            $schedule = new ilBookingSchedule($id);
        }

        $av = new ilFormSectionHeaderGUI();
        $av->setTitle($lng->txt("obj_activation_list_gui"));
        $form_gui->addItem($av);

        // #18221
        $lng->loadLanguageModule('rep');

        $from = new ilDateTimeInputGUI($lng->txt("rep_activation_limited_start"), "from");
        $from->setShowTime(true);
        $form_gui->addItem($from);

        $to = new ilDateTimeInputGUI($lng->txt("rep_activation_limited_end"), "to");
        $to->setShowTime(true);
        $form_gui->addItem($to);

        if ($a_mode === "edit") {
            $form_gui->setTitle($lng->txt("book_edit_schedule"));

            $item = new ilHiddenInputGUI('schedule_id');
            $item->setValue($id);
            $form_gui->addItem($item);

            $schedule = new ilBookingSchedule($id);
            $title->setValue($schedule->getTitle());
            $from->setDate($schedule->getAvailabilityFrom());
            $to->setDate($schedule->getAvailabilityTo());

            if ($schedule->getDeadline() === 0) {
                $deadline_opts->setValue("slot_start");
            } elseif ($schedule->getDeadline() > 0) {
                $deadline->setValue($schedule->getDeadline());
                $deadline_opts->setValue("hours");
            } else {
                $deadline->setValue(0);
                $deadline_opts->setValue("slot_end");
            }

            $definition->setValue($schedule->getDefinitionBySlots());

            $form_gui->addCommandButton("update", $lng->txt("save"));
        } else {
            $form_gui->setTitle($lng->txt("book_add_schedule"));
            $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:

render()

ilBookingScheduleGUI::render

(

)

Render list of booking schedules uses ilBookingSchedulesTableGUI.

Definition at line 81 of file class.ilBookingScheduleGUI.php.

References $access, Vendor\Package\$bar, $ctrl, $lng, $tpl, ilObject\_lookupObjId(), ilBookingObject\getList(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Referenced by save(), and update().

                            : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;

        $table = new ilBookingSchedulesTableGUI($this, 'render', $this->ref_id);

        $bar = "";
        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            // if we have schedules but no objects - show info
            if (count($table->getData())) {
                if (!count(ilBookingObject::getList(ilObject::_lookupObjId($this->ref_id)))) {
                    $this->tpl->setOnScreenMessage('info', $lng->txt("book_type_warning"));
                }
            }

            $bar = new ilToolbarGUI();
            $bar->addButton($lng->txt('book_add_schedule'), $ilCtrl->getLinkTarget($this, 'create'));
            $bar = $bar->getHTML();
        }

        $tpl->setContent($bar . $table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingScheduleGUI::save

(

)

Definition at line 249 of file class.ilBookingScheduleGUI.php.

References $lng, $tpl, formToObject(), initForm(), render(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                          : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;

        $form = $this->initForm();
        if ($form->checkInput()) {
            $obj = new ilBookingSchedule();
            $this->formToObject($form, $obj);
            $obj->save();

            $this->tpl->setOnScreenMessage('success', $lng->txt("book_schedule_added"));
            $this->render();
        } else {
            $form->setValuesByPost();
            $tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

update()

ilBookingScheduleGUI::update

(

)

Definition at line 268 of file class.ilBookingScheduleGUI.php.

References $lng, $tpl, formToObject(), initForm(), render(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                            : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;

        $form = $this->initForm('edit', $this->schedule_id);
        if ($form->checkInput()) {
            $obj = new ilBookingSchedule($this->schedule_id);
            $this->formToObject($form, $obj);
            $obj->update();

            $this->tpl->setOnScreenMessage('success', $lng->txt("book_schedule_updated"));
            $this->render();
        } else {
            $form->setValuesByPost();
            $tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilBookingScheduleGUI::$access

protected

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

Referenced by render().

$book_request

ILIAS BookingManager StandardGUIRequest ilBookingScheduleGUI::$book_request

protected

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

$ctrl

ilCtrl ilBookingScheduleGUI::$ctrl

protected

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

Referenced by confirmDelete(), create(), delete(), edit(), executeCommand(), initForm(), and render().

$help

ilHelpGUI ilBookingScheduleGUI::$help

protected

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

Referenced by confirmDelete(), create(), and edit().

$lng

ilLanguage ilBookingScheduleGUI::$lng

protected

Definition at line 31 of file class.ilBookingScheduleGUI.php.

Referenced by confirmDelete(), create(), delete(), edit(), initForm(), render(), save(), and update().

$obj_data_cache

ilObjectDataCache ilBookingScheduleGUI::$obj_data_cache

protected

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

Referenced by formToObject().

$ref_id

int ilBookingScheduleGUI::$ref_id

protected

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

$schedule_id

int ilBookingScheduleGUI::$schedule_id

protected

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

$tabs

ilTabsGUI ilBookingScheduleGUI::$tabs

protected

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

Referenced by create(), and edit().

$tpl

ilGlobalTemplateInterface ilBookingScheduleGUI::$tpl

protected

Definition at line 28 of file class.ilBookingScheduleGUI.php.

Referenced by confirmDelete(), create(), edit(), render(), save(), and update().

---

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

• Modules/BookingManager/Schedule/class.ilBookingScheduleGUI.php