ilLMPageObjectGUI Class Reference

Class ilLMPageObjectGUI. More...

Inheritance diagram for ilLMPageObjectGUI:

Collaboration diagram for ilLMPageObjectGUI:

Public Member Functions
	ilLMPageObjectGUI (&$a_content_obj)
	Constructor. More...
	setLMPageObject ($a_pg_obj)
	Set content object dependent page object (co page) More...
&	executeCommand ()
	execute command More...
	edit ()
	preview ()
	save ()
	save co page object More...
	cancel ()
	cancel More...
	getLinkXML ($a_int_links)
	get link targets More...
	updateHistory ()
	update history More...
	editLayout ()
	Edit layout of page. More...
	initEditLayoutForm ()
	Init edit layout form. More...
	saveLayout ()
	Save layout. More...
	addPageTabs ()
	Add page tabs. More...
	downloadFile ()
	download file of file lists More...
Public Member Functions inherited from ilLMObjectGUI
	ilLMObjectGUI (&$a_content_obj)
	constructor More...
	setActions ($a_actions="")
	build action array More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	create ()
	structure / page object creation form More...
	putInTree ()
	put this object into content object tree More...
	delete ()
	Confirm deletion screen (delete page or structure objects) More...
	cancelDelete ()
	cancel deletion of page/structure objects More...
	confirmedDelete ()
	page and structure object deletion More...
	add_cell ($val, $link="")
	output a cell in object list More...
	showActions ($a_actions)
	show possible action (form buttons) More...
	checkTree ()
	check the content object tree More...

Static Public Member Functions
static	_goto ($a_target)
	redirect script More...

Data Fields
	$obj
Data Fields inherited from ilLMObjectGUI
	$ilias
	$tpl
	$lng
	$obj
	$ctrl
	$content_object
	$actions

Detailed Description

Class ilLMPageObjectGUI.

User Interface for Learning Module Page Objects Editing

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_Calls ilLMPageObjectGUI: ilLMPageGUI, ilAssGenFeedbackPageGUI

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

Member Function Documentation

_goto()

static ilLMPageObjectGUI::_goto (   $a_target )

static

redirect script

Parameters

string

$a_target

Definition at line 346 of file class.ilLMPageObjectGUI.php.

        {
                global $rbacsystem, $ilErr, $lng, $ilAccess;
 
                $first = strpos($a_target, "_");
                $second = strpos($a_target, "_", $first + 1);
                $page_id = substr($a_target, 0, $first);
                if ($first > 0)
                {
                        $page_id = substr($a_target, 0, $first);
                        if ($second > 0)
                        {
                                $ref_id = substr($a_target, $first + 1, $second - ($first + 1));
                                $anchor = substr($a_target, $second + 1);
                        }
                        else
                        {
                                $ref_id = substr($a_target, $first + 1);
                        }
                }
                else
                {
                        $page_id = $a_target;
                }
 
                // determine learning object
                $lm_id = ilLMObject::_lookupContObjID($page_id);
 
                // get all references
                $ref_ids = ilObject::_getAllReferences($lm_id);
 
                // always try passed ref id first
                if (in_array($ref_id, $ref_ids))
                {
                        $ref_ids = array_merge(array($ref_id), $ref_ids);
                }
 
                // check read permissions
                foreach ($ref_ids as $ref_id)
                {
                        // check read permissions
                        if ($ilAccess->checkAccess("read", "", $ref_id))
                        {
                                // don't redirect anymore, just set parameters
                                // (goto.php includes  "ilias.php")
                                $_GET["baseClass"] = "ilLMPresentationGUI";
                                $_GET["obj_id"] = $page_id;
                                $_GET["ref_id"] = $ref_id;
                                $_GET["anchor"] = $anchor;
                                include_once("ilias.php");
                                exit;
                        }
                }
 
                if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
                {
                        if ($lm_id > 0)
                        {
                                ilUtil::sendFailure(sprintf($lng->txt("msg_no_perm_read_item"),
                                        ilObject::_lookupTitle($lm_id)), true);
                        }
                        else
                        {
                                $lng->loadLanguageModule("content");
                                ilUtil::sendFailure($lng->txt("page_does_not_exist"), true);
                        }
                        include_once("./Services/Object/classes/class.ilObjectGUI.php");
                        ilObjectGUI::_gotoRepositoryRoot();
                }
 
                $ilErr->raiseError($lng->txt("msg_no_perm_read_lm"), $ilErr->FATAL);
        }

