ilBookingScheduleGUI Class Reference

Class ilBookingScheduleGUI. More...

Collaboration diagram for ilBookingScheduleGUI:

Public Member Functions
	__construct ($a_parent_obj)
	Constructor. More...
	executeCommand ()
	main switch More...
	render ()
	Render list of booking schedules. More...
	create ()
	Render creation form. More...
	edit ()
	Render edit form. More...
	initForm ($a_mode="create", $id=null)
	Build property form. More...
	save ()
	Create new dataset. More...
	update ()
	Update dataset. More...
	confirmDelete ()
	Confirm delete. More...
	delete ()
	Delete schedule. More...

Protected Member Functions
	setDefinitionFromPost (ilPropertyFormGUI $form)
	Reload definition values from post data. More...
	formToObject ($form, $schedule)
	Convert incoming form data to schedule object. More...

Protected Attributes
	$tpl
	$tabs
	$ctrl
	$lng
	$access
	$help
	$obj_data_cache

Detailed Description

Class ilBookingScheduleGUI.

Author

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

Version

$Id$

@ilCtrl_Calls ilBookingScheduleGUI:

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

Constructor & Destructor Documentation

__construct()

ilBookingScheduleGUI::__construct

(

$a_parent_obj

)

Constructor.

Parameters

object

$a_parent_obj

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

    {
        global $DIC;
 
        $this->tpl = $DIC["tpl"];
        $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->ref_id;
    }

References $DIC.

Member Function Documentation

confirmDelete()

ilBookingScheduleGUI::confirmDelete

(

)

Confirm delete.

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilHelp = $this->help;
 
        $ilHelp->setSubScreenId("delete");
 
 
        include_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $conf = new ilConfirmationGUI();
        $conf->setFormAction($ilCtrl->getFormAction($this));
        $conf->setHeaderText($lng->txt('book_confirm_delete'));
 
        include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
        $type = new ilBookingSchedule((int) $_GET['schedule_id']);
        $conf->addItem('schedule_id', (int) $_GET['schedule_id'], $type->getTitle());
        $conf->setConfirm($lng->txt('delete'), 'delete');
        $conf->setCancel($lng->txt('cancel'), 'render');
 
        $tpl->setContent($conf->getHTML());
    }

References $_GET, $ctrl, $help, $ilCtrl, $lng, $tabs, $tpl, and $type.

create()

ilBookingScheduleGUI::create

(

)

Render creation form.

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

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

References $ctrl, $form, $help, $ilCtrl, $lng, $tabs, $tpl, and initForm().

Here is the call graph for this function:

delete()

ilBookingScheduleGUI::delete

(

)

Delete schedule.

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
        $obj = new ilBookingSchedule((int) $_POST['schedule_id']);
        $obj->delete();
 
        ilUtil::sendSuccess($lng->txt('book_schedule_deleted'), true);
        $ilCtrl->redirect($this, 'render');
    }

References $_POST, $ctrl, $ilCtrl, $lng, and ilUtil\sendSuccess().

Here is the call graph for this function:

edit()

ilBookingScheduleGUI::edit

(

)

Render edit form.

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

    {
        $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', (int) $_GET['schedule_id']);
        $tpl->setContent($form->getHTML());
    }

References $_GET, $ctrl, $form, $help, $ilCtrl, $lng, $tabs, $tpl, and initForm().

Here is the call graph for this function:

executeCommand()

ilBookingScheduleGUI::executeCommand

(

)

main switch

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

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass($this);
 
        switch ($next_class) {
            default:
                $cmd = $ilCtrl->getCmd("render");
                $this->$cmd();
                break;
        }
        return true;
    }

References $ctrl, $ilCtrl, $tabs, and $tpl.

formToObject()

ilBookingScheduleGUI::formToObject (   $form,   $schedule  )

protected

Convert incoming form data to schedule object.

Parameters

object	$form
object	$schedule

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

    {
        $ilObjDataCache = $this->obj_data_cache;
        
        $schedule->setTitle($form->getInput("title"));
        $schedule->setPoolId($ilObjDataCache->lookupObjId($this->ref_id));
        
        $from = $form->getItemByPostVar("from");
        $schedule->setAvailabilityFrom($from->getDate());
        
        $to = $form->getItemByPostVar("to");
        $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);
        }
        */
        
        $schedule->setDefinitionBySlots(ilScheduleInputGUI::getPostData("days"));
    }

References $form, $from, $obj_data_cache, and ilScheduleInputGUI\getPostData().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

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

Build property form.

Parameters

string	$a_mode
int	$id

Returns

