User Interface for Editing of Page Content Objects (Paragraphs, Tables, ...) More...

Inheritance diagram for ilPageContentGUI:

Collaboration diagram for ilPageContentGUI:

Public Member Functions
	ilPageContentGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public.
	getHierId ()
	get hierarchical id in dom object
	setHierId ($a_hier_id)
	get hierarchical id in dom object
	getBBMenu ()
	Get the bb menu incl.
	delete ()
	delete content element
	moveAfter ()
	move content element after another element
	moveBefore ()
	move content element before another element
	splitPage ()
	split page to new page at specified position
	splitPageNext ()
	split page to next page at specified position
	displayValidationError ()
	display validation errors
	cancelCreate ()
	cancel creating page content
	cancelUpdate ()
	cancel update
	deactivate ()
	gui function set enabled if is not enabled and vice versa

Data Fields
	$content_obj
	$ilias
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location

Detailed Description

User Interface for Editing of Page Content Objects (Paragraphs, Tables, ...)

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

Version

Id:: class.ilPageContentGUI.php 17399 2008-09-15 21:26:52Z akill

Definition at line 34 of file class.ilPageContentGUI.php.

Member Function Documentation

ilPageContentGUI::cancelCreate ( )

cancel creating page content

Reimplemented in ilPCSourcecodeGUI.

Definition at line 365 of file class.ilPageContentGUI.php.

        {
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);
        }

ilPageContentGUI::cancelUpdate ( )

cancel update

Reimplemented in ilPCSourcecodeGUI.

Definition at line 373 of file class.ilPageContentGUI.php.

        {
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);
        }

ilPageContentGUI::deactivate ( )

gui function set enabled if is not enabled and vice versa

Definition at line 383 of file class.ilPageContentGUI.php.

References $_SESSION, $content_obj, and $updated.

        {               
                $obj = & $this->content_obj;
                
                if ($obj->isEnabled ()) 
                        $obj->disable ();
                else
                        $obj->enable ();
                
                $updated = $this->pg_obj->update($this->hier_id);
                if($updated !== true)
                {
                        $_SESSION["il_pg_error"] = $updated;
                }
                else
                {
                        unset($_SESSION["il_pg_error"]);
                }
        
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);              
        }

ilPageContentGUI::delete ( )

delete content element

Definition at line 155 of file class.ilPageContentGUI.php.

References $_SESSION, and $updated.

        {
                $updated = $this->pg_obj->deleteContent($this->hier_id);
                if($updated !== true)
                {
                        $_SESSION["il_pg_error"] = $updated;
                }
                else
                {
                        unset($_SESSION["il_pg_error"]);
                }
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);
        }

ilPageContentGUI::displayValidationError ( )

display validation errors

Definition at line 340 of file class.ilPageContentGUI.php.

Referenced by ilPCMapGUI\create(), ilPCSourcecodeGUI\edit(), ilPCResourcesGUI\edit(), ilPCSectionGUI\edit(), ilPCTabsGUI\edit(), ilPCMapGUI\edit(), ilPCTableGUI\edit(), ilPCParagraphGUI\edit(), ilPCPluggedGUI\edit(), ilPCListGUI\edit(), ilPCFileListGUI\edit(), ilPCMediaObjectGUI\editAlias(), ilPCTableGUI\editCells(), ilPCDataTableGUI\editData(), ilPCFileListGUI\insert(), ilPCMapGUI\insert(), ilPCListGUI\insert(), ilPCMediaObjectGUI\insert(), ilPCSourcecodeGUI\insert(), ilPCDataTableGUI\insert(), ilPCTableGUI\insert(), ilPCFileItemGUI\newItemAfter(), ilPCFileItemGUI\newItemBefore(), and ilPCMapGUI\update().

        {
                if(is_array($this->updated))
                {
                        $error_str = "<b>Validation Error(s):</b><br>";
                        foreach ($this->updated as $error)
                        {
                                $err_mess = implode($error, " - ");
                                if (!is_int(strpos($err_mess, ":0:")))
                                {
                                        $error_str .= htmlentities($err_mess)."<br />";
                                }
                        }
                        $this->tpl->setVariable("MESSAGE", $error_str);
                }
                else if($this->updated != "" && $this->updated !== true)
                {
                        $this->tpl->setVariable("MESSAGE", "<b>Validation Error(s):</b><br />".
                                $this->updated."<br />");
                }
        }

Here is the caller graph for this function:

ilPageContentGUI::getBBMenu ( )

Get the bb menu incl.

script

Definition at line 112 of file class.ilPageContentGUI.php.

References $lng.