References $_GET, $ilErr, ilLMObjectGUI\$lng, $ref_id, ilObject\_getAllReferences(), ilObjectGUI\_gotoRepositoryRoot(), ilLMObject\_lookupContObjID(), ilObject\_lookupTitle(), exit, and ilUtil\sendFailure().

Here is the call graph for this function:

addPageTabs()

ilLMPageObjectGUI::addPageTabs

(

)

Add page tabs.

Definition at line 510 of file class.ilLMPageObjectGUI.php.

        {
                global $ilTabs, $ilCtrl;
                
                $ilTabs->addTarget("cont_layout",
                         $ilCtrl->getLinkTarget($this, 'editLayout'), "editLayout");
        }

References $ilCtrl.

cancel()

ilLMPageObjectGUI::cancel

(

)

cancel

Definition at line 211 of file class.ilLMPageObjectGUI.php.

        {
                if ($_GET["obj_id"] != 0)
                {
                        ilUtil::redirect($this->ctrl->getLinkTargetByClass("ilStructureObjectGUI",
                                "view", "", true));
                }
                $up_gui = ($this->content_object->getType() == "dbk")
                        ? "ilobjdlbookgui"
                        : "ilobjlearningmodulegui";
                $this->ctrl->redirectByClass($up_gui, "pages");
        }

References $_GET, and ilUtil\redirect().

Here is the call graph for this function:

downloadFile()

ilLMPageObjectGUI::downloadFile

(

)

download file of file lists

Definition at line 521 of file class.ilLMPageObjectGUI.php.

        {
                $pg_obj = $this->obj->getPageObject();
                $pg_obj->buildDom();
                $int_links = $pg_obj->getInternalLinks();
                foreach ($int_links as $il)
                {
                        if ($il["Target"] == str_replace("_file_", "_dfile_", $_GET["file_id"]))
                        {
                                $file = explode("_", $_GET["file_id"]);
                                $file_id = (int) $file[count($file) - 1];
                                require_once("./Modules/File/classes/class.ilObjFile.php");
                                $fileObj = new ilObjFile($file_id, false);
                                $fileObj->sendFile();
                                exit;
                        }
                }
        }

References $_GET, $file, and exit.

edit()

ilLMPageObjectGUI::edit

(

)

Definition at line 157 of file class.ilLMPageObjectGUI.php.

        {
//echo "<br>umschuss";
                $this->ctrl->setCmdClass("ilLMPageGUI");
                $this->ctrl->setCmd("edit");
                $this->executeCommand();
                //$this->setTabs();
        }

References executeCommand().

Here is the call graph for this function:

editLayout()

ilLMPageObjectGUI::editLayout

(

)

Edit layout of page.

Definition at line 422 of file class.ilLMPageObjectGUI.php.

        {
                global $tpl, $ilCtrl, $ilTabs;
                
                $page_gui = new ilLMPageGUI($this->obj->getId());
                $page_gui->setEditPreview(true);
                $page_gui->activateMetaDataEditor($this->content_object,
                        $this->obj->getType(), $this->obj->getId(),
                        $this->obj, "MDUpdateListener");
                $page_gui->setActivationListener($this, "activatePage");
                $page_gui->setTabHook($this, "addPageTabs");
                $lm_set = new ilSetting("lm");
                $tpl->setTitleIcon(ilUtil::getImagePath("icon_pg.svg"));
                $tpl->setTitle($this->lng->txt("page").": ".$this->obj->getTitle());
                $ilCtrl->getHTML($page_gui);
                $ilTabs->setTabActive("cont_layout");
                $this->initEditLayoutForm();
                $tpl->setContent($this->form->getHTML());
        }