object

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $lng->loadLanguageModule("dateplaner");
 
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
 
        $form_gui = new ilPropertyFormGUI();
 
        $title = new ilTextInputGUI($lng->txt("title"), "title");
        $title->setRequired(true);
        $title->setSize(40);
        $title->setMaxLength(120);
        $form_gui->addItem($title);
 
        include_once "Modules/BookingManager/classes/class.ilScheduleInputGUI.php";
        $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") {
            include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
            $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);
 
            include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
            $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");
            }
 
            /*
            if($schedule->getRaster())
            {
                $type->setValue("flexible");
                $raster->setValue($schedule->getRaster());
                $rent_min->setValue($schedule->getMinRental());
                $rent_max->setValue($schedule->getMaxRental());
                $break->setValue($schedule->getAutoBreak());
            }
            else
            {
                $type->setValue("fix");
            }
            */
 
            $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;
    }

References $ctrl, $from, $id, $ilCtrl, $lng, and $title.

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

Here is the caller graph for this function:

render()

ilBookingScheduleGUI::render

(

)

Render list of booking schedules.

uses ilBookingSchedulesTableGUI

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

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
 
        include_once 'Modules/BookingManager/classes/class.ilBookingSchedulesTableGUI.php';
        $table = new ilBookingSchedulesTableGUI($this, 'render', $this->ref_id);
        
        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            // if we have schedules but no objects - show info
            if (sizeof($table->getData())) {
                include_once "Modules/BookingManager/classes/class.ilBookingObject.php";
                if (!sizeof(ilBookingObject::getList(ilObject::_lookupObjId($this->ref_id)))) {
                    ilUtil::sendInfo($lng->txt("book_type_warning"));
                }
            }
            
            include_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
            $bar = new ilToolbarGUI;
            $bar->addButton($lng->txt('book_add_schedule'), $ilCtrl->getLinkTarget($this, 'create'));
            $bar = $bar->getHTML();
        }
        
        $tpl->setContent($bar . $table->getHTML());
    }

References $access, $ctrl, $ilCtrl, $lng, $table, $tpl, ilObject\_lookupObjId(), ilToolbarGUI\addButton(), ilBookingObject\getList(), and ilUtil\sendInfo().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingScheduleGUI::save

(

)

Create new dataset.

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

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $form = $this->initForm();
        if ($form->checkInput()) {
            include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
            $obj = new ilBookingSchedule;
            $this->formToObject($form, $obj);
            $obj->save();
 
            ilUtil::sendSuccess($lng->txt("book_schedule_added"));
            $this->render();
        } else {
            $form->setValuesByPost();
            $this->setDefinitionFromPost($form);
            $tpl->setContent($form->getHTML());
        }
    }

References $form, $lng, $tpl, formToObject(), initForm(), render(), ilUtil\sendSuccess(), and setDefinitionFromPost().

Here is the call graph for this function:

setDefinitionFromPost()

ilBookingScheduleGUI::setDefinitionFromPost ( ilPropertyFormGUI  $form )

protected

Reload definition values from post data.

Parameters

ilPropertyFormGUI

$form

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

    {
        $days = $form->getInput("days");
        if ($days) {
            $days_group = $form->getItemByPostVar("days");
            foreach ($days_group->getOptions() as $option) {
                $days_fields[$option->getValue()] = $option;
            }
            
            foreach ($days as $day) {
                $slot = $form->getInput($day . "_slot");
                $subs = $days_fields[$day]->getSubItems();
                if ($slot[0]) {
                    $subs[0]->setValue($slot[0]);
                }
                if ($slot[1]) {
                    $subs[1]->setValue($slot[1]);
                }
            }
        }
    }

References $form.

Referenced by save(), and update().

Here is the caller graph for this function:

update()

ilBookingScheduleGUI::update

(

)

Update dataset.

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

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $form = $this->initForm('edit', (int) $_POST['schedule_id']);
        if ($form->checkInput()) {
            include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
            $obj = new ilBookingSchedule((int) $_POST['schedule_id']);
            $this->formToObject($form, $obj);
            $obj->update();
 
            ilUtil::sendSuccess($lng->txt("book_schedule_updated"));
            $this->render();
        } else {
            $form->setValuesByPost();
            $this->setDefinitionFromPost($form);
            $tpl->setContent($form->getHTML());
        }
    }

References $_POST, $form, $lng, $tpl, formToObject(), initForm(), render(), ilUtil\sendSuccess(), and setDefinitionFromPost().

Here is the call graph for this function:

Field Documentation

$access

ilBookingScheduleGUI::$access

protected

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

Referenced by render().

$ctrl

ilBookingScheduleGUI::$ctrl

protected

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

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

$help

ilBookingScheduleGUI::$help

protected

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

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

$lng

ilBookingScheduleGUI::$lng

protected

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

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

$obj_data_cache

ilBookingScheduleGUI::$obj_data_cache

protected

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

Referenced by formToObject().

$tabs

ilBookingScheduleGUI::$tabs

protected

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

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

$tpl

ilBookingScheduleGUI::$tpl

protected

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

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

---

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

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