ilBookingObjectGUI Class Reference

Class ilBookingObjectGUI. More...

Inheritance diagram for ilBookingObjectGUI:

Collaboration diagram for ilBookingObjectGUI:

Public Member Functions
	activateManagement ($a_val)
	Activate management. More...
	isManagementActivated ()
	Is management activated? More...
	executeCommand ()
	render ()
	Render list of booking objects. More...
	applyFilter ()
	resetFilter ()
	create (ilPropertyFormGUI $a_form=null)
	Render creation form. More...
	edit (ilPropertyFormGUI $a_form=null)
	Render edit form. More...
	initForm ($a_mode="create", $id=null)
	Build property form. More...
	save ()
	Create new object dataset. More...
	update ()
	Update object dataset. More...
	confirmDelete ()
	Confirm delete. More...
	delete ()
	Delete object. More...
	deliverInfo ()

Protected Member Functions
	getPoolRefId ()
	Get ref id of booking pool. More...
	getPoolObjId ()
	Get obj id of booking pool. More...
	hasPoolSchedule ()
	Has booking pool a schedule? More...
	getPoolOverallLimit ()
	Get booking pool overall limit. More...
	showNoScheduleMessage ()
	Show no schedule message. More...
	returnToPreferences ()
	Return to preferences. More...
	setHelpId ($a_id)

Protected Attributes
	$ctrl
	$tpl
	$lng
	$access
	$tabs
	$help
	$obj_data_cache
	$user
	$pool_has_schedule
	$pool_overall_limit
	$pool_uses_preferences = false
	$management = true
	$context_obj_id
	$object_id

Detailed Description

Class ilBookingObjectGUI.

Author

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

Version

$Id$ ilBookingObjectGUI: ilPropertyFormGUI, ilBookingProcessGUI

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

Member Function Documentation

activateManagement()

ilBookingObjectGUI::activateManagement

(

$a_val

)

Activate management.

Parameters

bool

$a_val

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

Referenced by ilBookingObjectServiceGUI\__construct().

    {
        $this->management = $a_val;
    }

Here is the caller graph for this function:

applyFilter()

ilBookingObjectGUI::applyFilter

(

)

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

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

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

(

)

Confirm delete.

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