References $ilCtrl, $lm_set, ilLMObjectGUI\$tpl, ilUtil\getImagePath(), and initEditLayoutForm().

Here is the call graph for this function:

executeCommand()

& ilLMPageObjectGUI::executeCommand

(

)

execute command

Definition at line 52 of file class.ilLMPageObjectGUI.php.

        {
                global $tpl, $ilCtrl, $ilTabs, $ilSetting;
                
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
                
//echo "<br>:cmd:".$this->ctrl->getCmd().":cmdClass:".$this->ctrl->getCmdClass().":".
//      ":nextClass:".$next_class.":"; flush();
 
                switch($next_class)
                {
                        case "illmpagegui":
 
                                // Determine whether the view of a learning resource should
                                // be shown in the frameset of ilias, or in a separate window.
                                //$showViewInFrameset = $this->ilias->ini->readVariable("layout","view_target") == "frame";
                                $showViewInFrameset = true;
                                $lm_set = new ilSetting("lm");
 
                                $this->ctrl->setReturn($this, "edit");
                                if (!ilPageObject::_exists("lm", $this->obj->getId(), $_GET["transl"]) &&
                                        ilPageObject::_exists("lm", $this->obj->getId(), "-"))
                                {
                                        if ($_GET["totransl"] == "")
                                        {
                                                $_GET["totransl"] = $_GET["transl"];
                                                $ilCtrl->setCmd("switchToLanguage");
                                        }
                                        $ilCtrl->setCmdClass("illmpagegui");
                                        $page_gui = new ilLMPageGUI($this->obj->getId(), 0, false, "-");
                                }
                                else
                                {
                                        $page_gui = new ilLMPageGUI($this->obj->getId());
                                }
                                $page_gui->setEditPreview(true);
                                $page_gui->activateMetaDataEditor($this->content_object,
                                        $this->obj->getType(), $this->obj->getId(),
                                        $this->obj, "MDUpdateListener");
                                if ($ilSetting->get("block_activated_news"))
                                {
                                        $page_gui->setEnabledNews(true, $this->obj->content_object->getId(),
                                                $this->obj->content_object->getType());
                                }
 
                                // set page view link
                                if ($showViewInFrameset)
                                {
                                        $view_frame = ilFrameTargetInfo::_getFrame("MainContent");
                                }
                                else
                                {
                                        $view_frame = "ilContObj".$this->content_object->getID();
                                }
                                $page_gui->setViewPageLink(ILIAS_HTTP_PATH."/goto.php?target=pg_".$this->obj->getId().
                                        "_".$_GET["ref_id"],
                                        $view_frame);
 
                                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                                $page_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                                        $this->content_object->getStyleSheetId(), "lm"));
                                $page_gui->setTemplateTargetVar("ADM_CONTENT");
                                $page_gui->getPageObject()->buildDom();
                                $int_links = $page_gui->getPageObject()->getInternalLinks();
                                $link_xml = $this->getLinkXML($int_links);
                                $page_gui->setLinkXML($link_xml);
 
                                $page_gui->enableChangeComments($this->content_object->isActiveHistoryUserComments());
                                $page_gui->setFileDownloadLink("ilias.php?cmd=downloadFile&ref_id=".$_GET["ref_id"]."&baseClass=ilLMPresentationGUI");
                                $page_gui->setFullscreenLink("ilias.php?cmd=fullscreen&ref_id=".$_GET["ref_id"]."&baseClass=ilLMPresentationGUI");
                                $page_gui->setLinkParams("ref_id=".$this->content_object->getRefId());
                                $page_gui->setSourcecodeDownloadScript("ilias.php?ref_id=".$_GET["ref_id"]."&baseClass=ilLMPresentationGUI");
                                $page_gui->setPresentationTitle(
                                        ilLMPageObject::_getPresentationTitle($this->obj->getId(),
                                        $this->content_object->getPageHeader(), $this->content_object->isActiveNumbering()));
                                $page_gui->setLocator($contObjLocator);
                                $page_gui->setHeader($this->lng->txt("page").": ".$this->obj->getTitle());
                                $page_gui->setActivationListener($this, "activatePage");
                                
                                $up_gui = ($this->content_object->getType() == "dbk")
                                        ? "ilobjdlbookgui"
                                        : "ilobjlearningmodulegui";
                                $ilCtrl->setParameterByClass($up_gui, "active_node", $this->obj->getId());
 
                                $tpl->setTitleIcon(ilUtil::getImagePath("icon_pg.svg"));
                                $tpl->setTitle($this->lng->txt("page").": ".$this->obj->getTitle());
                                if ($this->content_object->getLayoutPerPage())
                                {
                                        $page_gui->setTabHook($this, "addPageTabs");
                                }
                                $ret = $this->ctrl->forwardCommand($page_gui);
                                $tpl->setContent($ret);
                                break;
 
                        default:
                                $ret =& $this->$cmd();
                                break;
                }
        }

