class.ilPCSectionGUI.php

Go to the documentation of this file.

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

require_once("./Services/COPage/classes/class.ilPCSection.php");
require_once("./Services/COPage/classes/class.ilPageContentGUI.php");

class ilPCSectionGUI extends ilPageContentGUI
{

    public function __construct(&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id = "")
    {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        
        $this->setCharacteristics(ilPCSectionGUI::_getStandardCharacteristics());
    }

    public static function _getStandardCharacteristics()
    {
        global $DIC;

        $lng = $DIC->language();
        
        return array("Block" => $lng->txt("cont_Block"),
            "Mnemonic" => $lng->txt("cont_Mnemonic"),
            "Remark" => $lng->txt("cont_Remark"),
            "Example" => $lng->txt("cont_Example"),
            "Additional" => $lng->txt("cont_Additional"),
            "Special" => $lng->txt("cont_Special"),

            "Attention" => $lng->txt("cont_Attention"),
            "Background" => $lng->txt("cont_Background"),
            "Confirmation" => $lng->txt("cont_Confirmation"),
            "Information" => $lng->txt("cont_Information"),
            "Interaction" => $lng->txt("cont_Interaction"),
            "Link" => $lng->txt("cont_Link"),
            "Literature" => $lng->txt("cont_Literature"),
            "Separator" => $lng->txt("cont_Separator"),
            "StandardCenter" => $lng->txt("cont_StandardCenter"),

            "Excursus" => $lng->txt("cont_Excursus"),
            "AdvancedKnowledge" => $lng->txt("cont_AdvancedKnowledge"));
    }
    
    public static function _getCharacteristics($a_style_id)
    {
        $chars = ilPCSectionGUI::_getStandardCharacteristics();

        if ($a_style_id > 0 &&
            ilObject::_lookupType($a_style_id) == "sty") {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            $style = new ilObjStyleSheet($a_style_id);
            $chars = $style->getCharacteristics("section");
            $new_chars = array();
            foreach ($chars as $char) {
                if ($chars[$char] != "") {      // keep lang vars for standard chars
                    $new_chars[$char] = $chars[$char];
                } else {
                    $new_chars[$char] = $char;
                }
                asort($new_chars);
            }
            $chars = $new_chars;
        }
        return $chars;
    }

    public function executeCommand()
    {
        $this->getCharacteristicsOfCurrentStyle("section");     // scorm-2004
        
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            case "ilpropertyformgui":
                include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
                $form = $this->initForm(true);
                $this->ctrl->forwardCommand($form);
                break;

            default:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

    public function insert(ilPropertyFormGUI $a_form = null)
    {
        $this->edit(true, $a_form);
    }

    public function edit($a_insert = false, ilPropertyFormGUI $a_form = null)
    {
        $tpl = $this->tpl;
        
        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm($a_insert);
        }

        $tpl->setContent($a_form->getHTML());
    }