References $ctrl, $lng, $tabs, $tpl, and $type.

    {
        if (!$this->access->checkAccess('write', '', $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());
    }

create()

ilBookingObjectGUI::create

(

ilPropertyFormGUI

$a_form = null

)

Render creation form.

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

References $ctrl, $lng, $tabs, $tpl, initForm(), and setHelpId().

Referenced by save().

    {
        if (!$this->access->checkAccess('write', '', $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

(

)

Delete object.

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

References $ctrl, and $lng.

    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            return;
        }

        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $obj = new ilBookingObject($this->object_id);
        $obj->delete();

        ilUtil::sendSuccess($lng->txt('book_object_deleted'), true);
        $ilCtrl->setParameter($this, 'object_id', "");
        $ilCtrl->redirect($this, 'render');
    }

deliverInfo()

ilBookingObjectGUI::deliverInfo

(

)

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

References $object_id, and ilUtil\deliverFile().

    {
        $id = $this->object_id;
        if (!$id) {
            return;
        }
        
        $obj = new ilBookingObject($id);
        $file = $obj->getFileFullPath();
        if ($file) {
            ilUtil::deliverFile($file, $obj->getFile());
        }
    }

Here is the call graph for this function:

edit()

ilBookingObjectGUI::edit

(

ilPropertyFormGUI

$a_form = null

)

Render edit form.

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

References $ctrl, $lng, $tabs, $tpl, initForm(), and setHelpId().

Referenced by update().

    {
        if (!$this->access->checkAccess('write', '', $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:

executeCommand()

ilBookingObjectGUI::executeCommand

(

)

Returns

bool

Exceptions

ilCtrlException

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

References $ctrl, and initForm().

    {
        $ilCtrl = $this->ctrl;
                
        $next_class = $ilCtrl->getNextClass($this);
        
        switch ($next_class) {

            case "ilpropertyformgui":
                // only case is currently adv metadata internal link in info settings, see #24497
                $form = $this->initForm();
                $this->ctrl->forwardCommand($form);
                break;

            case "ilbookingprocessgui":
                if (!$this->pool_uses_preferences) {
                    $ilCtrl->setReturn($this, "render");
                } else {
                    $ilCtrl->setReturn($this, "returnToPreferences");
                }
                $process_gui = new ilBookingProcessGUI(
                    $this->pool_gui->object,
                    $this->object_id,
                    $this->help,
                    $this->seed,
                    $this->sseed,
                    $this->context_obj_id
                );
                $this->ctrl->forwardCommand($process_gui);
                break;

            default:
                $cmd = $ilCtrl->getCmd("render");
                $this->$cmd();
                break;
        }
        return true;
    }

Here is the call graph for this function:

getPoolObjId()

ilBookingObjectGUI::getPoolObjId ( )

protected

Get obj id of booking pool.

Returns

int

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

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

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

Here is the caller graph for this function:

getPoolOverallLimit()

ilBookingObjectGUI::getPoolOverallLimit ( )

protected

Get booking pool overall limit.

Returns

int

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

References hasPoolSchedule().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPoolRefId()

ilBookingObjectGUI::getPoolRefId ( )

protected

Get ref id of booking pool.

Returns

int

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

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

                                      : int
    {
        return $this->pool_gui->ref_id;
    }

Here is the caller graph for this function:

hasPoolSchedule()

ilBookingObjectGUI::hasPoolSchedule ( )

protected

Has booking pool a schedule?

Returns

bool

Definition at line 163 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->object->getScheduleType() == ilObjBookingPool::TYPE_FIX_SCHEDULE);
    }

Here is the caller graph for this function:

initForm()

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

Build property form.

Parameters

string	$a_mode
int	$id

Returns

object

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

References $ctrl, $lng, $obj_data_cache, ilBookingSchedule\getList(), getPoolObjId(), hasPoolSchedule(), ilAdvancedMDRecordGUI\MODE_EDITOR, ilFileInputGUI\setALlowDeletion(), ilTextAreaInputGUI\setCols(), and ilFormPropertyGUI\setRequired().

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

    {
        $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);
        $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);
        $form_gui->addItem($nr);
        
        if ($this->hasPoolSchedule()) {
            $options = array();
            foreach (ilBookingSchedule::getList($ilObjDataCache->lookupObjId($this->getPoolRefId())) as $schedule) {
                $options[$schedule["booking_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", $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($obj->getFile());
            $pfile->setValue($obj->getPostFile());
            
            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?

Returns

bool

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

References $management.

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

    {
        return $this->management;
    }

Here is the caller graph for this function:

render()

ilBookingObjectGUI::render

(

)

Render list of booking objects.

uses ilBookingObjectsTableGUI

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

References $access, Vendor\Package\$bar, $ctrl, $lng, $tpl, getPoolObjId(), getPoolOverallLimit(), getPoolRefId(), hasPoolSchedule(), isManagementActivated(), and showNoScheduleMessage().

Referenced by applyFilter(), and resetFilter().

    {
        $this->showNoScheduleMessage();

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

        if ($this->isManagementActivated() && $ilAccess->checkAccess('write', '', $this->getPoolRefId())) {
            $bar = new ilToolbarGUI;
            $bar->addButton($lng->txt('book_add_object'), $ilCtrl->getLinkTarget($this, 'create'));
            $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 273 of file class.ilBookingObjectGUI.php.

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

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

Return to preferences.

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

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

save()

ilBookingObjectGUI::save

(

)

Create new object dataset.

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

References $ctrl, $lng, $valid, create(), getPoolObjId(), hasPoolSchedule(), initForm(), and ilBookingObject\setPoolId().

    {
        if (!$this->access->checkAccess('write', '', $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"]) {
                    $obj->uploadFile($_FILES["file"]);
                } elseif ($file->getDeletionFlag()) {
                    $obj->deleteFile();
                }

                $pfile = $form->getItemByPostVar("post_file");
                if ($_FILES["post_file"]["tmp_name"]) {
                    $obj->uploadPostFile($_FILES["post_file"]);
                } elseif ($pfile->getDeletionFlag()) {
                    $obj->deletePostFile();
                }

                $obj->update();
                
                if ($this->record_gui) {
                    $this->record_gui->writeEditForm(null, $obj->getId());
                }

                ilUtil::sendSuccess($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 (   $a_id )

protected

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

References help().

Referenced by create(), and edit().

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

Show no schedule message.

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

Referenced by render().

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

Here is the caller graph for this function:

update()

ilBookingObjectGUI::update

(

)

Update object dataset.

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

References $ctrl, $lng, $valid, edit(), hasPoolSchedule(), and initForm().

    {
        if (!$this->access->checkAccess('write', '', $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"]) {
                    $obj->uploadFile($_FILES["file"]);
                } elseif ($file->getDeletionFlag()) {
                    $obj->deleteFile();
                }

                $pfile = $form->getItemByPostVar("post_file");
                if ($_FILES["post_file"]["tmp_name"]) {
                    $obj->uploadPostFile($_FILES["post_file"]);
                } elseif ($pfile->getDeletionFlag()) {
                    $obj->deletePostFile();
                }

                if ($this->hasPoolSchedule()) {
                    $obj->setScheduleId($form->getInput("schedule"));
                }

                $obj->update();
                
                if ($this->record_gui) {
                    $this->record_gui->writeEditForm();
                }

                ilUtil::sendSuccess($lng->txt("book_object_updated"), true);
                $ilCtrl->redirect($this, "render");
            }
        }
        
        $form->setValuesByPost();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$access

ilBookingObjectGUI::$access

protected

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

Referenced by render().

$context_obj_id

ilBookingObjectGUI::$context_obj_id

protected

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

$ctrl

ilBookingObjectGUI::$ctrl

protected

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

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

$help

ilBookingObjectGUI::$help

protected

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

$lng

ilBookingObjectGUI::$lng

protected

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

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

$management

ilBookingObjectGUI::$management = true

protected

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

Referenced by isManagementActivated().

$obj_data_cache

ilBookingObjectGUI::$obj_data_cache

protected

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

Referenced by initForm().

$object_id

ilBookingObjectGUI::$object_id

protected

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

Referenced by deliverInfo().

$pool_has_schedule

ilBookingObjectGUI::$pool_has_schedule

protected

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

$pool_overall_limit

ilBookingObjectGUI::$pool_overall_limit

protected

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

$pool_uses_preferences

ilBookingObjectGUI::$pool_uses_preferences = false

protected

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

$tabs

ilBookingObjectGUI::$tabs

protected

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

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

$tpl

ilBookingObjectGUI::$tpl

protected

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

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

$user

ilBookingObjectGUI::$user

protected

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

---

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

• Modules/BookingManager/Objects/classes/class.ilBookingObjectGUI.php