References $_GET, $cmd, $ilCtrl, $ilSetting, $lm_set, $ret, ilLMObjectGUI\$tpl, ilPageObject\_exists(), ilFrameTargetInfo\_getFrame(), ilLMPageObject\_getPresentationTitle(), ilObjStyleSheet\getEffectiveContentStyleId(), ilUtil\getImagePath(), and getLinkXML().

Referenced by edit(), and preview().

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkXML()

ilLMPageObjectGUI::getLinkXML

(

$a_int_links

)

get link targets

Definition at line 227 of file class.ilLMPageObjectGUI.php.

        {
                if ($a_layoutframes == "")
                {
                        $a_layoutframes = array();
                }
                $link_info = "<IntLinkInfos>";
                foreach ($a_int_links as $int_link)
                {
                        $target = $int_link["Target"];
                        if (substr($target, 0, 4) == "il__")
                        {
                                $target_arr = explode("_", $target);
                                $target_id = $target_arr[count($target_arr) - 1];
                                $type = $int_link["Type"];
                                $targetframe = ($int_link["TargetFrame"] != "")
                                        ? $int_link["TargetFrame"]
                                        : "None";
                                        
                                // anchor
                                $anc = $anc_add = "";
                                if ($int_link["Anchor"] != "")
                                {
                                        $anc = $int_link["Anchor"];
                                        $anc_add = "_".rawurlencode($int_link["Anchor"]);
                                }
 
                                switch($type)
                                {
                                        case "PageObject":
                                        case "StructureObject":
                                                $lm_id = ilLMObject::_lookupContObjID($target_id);
                                                $cont_obj =& $this->content_object;
                                                if ($lm_id == $cont_obj->getId())
                                                {
                                                        $ltarget = "";
                                                        if ($type == "PageObject")
                                                        {
                                                                $this->ctrl->setParameter($this, "obj_id", $target_id);
                                                                $href = $this->ctrl->getLinkTargetByClass(get_class($this), "edit");
                                                        }
                                                        else
                                                        {
                                                                $this->ctrl->setParameterByClass("ilstructureobjectgui", "obj_id", $target_id);
                                                                $href = $this->ctrl->getLinkTargetByClass("ilstructureobjectgui", "view");
                                                        }
                                                        $href = str_replace("&", "&amp;", $href);
                                                        $this->ctrl->setParameter($this, "obj_id", $_GET["obj_id"]);
                                                }
                                                else
                                                {
                                                        if ($type == "PageObject")
                                                        {
                                                                $href = "goto.php?target=pg_".$target_id.$anc_add;
                                                        }
                                                        else
                                                        {
                                                                $href = "goto.php?target=st_".$target_id;
                                                        }
                                                        $ltarget = "ilContObj".$lm_id;
                                                }
                                                break;
 
                                        case "GlossaryItem":
                                                $ltarget = $nframe = "_blank";
                                                $href = "ilias.php?cmdClass=illmpresentationgui&amp;baseClass=ilLMPresentationGUI&amp;".
                                                        "obj_type=$type&amp;cmd=glossary&amp;ref_id=".$_GET["ref_id"].
                                                        "&amp;obj_id=".$target_id."&amp;frame=$nframe";
                                                break;
 
                                        case "MediaObject":
                                                $ltarget = $nframe = "_blank";
                                                $href = "ilias.php?cmdClass=illmpresentationgui&amp;baseClass=ilLMPresentationGUI&amp;obj_type=$type&amp;cmd=media&amp;ref_id=".$_GET["ref_id"].
                                                        "&amp;mob_id=".$target_id."&amp;frame=$nframe";
                                                break;
                                                
                                        case "RepositoryItem":
                                                $obj_type = ilObject::_lookupType($target_id, true);
                                                $obj_id = ilObject::_lookupObjId($target_id);
                                                $href = "./goto.php?target=".$obj_type."_".$target_id;
                                                $t_frame = ilFrameTargetInfo::_getFrame("MainContent", $obj_type);
                                                $ltarget = $t_frame;
                                                break;
 
                                        case "File":
                                                $this->ctrl->setParameter($this, "file_id", "il__file_".$target_id);
                                                $href = $this->ctrl->getLinkTarget($this, "downloadFile");
                                                $this->ctrl->setParameter($this, "file_id", "");
                                                break;
 
                                }
                                
                                $anc_par = 'Anchor="'.$anc.'"';
                                
                                $link_info.="<IntLinkInfo Target=\"$target\" Type=\"$type\" ".
                                        "TargetFrame=\"$targetframe\" LinkHref=\"$href\" LinkTarget=\"$ltarget\" $anc_par/>";
                        }
                }
                $link_info.= "</IntLinkInfos>";
//echo ":".htmlentities($link_info).":";
                return $link_info;
        }

