class.ilBookingObjectGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "./Services/Object/classes/class.ilObjectGUI.php";

class ilBookingObjectGUI
{
    protected $ctrl;

    protected $tpl;

    protected $lng;

    protected $access;

    protected $tabs;

    protected $help;

    protected $obj_data_cache;

    protected $user;

    protected $ref_id; // [int]
    protected $pool_id; // [int]
    protected $pool_has_schedule; // [bool]
    protected $pool_overall_limit; // [int]
    protected $user_to_deasign;
    protected $object_id;

    public function __construct($a_parent_obj)
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->tabs = $DIC->tabs();
        $this->help = $DIC["ilHelp"];
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->user = $DIC->user();
        $this->ref_id = $a_parent_obj->ref_id;
        $this->pool_id = $a_parent_obj->object->getId();
        $this->pool_gui = $a_parent_obj;
        $this->pool_has_schedule =
            ($a_parent_obj->object->getScheduleType() != ilObjBookingPool::TYPE_NO_SCHEDULE);
        $this->pool_overall_limit = $this->pool_has_schedule
            ? null
            : $a_parent_obj->object->getOverallLimit();

        $this->object_id = (int) $_REQUEST['object_id'];
        $this->user_to_deasign = (int) $_REQUEST['bkusr'];
        $this->rsv_ids = array_map('intval', explode(";", $_GET["rsv_ids"]));
    }

    public function executeCommand()
    {
        $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;

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

    public function render()
    {
        $this->pool_gui->showNoScheduleMessage();

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

        if ($ilAccess->checkAccess('write', '', $this->ref_id)) {
            include_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
            $bar = new ilToolbarGUI;
            $bar->addButton($lng->txt('book_add_object'), $ilCtrl->getLinkTarget($this, 'create'));
            $bar = $bar->getHTML();
        }
        
        $tpl->setPermanentLink('book', $this->ref_id);
        
        include_once 'Modules/BookingManager/classes/class.ilBookingObjectsTableGUI.php';
        $table = new ilBookingObjectsTableGUI($this, 'render', $this->ref_id, $this->pool_id, $this->pool_has_schedule, $this->pool_overall_limit);
        $tpl->setContent($bar . $table->getHTML());
    }
    
    public function applyFilter()
    {
        include_once 'Modules/BookingManager/classes/class.ilBookingObjectsTableGUI.php';
        $table = new ilBookingObjectsTableGUI($this, 'render', $this->ref_id, $this->pool_id, $this->pool_has_schedule, $this->pool_overall_limit, $this->repo_parent, $this->repo_parent_call);
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->render();
    }
    
    public function resetFilter()
    {
        include_once 'Modules/BookingManager/classes/class.ilBookingObjectsTableGUI.php';
        $table = new ilBookingObjectsTableGUI($this, 'render', $this->ref_id, $this->pool_id, $this->pool_has_schedule, $this->pool_overall_limit, $this->repo_parent, $this->repo_parent_call);
        $table->resetOffset();
        $table->resetFilter();
        $this->render();
    }

    public function create(ilPropertyFormGUI $a_form = null)
    {
        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());
    }

    public function edit(ilPropertyFormGUI $a_form = null)
    {
        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());
    }
    
    protected function setHelpId($a_id)
    {
        $ilHelp = $this->help;
        
        $object_subtype = $this->pool_has_schedule
            ? '-schedule'
            : '-nonschedule';
        
        $ilHelp->setScreenIdComponent('book');
        $ilHelp->setScreenId('object' . $object_subtype);
        $ilHelp->setSubScreenId($a_id);
    }

    public function initForm($a_mode = "create", $id = null)
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilObjDataCache = $this->obj_data_cache;

        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);
        
        $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->pool_has_schedule) {
            $options = array();
            include_once 'Modules/BookingManager/classes/class.ilBookingSchedule.php';
            foreach (ilBookingSchedule::getList($ilObjDataCache->lookupObjId($this->ref_id)) 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
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
        $this->record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR, "book", $this->pool_id, "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);

            include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
            $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;
    }

    public function save()
    {
        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) {
                include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
                $obj = new ilBookingObject;
                $obj->setPoolId($this->pool_id);
                $obj->setTitle($form->getInput("title"));
                $obj->setDescription($form->getInput("desc"));
                $obj->setNrOfItems($form->getInput("items"));
                $obj->setPostText($form->getInput("post_text"));

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

    public function update()
    {
        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) {
                include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
                $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->pool_has_schedule) {
                    $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);
    }

    public function confirmDelete()
    {
        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'));

        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.ilBookingObject.php';
        $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());
    }

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

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

        include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
        $obj = new ilBookingObject($this->object_id);
        $obj->delete();

        ilUtil::sendSuccess($lng->txt('book_object_deleted'), true);
        $ilCtrl->redirect($this, 'render');
    }
        
    public function rsvConfirmCancelUser()
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        
        $id = $this->object_id;
        if (!$id) {
            return;
        }
        
        $this->setHelpId("cancel_booking");
        
        include_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $conf = new ilConfirmationGUI();
        $conf->setFormAction($ilCtrl->getFormAction($this));
        $conf->setHeaderText($lng->txt('book_confirm_cancel'));

        include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
        $type = new ilBookingObject($id);
        $conf->addItem('object_id', $id, $type->getTitle());
        if ($this->user_to_deasign) {
            $conf->addHiddenItem('bkusr', $this->user_to_deasign);
        }
        if ($_GET['part_view'] == ilBookingParticipantGUI::PARTICIPANT_VIEW) {
            $conf->addHiddenItem('part_view', ilBookingParticipantGUI::PARTICIPANT_VIEW);
        }
        $conf->setConfirm($lng->txt('book_set_cancel'), 'rsvCancelUser');
        $conf->setCancel($lng->txt('cancel'), 'render');

        $tpl->setContent($conf->getHTML());
    }
    
    public function rsvCancelUser()
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        if ($this->user_to_deasign) {
            $user_id = $this->user_to_deasign;
        } else {
            $user_id = $this->user->getId();
        }

        $id = $this->object_id;
        if (!$id || !$user_id) {
            return;
        }
        
        include_once 'Modules/BookingManager/classes/class.ilBookingReservation.php';
        $id = ilBookingReservation::getObjectReservationForUser($id, $user_id);
        $obj = new ilBookingReservation($id);
        if ($obj->getUserId() != $user_id) {
            ilUtil::sendFailure($lng->txt('permission_denied'), true);
            $ilCtrl->redirect($this, 'render');
        }

        $obj->setStatus(ilBookingReservation::STATUS_CANCELLED);
        $obj->update();

        ilUtil::sendSuccess($lng->txt('settings_saved'));
        if ($_POST['part_view'] == ilBookingParticipantGUI::PARTICIPANT_VIEW) {
            $this->ctrl->redirectByClass('ilbookingparticipantgui', 'render');
        } else {
            $ilCtrl->redirect($this, 'render');
        }
    }
    
    public function deliverInfo()
    {
        $id = $this->object_id;
        if (!$id) {
            return;
        }
        
        include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
        $obj = new ilBookingObject($id);
        $file = $obj->getFileFullPath();
        if ($file) {
            ilUtil::deliverFile($file, $obj->getFile());
        }
    }
    
    public function displayPostInfo()
    {
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $id = $this->object_id;
        if (!$id) {
            return;
        }
        
        
        // placeholder
        
        include_once 'Modules/BookingManager/classes/class.ilBookingReservation.php';
        $book_ids = ilBookingReservation::getObjectReservationForUser($id, $ilUser->getId(), true);
        $tmp = array();
        foreach ($book_ids as $book_id) {
            if (in_array($book_id, $this->rsv_ids)) {
                $obj = new ilBookingReservation($book_id);
                $from = $obj->getFrom();
                $to = $obj->getTo();
                if ($from > time()) {
                    $tmp[$from . "-" . $to]++;
                }
            }
        }
        
        $olddt = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        
        $period = array();
        ksort($tmp);
        foreach ($tmp as $time => $counter) {
            $time = explode("-", $time);
            $time = ilDatePresentation::formatPeriod(
                new ilDateTime($time[0], IL_CAL_UNIX),
                new ilDateTime($time[1], IL_CAL_UNIX)
            );
            if ($counter > 1) {
                $time .= " (" . $counter . ")";
            }
            $period[] = $time;
        }
        $book_id = array_shift($book_ids);
        
        ilDatePresentation::setUseRelativeDates($olddt);
        

        /*
        #23578 since Booking pool participants.
        $obj = new ilBookingReservation($book_id);
        if ($obj->getUserId() != $ilUser->getId())
        {
            return;
        }
        */

        include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
        $obj = new ilBookingObject($id);
        $pfile = $obj->getPostFile();
        $ptext = $obj->getPostText();
        
        $mytpl = new ilTemplate('tpl.booking_reservation_post.html', true, true, 'Modules/BookingManager');
        $mytpl->setVariable("TITLE", $lng->txt('book_post_booking_information'));

        if ($ptext) {
            // placeholder
            $ptext = str_replace("[OBJECT]", $obj->getTitle(), $ptext);
            $ptext = str_replace("[PERIOD]", implode("<br />", $period), $ptext);
            
            $mytpl->setVariable("POST_TEXT", nl2br($ptext));
        }

        if ($pfile) {
            $ilCtrl->setParameter($this, "object_id", $obj->getId());
            $url = $ilCtrl->getLinkTarget($this, 'deliverPostFile');
            $ilCtrl->setParameter($this, "object_id", "");

            $mytpl->setVariable("DOWNLOAD", $lng->txt('download'));
            $mytpl->setVariable("URL_FILE", $url);
            $mytpl->setVariable("TXT_FILE", $pfile);
        }

        $mytpl->setVariable("TXT_SUBMIT", $lng->txt('ok'));
        $mytpl->setVariable("URL_SUBMIT", $ilCtrl->getLinkTargetByClass('ilobjbookingpoolgui', 'render'));

        $tpl->setContent($mytpl->get());
    }
    
    public function deliverPostFile()
    {
        $ilUser = $this->user;
        
        $id = $this->object_id;
        if (!$id) {
            return;
        }
        
        include_once 'Modules/BookingManager/classes/class.ilBookingReservation.php';
        $book_id = ilBookingReservation::getObjectReservationForUser($id, $ilUser->getId());
        $obj = new ilBookingReservation($book_id);
        if ($obj->getUserId() != $ilUser->getId()) {
            return;
        }
        
        include_once 'Modules/BookingManager/classes/class.ilBookingObject.php';
        $obj = new ilBookingObject($id);
        $file = $obj->getPostFileFullPath();
        if ($file) {
            ilUtil::deliverFile($file, $obj->getPostFile());
        }
    }

    //Table to assing participants to an object.
    //Todo move to a complete GUI class
    public function assignParticipants()
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget($this->lng->txt('book_back_to_list'), $this->ctrl->getLinkTarget($this, 'render'));

        include_once("./Modules/BookingManager/classes/class.ilBookingAssignParticipantsTableGUI.php");
        $table = new ilBookingAssignParticipantsTableGUI($this, 'assignParticipants', $this->ref_id, $this->pool_id, $this->object_id);

        $this->tpl->setContent($table->getHTML());
    }
}