Referenced by ilPCParagraphGUI\edit(), and ilPCDataTableGUI\editData().

        {
                global $lng;
                
                $btpl = new ilTemplate("tpl.bb_menu.html", true, true, "Services/COPage");
                // not nice, should be set by context per method
                if ($this->pg_obj->getParentType() == "gdf" ||
                        $this->pg_obj->getParentType() == "lm" ||
                        $this->pg_obj->getParentType() == "dbk")
                {
                        $btpl->setCurrentBlock("bb_ilink_button");
                        $btpl->setVariable("BB_LINK_ILINK",
                                $this->ctrl->getLinkTargetByClass("ilInternalLinkGUI", "showLinkHelp"));
                        $btpl->parseCurrentBlock();
                }
                if ($this->pg_obj->getParentType() == "wpg")
                {
                        $btpl->setCurrentBlock("bb_wikilink_button");
                        $btpl->setVariable("TXT_WLN2", $lng->txt("wiki_wiki_page"));
                        $btpl->parseCurrentBlock();
                }
                $btpl->setVariable("TXT_STR", $this->lng->txt("cont_text_str"));
                $btpl->setVariable("TXT_EMP", $this->lng->txt("cont_text_emp"));
                $btpl->setVariable("TXT_COM", $this->lng->txt("cont_text_com"));
                $btpl->setVariable("TXT_FN", $this->lng->txt("cont_text_fn"));
                $btpl->setVariable("TXT_QUOT", $this->lng->txt("cont_text_quot"));
                $btpl->setVariable("TXT_CODE", $this->lng->txt("cont_text_code"));
                $btpl->setVariable("TXT_ILN", $this->lng->txt("cont_text_iln"));
                $btpl->setVariable("TXT_XLN", $this->lng->txt("cont_text_xln"));
                $btpl->setVariable("TXT_TEX", $this->lng->txt("cont_text_tex"));
                $btpl->setVariable("TXT_BB_TIP", $this->lng->txt("cont_bb_tip"));
                $btpl->setVariable("TXT_WLN", $lng->txt("wiki_wiki_page"));
                
                $btpl->setVariable("PAR_TA_NAME", "par_content");
                
                return $btpl->get();
        }

Here is the caller graph for this function:

ilPageContentGUI::getHierId ( )

get hierarchical id in dom object

Definition at line 96 of file class.ilPageContentGUI.php.

References $hier_id.

Referenced by ilPCMediaObjectGUI\centerAlign(), ilPCParagraphGUI\edit(), ilPCMediaObjectGUI\editAlias(), ilPCMediaObjectGUI\leftAlign(), ilPCMediaObjectGUI\leftFloatAlign(), ilPCMediaObjectGUI\rightAlign(), ilPCMediaObjectGUI\rightFloatAlign(), and ilPCMediaObjectGUI\saveAliasProperties().

        {
                return $this->hier_id;
        }

Here is the caller graph for this function:

ilPageContentGUI::ilPageContentGUI	(	&	$a_pg_obj,
		&	$a_content_obj,
			$a_hier_id = `0`,
			$a_pc_id = `""`
	)

Constructor public.

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

References $ilCtrl, $ilias, $lng, and $tpl.

Referenced by ilPCDataTableGUI\ilPCDataTableGUI(), ilPCFileItemGUI\ilPCFileItemGUI(), ilPCFileListGUI\ilPCFileListGUI(), ilPCListGUI\ilPCListGUI(), ilPCListItemGUI\ilPCListItemGUI(), ilPCMapGUI\ilPCMapGUI(), ilPCMediaObjectGUI\ilPCMediaObjectGUI(), ilPCParagraphGUI\ilPCParagraphGUI(), ilPCPluggedGUI\ilPCPluggedGUI(), ilPCQuestionGUI\ilPCQuestionGUI(), ilPCResourcesGUI\ilPCResourcesGUI(), ilPCSectionGUI\ilPCSectionGUI(), ilPCSourcecodeGUI\ilPCSourcecodeGUI(), ilPCTableDataGUI\ilPCTableDataGUI(), ilPCTableGUI\ilPCTableGUI(), and ilPCTabsGUI\ilPCTabsGUI().

        {
                global $ilias, $tpl, $lng, $ilCtrl;
                $this->ilias =& $ilias;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->pg_obj =& $a_pg_obj;
                $this->ctrl =& $ilCtrl;
                $this->content_obj =& $a_content_obj;
                if($a_hier_id !== 0)
                {
                        $this->hier_id = $a_hier_id;
                        $this->pc_id = $a_pc_id;
//echo "-".$this->pc_id."-";
                        $this->dom =& $a_pg_obj->getDom();
                }
        }

Here is the caller graph for this function:

ilPageContentGUI::moveAfter ( )

move content element after another element

Definition at line 172 of file class.ilPageContentGUI.php.