References $_GET, ilLMObjectGUI\$content_object, $target_arr, $target_id, ilFrameTargetInfo\_getFrame(), ilLMObject\_lookupContObjID(), ilObject\_lookupObjId(), and ilObject\_lookupType().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

ilLMPageObjectGUI()

ilLMPageObjectGUI::ilLMPageObjectGUI

(

&

$a_content_obj

)

Constructor.

Parameters

object

$a_content_obj

content object (lm | dbk) @access public

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

        {
                global $ilias, $tpl, $lng;
 
                parent::ilLMObjectGUI($a_content_obj);
 
        }

References ilLMObjectGUI\$ilias, ilLMObjectGUI\$lng, and ilLMObjectGUI\$tpl.

initEditLayoutForm()

ilLMPageObjectGUI::initEditLayoutForm

(

)

Init edit layout form.

Parameters

int

$a_mode

Edit Mode

Definition at line 447 of file class.ilLMPageObjectGUI.php.

        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
        
                // default layout
                $layout = new ilRadioGroupInputGUI($lng->txt("cont_layout"), "layout");
                
                if (is_file($im = ilUtil::getImagePath("layout_".$this->content_object->getLayout().".png")))
                {
                        $im_tag = ilUtil::img($im, $this->content_object->getLayout());
                }
                $layout->addOption(new ilRadioOption("<table><tr><td>".$im_tag."</td><td><b>".
                        $lng->txt("cont_lm_default_layout").
                        "</b>: ".$lng->txt("cont_layout_".$this->content_object->getLayout()).
                        "</td></tr></table>", ""));
                
                foreach(ilObjContentObject::getAvailableLayouts() as $l)
                {
                        $im_tag = "";
                        if (is_file($im = ilUtil::getImagePath("layout_".$l.".png")))
                        {
                                $im_tag = ilUtil::img($im, $l);
                        }
                        $layout->addOption(new ilRadioOption("<table><tr><td>".$im_tag."</td><td><b>".
                                $lng->txt("cont_layout_".$l)."</b>: ".$lng->txt("cont_layout_".$l."_desc").
                                "</td></tr></table>", $l));
                }
                
                $layout->setValue($this->obj->getLayout());
                $this->form->addItem($layout);
 
                $this->form->addCommandButton("saveLayout", $lng->txt("save"));
                        
                $this->form->setTitle($lng->txt("cont_page_layout"));
                $this->form->setFormAction($ilCtrl->getFormAction($this));
         
        }