    public function initForm($a_insert = false)
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        // edit form
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_section"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_section"));
        }
        
        // characteristic selection
        require_once("./Services/Form/classes/class.ilAdvSelectInputGUI.php");
        $char_prop = new ilAdvSelectInputGUI(
            $this->lng->txt("cont_characteristic"),
            "characteristic"
        );
            
        $chars = $this->getCharacteristics();
        if (is_object($this->content_obj)) {
            if ($chars[$a_seleted_value] == "" && ($this->content_obj->getCharacteristic() != "")) {
                $chars = array_merge(
                    array($this->content_obj->getCharacteristic() => $this->content_obj->getCharacteristic()),
                    $chars
                );
            }
        }

        $selected = ($a_insert)
            ? "Block"
            : $this->content_obj->getCharacteristic();
            
        foreach ($chars as $k => $char) {
            $html = '<div class="ilCOPgEditStyleSelectionItem"><div class="ilc_section_' . $k . '" style="' . self::$style_selector_reset . '">' .
                $char . '</div></div>';
            $char_prop->addOption($k, $char, $html);
        }

        $char_prop->setValue($selected);
        $form->addItem($char_prop);

        // link input
        include_once 'Services/Form/classes/class.ilLinkInputGUI.php';
        $ac = new ilLinkInputGUI($this->lng->txt('cont_link'), 'link');
        if ($this->getPageConfig()->getEnableInternalLinks()) {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::BOTH);
        } else {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::EXT);
        }
        $ac->setRequired(false);
        $ac->setInfo($this->lng->txt("copg_sec_link_info"));
        $ac->setInternalLinkDefault(
            $this->getPageConfig()->getIntLinkHelpDefaultType(),
            $this->getPageConfig()->getIntLinkHelpDefaultId()
        );
        $link_types = array();
        foreach ($this->getPageConfig()->getIntLinkFilters() as $f) {
            $link_types[] = $f;
        }
        $ac->setInternalLinkFilterTypes($link_types);
        $ac->setFilterWhiteList(
            $this->getPageConfig()->getIntLinkFilterWhiteList()
        );

        if (!$a_insert) {
            $l = $this->content_obj->getLink();
            if ($l["LinkType"] == "IntLink") {
                $ac->setValueByIntLinkAttributes($l["Type"], $l["Target"], $l["TargetFrame"]);
            }
            if ($l["LinkType"] == "ExtLink") {
                $ac->setValue($l["Href"]);
            }
        }
        $form->addItem($ac);

        // activation

        // active from
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_from"), "active_from");
        if (!$a_insert && ($from = $this->content_obj->getActiveFrom()) != "") {
            $dt_prop->setDate(new ilDateTime($from, IL_CAL_UNIX));
        }
        $dt_prop->setShowTime(true);
        $form->addItem($dt_prop);

        // active to
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_to"), "active_to");
        if (!$a_insert && ($to = $this->content_obj->getActiveTo()) != "") {
            $dt_prop->setDate(new ilDateTime($to, IL_CAL_UNIX));
        }
        $dt_prop->setShowTime(true);
        $form->addItem($dt_prop);

        // rep selector
        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            include_once("./Services/Form/classes/class.ilRepositorySelector2InputGUI.php");
            $rs = new ilRepositorySelector2InputGUI($lng->txt("cont_permission_object"), "permission_ref_id");
            $rs->setParent($this);
            $form->addItem($rs);

            // permission
            $options = array(
                "read" => $lng->txt("read"),
                "write" => $lng->txt("write"),
                "visible" => $lng->txt("visible"),
                "no_read" => $lng->txt("cont_no_read")
            );
            $si = new ilSelectInputGUI($lng->txt("permission"), "permission");
            $si->setInfo($lng->txt("cont_permission_object_desc"));
            $si->setOptions($options);
            $form->addItem($si);

            if (!$a_insert) {
                $si->setValue($this->content_obj->getPermission());
                $rs->setValue($this->content_obj->getPermissionRefId());
            }
        }

        // save/cancel buttons
        if ($a_insert) {
            $form->addCommandButton("create_section", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $form->addCommandButton("update", $lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
        return $form;
    }


    public function create()
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $this->content_obj = new ilPCSection($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);

            $this->setValuesFromForm($form);

            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        
        $this->insert($form);
    }

    public function update()
    {
        $form = $this->initForm(false);
        if ($form->checkInput()) {
            $this->setValuesFromForm($form);

            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        
        $this->pg_obj->addHierIDs();
        $this->edit(false, $form);
    }

    public function setValuesFromForm($form)
    {
        $this->content_obj->setCharacteristic($_POST["characteristic"]);

        $from = $form->getItemByPostVar("active_from")->getDate();
        if ($from) {
            $this->content_obj->setActiveFrom($from->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveFrom(0);
        }

        $to = $form->getItemByPostVar("active_to")->getDate();
        if ($to) {
            $this->content_obj->setActiveTo($to->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveTo(0);
        }

        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            $this->content_obj->setPermissionRefId($_POST["permission_ref_id"]);
            $this->content_obj->setPermission($_POST["permission"]);
        }

        if ($_POST["link_mode"] == "ext" && $_POST["link"] != "") {
            $this->content_obj->setExtLink($_POST["link"]);
        } elseif ($_POST["link_mode"] == "int" && $_POST["link"] != "") {
            // $_POST["link"] is "crs|96", "chap|2", "term|1", "wpage|1"
            //                  var_dump($_POST);
            $la = $form->getItemByPostVar("link")->getIntLinkAttributes();
            //                  echo "<br>";
            //                  var_dump($la); exit;
            if ($la["Type"] != "") {
                $this->content_obj->setIntLink($la["Type"], $la["Target"], $la["TargetFrame"]);
            }
        } else {
            $this->content_obj->setNoLink();
        }
    }
}