References $_SESSION, and $updated.

        {
                // check if a target is selected
                if(!isset($_POST["target"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }
                // check if only one target is selected
                if(count($_POST["target"]) > 1)
                {
                        $this->ilias->raiseError($this->lng->txt("only_one_target"),$this->ilias->error_obj->MESSAGE);
                }
                $a_hid = explode(":", $_POST["target"][0]);
//echo "-".$a_hid[0]."-".$a_hid[1]."-";
                // check if target is within source
                if($this->hier_id == substr($a_hid[0], 0, strlen($this->hier_id)))
                {
                        $this->ilias->raiseError($this->lng->txt("cont_target_within_source"),$this->ilias->error_obj->MESSAGE);
                }
                // check whether target is allowed
                $curr_node =& $this->pg_obj->getContentNode($a_hid[0], $a_hid[1]);
                if (is_object($curr_node) && $curr_node->node_name() == "FileItem")
                {
                        $this->ilias->raiseError($this->lng->txt("cont_operation_not_allowed"),$this->ilias->error_obj->MESSAGE);
                }
                // strip "c" "r" of table ids from hierarchical id
                $first_hier_character = substr($a_hid[0], 0, 1);
                if ($first_hier_character == "c" ||
                        $first_hier_character == "r" ||
                        $first_hier_character == "i")
                {
                        $a_hid[0] = substr($a_hid[0], 1);
                }
                // move
                $updated = $this->pg_obj->moveContentAfter($this->hier_id, $a_hid[0],
                        $this->content_obj->getPcId(), $a_hid[1]);
                if($updated !== true)
                {
                        $_SESSION["il_pg_error"] = $updated;
                }
                else
                {
                        unset($_SESSION["il_pg_error"]);
                }
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);
        }

ilPageContentGUI::moveBefore ( )

move content element before another element

Definition at line 229 of file class.ilPageContentGUI.php.

References $_SESSION, and $updated.

        {
                // check if a target is selected
                if(!isset($_POST["target"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }
                // check if target is within source
                if(count($_POST["target"]) > 1)
                {
                        $this->ilias->raiseError($this->lng->txt("only_one_target"),$this->ilias->error_obj->MESSAGE);
                }
                $a_hid = explode(":", $_POST["target"][0]);
                
                // check if target is within source
                if($this->hier_id == substr($a_hid[0], 0, strlen($this->hier_id)))
                {
                        $this->ilias->raiseError($this->lng->txt("cont_target_within_source"),$this->ilias->error_obj->MESSAGE);
                }
                // check whether target is allowed
                $curr_node =& $this->pg_obj->getContentNode($a_hid[0], $a_hid[1]);
                if (is_object($curr_node) && $curr_node->node_name() == "FileItem")
                {
                        $this->ilias->raiseError($this->lng->txt("cont_operation_not_allowed"),$this->ilias->error_obj->MESSAGE);
                }
                // strip "c" "r" of table ids from hierarchical id
                $first_hier_character = substr($a_hid[0], 0, 1);
                if ($first_hier_character == "c" ||
                        $first_hier_character == "r" ||
                        $first_hier_character == "i")
                {
                        $a_hid[0] = substr($a_hid[0], 1);
                }
                // move
                $updated = $this->pg_obj->moveContentBefore($this->hier_id, $a_hid[0],
                        $this->content_obj->getPcId(), $a_hid[1]);
                if($updated !== true)
                {
                        $_SESSION["il_pg_error"] = $updated;
                }
                else
                {
                        unset($_SESSION["il_pg_error"]);
                }
                $this->ctrl->returnToParent($this, "jump".$this->hier_id);
        }

ilPageContentGUI::setHierId ( $a_hier_id )

get hierarchical id in dom object

Definition at line 104 of file class.ilPageContentGUI.php.

Referenced by ilPCDataTableGUI\create().

        {
                $this->hier_id = $a_hier_id;
        }

Here is the caller graph for this function:

ilPageContentGUI::splitPage ( )

split page to new page at specified position

Definition at line 285 of file class.ilPageContentGUI.php.

References $hier_id, $ilErr, and ilLMPageObject\_splitPage().

        {
                global $ilErr;
                
                if ($this->pg_obj->getParentType() != "lm" &&
                        $this->pg_obj->getParentType() != "dbk")
                {
                        $ilErr->raiseError("Split method called for wrong parent type (".
                        $this->pg_obj->getParentType().")", $ilErr->FATAL);
                }
                else
                {
                        $lm_page =& ilLMPageObject::_splitPage($this->pg_obj->getId(),
                                $this->pg_obj->getParentType(), $this->hier_id);
                                
                        // jump to new page
                        $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $lm_page->getId());
                        $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
                }
                
                $this->ctrl->returnToParent($this, "jump".($this->hier_id - 1));
        }

Here is the call graph for this function:

ilPageContentGUI::splitPageNext ( )

split page to next page at specified position

Definition at line 311 of file class.ilPageContentGUI.php.

References $hier_id, $ilErr, and ilLMPageObject\_splitPageNext().

        {
                global $ilErr;
                
                if ($this->pg_obj->getParentType() != "lm" &&
                        $this->pg_obj->getParentType() != "dbk")
                {
                        $ilErr->raiseError("Split method called for wrong parent type (".
                        $this->pg_obj->getParentType().")", $ilErr->FATAL);
                }
                else
                {
                        $succ_id = ilLMPageObject::_splitPageNext($this->pg_obj->getId(),
                                $this->pg_obj->getParentType(), $this->hier_id);
                        
                        // jump to successor page
                        if ($succ_id > 0)
                        {
                                $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $succ_id);
                                $this->ctrl->redirectByClass("illmpageobjectgui", "edit");
                        }
                }
                $this->ctrl->returnToParent($this, "jump".($this->hier_id - 1));
        }