References $ilCtrl, $l, ilLMObjectGUI\$lng, ilObjContentObject\getAvailableLayouts(), ilUtil\getImagePath(), and ilUtil\img().

Referenced by editLayout(), and saveLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

preview()

ilLMPageObjectGUI::preview

(

)

Definition at line 169 of file class.ilLMPageObjectGUI.php.

        {
                $this->ctrl->setCmdClass("ilLMPageGUI");
                $this->ctrl->setCmd("preview");
                $this->executeCommand();
//              $this->setTabs();
        }

References executeCommand().

Here is the call graph for this function:

save()

ilLMPageObjectGUI::save

(

)

save co page object

Definition at line 180 of file class.ilLMPageObjectGUI.php.

        {
                $this->obj =& new ilLMPageObject($this->content_object);
                $this->obj->setType("pg");
                $this->obj->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
                $this->obj->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));
                $this->obj->setLMId($this->content_object->getId());
                $this->obj->create();
 
                // obj_id is empty, if page is created from "all pages" screen
                // -> a free page is created (not in the tree)
//echo "<br>savePage:".$_GET["obj_id"].":";
                if ($_GET["obj_id"] != 0)
                {
                        $this->putInTree();
 
                        // check the tree
                        $this->checkTree();
 
                        ilUtil::redirect($this->ctrl->getLinkTargetByClass("ilStructureObjectGUI",
                                "edit", "", true));
                }
                $up_gui = ($this->content_object->getType() == "dbk")
                        ? "ilobjdlbookgui"
                        : "ilobjlearningmodulegui";
                $this->ctrl->redirectByClass($up_gui, "pages");
        }

References $_GET, $_POST, ilLMObjectGUI\checkTree(), ilLMObjectGUI\putInTree(), ilUtil\redirect(), and ilUtil\stripSlashes().

Here is the call graph for this function:

saveLayout()

ilLMPageObjectGUI::saveLayout

(

)

Save layout.

Definition at line 492 of file class.ilLMPageObjectGUI.php.

        {
                global $tpl, $lng, $ilCtrl;
        
                $this->initEditLayoutForm();
                if ($this->form->checkInput())
                {
                        ilLMObject::writeLayout($this->obj->getId(), $this->form->getInput("layout"));
                        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                        $ilCtrl->redirect($this, "editLayout");
                }
                $this->form->setValuesByPost();
                $tpl->setContent($this->form->getHtml());
        }

References $ilCtrl, ilLMObjectGUI\$lng, ilLMObjectGUI\$tpl, initEditLayoutForm(), ilUtil\sendSuccess(), and ilLMObject\writeLayout().

Here is the call graph for this function:

setLMPageObject()

ilLMPageObjectGUI::setLMPageObject

(

$a_pg_obj

)

Set content object dependent page object (co page)

Definition at line 43 of file class.ilLMPageObjectGUI.php.

        {
                $this->obj = $a_pg_obj;
                $this->obj->setLMId($this->content_object->getId());
        }

updateHistory()

ilLMPageObjectGUI::updateHistory

(

)

update history

Definition at line 333 of file class.ilLMPageObjectGUI.php.

        {
                require_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_createEntry($this->obj->getId(), "update",
                        "", $this->content_object->getType().":pg",
                        "", true);
        }

References ilHistory\_createEntry().

Here is the call graph for this function:

Field Documentation

$obj

ilLMPageObjectGUI::$obj

Definition at line 23 of file class.ilLMPageObjectGUI.php.

---

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

• Modules/LearningModule/classes/class.ilLMPageObjectGUI.php