ilPageContentGUI Class Reference

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

Inheritance diagram for ilPageContentGUI:

Collaboration diagram for ilPageContentGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	display validation errors More...
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions ($a_type)
	Get table templates. More...

Static Public Member Functions
static	_getCommonBBButtons ()
	Get common bb buttons. More...

Data Fields
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null

Static Public Attributes
static	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"

Protected Member Functions
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...

Protected Attributes
	$error
	$log

Static Protected Attributes
static	$common_bb_buttons

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$

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

References $DIC, $ilCtrl, $lng, $tpl, and ilLoggerFactory\getLogger().

    {
        global $DIC;

        $this->error = $DIC["ilErr"];
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();

        $this->log = ilLoggerFactory::getLogger('copg');

        $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 call graph for this function:

Member Function Documentation

_getCommonBBButtons()

static ilPageContentGUI::_getCommonBBButtons ( )

static

Get common bb buttons.

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

Referenced by ilPageObjectGUI\getTinyMenu(), ilPCParagraph\handleAjaxContent(), ilObjAdvancedEditingGUI\initPageEditorForm(), ilObjAdvancedEditingGUI\savePageEditorSettingsObject(), and ilPCParagraphGUI\xml2outputJS().

    {
        return self::$common_bb_buttons;
    }

Here is the caller graph for this function:

cancel()

ilPageContentGUI::cancel

(

)

Cancel.

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

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

cancelCreate()

ilPageContentGUI::cancelCreate

(

)

cancel creating page content

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

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

cancelUpdate()

ilPageContentGUI::cancelUpdate

(

)

cancel update

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

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

copy()

ilPageContentGUI::copy

(

)

Copy single element.

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

References $content_obj, $lng, and array.

    {
        $lng = $this->lng;
        
        $obj = $this->content_obj;
        
        //ilUtil::sendSuccess($lng->txt("cont_sel_el_copied_use_paste"), true);
        $this->pg_obj->copyContents(array($this->hier_id . ":" . $this->pc_id));
  
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

cut()

ilPageContentGUI::cut

(

)

Cut single element.

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

References $_SESSION, $content_obj, $lng, $updated, and array.

    {
        $lng = $this->lng;
        
        $obj = $this->content_obj;
        
        $updated = $this->pg_obj->cutContents(array($this->hier_id . ":" . $this->pc_id));
        if ($updated !== true) {
            $_SESSION["il_pg_error"] = $updated;
        } else {
            unset($_SESSION["il_pg_error"]);
        }
    
        //ilUtil::sendSuccess($lng->txt("cont_sel_el_cut_use_paste"), true);
        $this->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

deactivate()

ilPageContentGUI::deactivate

(

)

gui function set enabled if is not enabled and vice versa

Definition at line 565 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);
    }

delete()

ilPageContentGUI::delete

(

)

delete content element

Definition at line 346 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);
    }

displayValidationError()

ilPageContentGUI::displayValidationError

(

)

display validation errors

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

References $error, and ilUtil\sendFailure().

Referenced by ilPCMediaObjectGUI\changeObjectReference(), ilPCContentTemplateGUI\create(), ilPCMapGUI\create(), ilPCSourceCodeGUI\edit(), ilPCQuestionOverviewGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCResourcesGUI\edit(), ilPCMyCoursesGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCBlogGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCMapGUI\edit(), ilPCProfileGUI\edit(), ilPCListGUI\edit(), ilPCVerificationGUI\edit(), ilPCSkillsGUI\edit(), ilPCSectionGUI\edit(), ilPCPluggedGUI\edit(), ilPCParagraphGUI\edit(), ilPCTableGUI\edit(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellSpan(), ilPCTableGUI\editCellStyle(), ilPCTableGUI\editCellWidth(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilPCBlogGUI\editPosting(), ilPCGridGUI\editProperties(), ilPCTabsGUI\editProperties(), ilPCMediaObjectGUI\editStyle(), ilPCAMDPageListGUI\insert(), ilPCListGUI\insert(), ilPCMyCoursesGUI\insert(), ilPCContentTemplateGUI\insert(), ilPCGridGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCBlogGUI\insert(), ilPCTabsGUI\insert(), ilPCMapGUI\insert(), ilPCProfileGUI\insert(), ilPCSkillsGUI\insert(), ilPCVerificationGUI\insert(), ilPCFileListGUI\insert(), ilPCSourceCodeGUI\insert(), ilPCInteractiveImageGUI\insert(), ilPCQuestionGUI\insert(), ilPCMediaObjectGUI\insert(), ilPCTableGUI\insert(), ilPCBlogGUI\insertPosting(), ilPCFileListGUI\newFileItem(), ilPCFileItemGUI\newItemAfter(), ilPCFileItemGUI\newItemBefore(), ilPCFileListGUI\selectFile(), and ilPCMapGUI\update().

    {
        if (is_array($this->updated)) {
            $error_str = "<b>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 />";
                }
            }
            ilUtil::sendFailure($error_str);
        } elseif ($this->updated != "" && $this->updated !== true) {
            ilUtil::sendFailure("<b>Error(s):</b><br />" .
                $this->updated);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBBMenu()

ilPageContentGUI::getBBMenu

(

$a_ta_name = "par_content"

)

Get the bb menu incl.

script

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

References $ctrl, $ilCtrl, $lng, $mathJaxSetting, $style, array, defined, ilPCParagraphGUI\getCharStyleSelector(), ilInternalLinkGUI\getInitHTML(), getPageConfig(), getStyle(), getStyleId(), and ilPageEditorSettings\lookupSettingByParentType().

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once("./Services/COPage/classes/class.ilPageEditorSettings.php");
        
        $btpl = new ilTemplate("tpl.bb_menu.html", true, true, "Services/COPage");

        // not nice, should be set by context per method
        if ($this->getPageConfig()->getEnableInternalLinks()) {
            $btpl->setCurrentBlock("bb_ilink_button");
            $btpl->setVariable(
                "BB_LINK_ILINK",
                $this->ctrl->getLinkTargetByClass("ilInternalLinkGUI", "showLinkHelp")
            );
            $btpl->parseCurrentBlock();
            
            // add int link parts
            include_once("./Services/Link/classes/class.ilInternalLinkGUI.php");
            $btpl->setCurrentBlock("int_link_prep");
            $btpl->setVariable("INT_LINK_PREP", ilInternalLinkGUI::getInitHTML(
                $ilCtrl->getLinkTargetByClass(
                    array("ilpageeditorgui", "ilinternallinkgui"),
                    "",
                    false,
                    true,
                    false
                ),
                true
            ));
            $btpl->parseCurrentBlock();
        }

        if ($this->getPageConfig()->getEnableKeywords()) {
            $btpl->touchBlock("bb_kw_button");
            $btpl->setVariable("TXT_KW", $this->lng->txt("cont_text_keyword"));
        }
        if ($this->pg_obj->getParentType() == "wpg") {
            $btpl->setCurrentBlock("bb_wikilink_button2");
            $btpl->setVariable("TXT_WIKI_BUTTON2", $lng->txt("obj_wiki"));
            $btpl->setVariable("WIKI_BUTTON2_URL", $ilCtrl->getLinkTargetByClass("ilwikipagegui", ""));
            $btpl->parseCurrentBlock();

            $btpl->setCurrentBlock("bb_wikilink_button");
            $btpl->setVariable("TXT_WLN2", $lng->txt("wiki_wiki_page"));
            $btpl->parseCurrentBlock();
        }
        $mathJaxSetting = new ilSetting("MathJax");
        $style = $this->getStyle();
        //echo URL_TO_LATEX;
        foreach (self::$common_bb_buttons as $c => $st) {
            if (ilPageEditorSettings::lookupSettingByParentType($this->pg_obj->getParentType(), "active_" . $c, true)) {
                if ($c != "tex" || $mathJaxSetting->get("enable") || defined("URL_TO_LATEX")) {
                    if (!in_array($c, array("acc", "com", "quot", "code"))) {
                        $btpl->touchBlock("bb_" . $c . "_button");
                        $btpl->setVariable("TXT_" . strtoupper($c), $this->lng->txt("cont_text_" . $c));
                        $lng->toJS("cont_text_" . $c);
                    }
                }
            }
        }
        
        if ($this->getPageConfig()->getEnableAnchors()) {
            $btpl->touchBlock("bb_anc_button");
            $btpl->setVariable("TXT_ANC", $lng->txt("cont_anchor") . ":");
            $lng->toJS("cont_anchor");
        }

        include_once("./Services/COPage/classes/class.ilPCParagraphGUI.php");
        $btpl->setVariable("CHAR_STYLE_SELECT", ilPCParagraphGUI::getCharStyleSelector($this->pg_obj->getParentType(), "il.COPageBB.setCharacterClass", $this->getStyleId()));
        
        // footnote
        //              $btpl->setVariable("TXT_FN", $this->lng->txt("cont_text_fn"));
        
        //              $btpl->setVariable("TXT_CODE", $this->lng->txt("cont_text_code"));
        $btpl->setVariable("TXT_ILN", $this->lng->txt("cont_text_iln"));
        $lng->toJS("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"));
        $lng->toJS("wiki_wiki_page");
        
        $btpl->setVariable("PAR_TA_NAME", $a_ta_name);
        
        return $btpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCharacteristics()

ilPageContentGUI::getCharacteristics

(

)

Get characteristics.

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

References array.

Referenced by ilPCFileListGUI\checkStyleSelection(), ilPCMediaObjectGUI\checkStyleSelection(), ilPCTableGUI\editCellStyle(), ilPCMediaObjectGUI\editStyle(), ilPCSectionGUI\initForm(), ilPCListGUI\initListForm(), ilPCTableGUI\initPropertiesForm(), ilPCParagraphGUI\insertCharacteristicTable(), and ilPCParagraphGUI\insertStyleSelectionList().

    {
        return $this->chars ? $this->chars : array();
    }

Here is the caller graph for this function:

getCharacteristicsOfCurrentStyle()

ilPageContentGUI::getCharacteristicsOfCurrentStyle (   $a_type )

protected

Get characteristics of current style.

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

References $a_type, $style, ilObject\_lookupType(), array, getStyleId(), and setCharacteristics().

Referenced by ilPCTableGUI\editCellStyle(), ilPCDataTableGUI\executeCommand(), ilPCTableGUI\executeCommand(), ilPCFileListGUI\executeCommand(), ilPCSectionGUI\executeCommand(), ilPCMediaObjectGUI\executeCommand(), ilPCParagraphGUI\executeCommand(), ilPCListGUI\initListForm(), and ilPCTableGUI\initPropertiesForm().

    {
        if ($this->getStyleId() > 0 &&
            ilObject::_lookupType($this->getStyleId()) == "sty") {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            $style = new ilObjStyleSheet($this->getStyleId());
            $chars = array();
            if (!is_array($a_type)) {
                $a_type = array($a_type);
            }
            foreach ($a_type as $at) {
                $chars = array_merge($chars, $style->getCharacteristics($at, true));
            }
            $new_chars = array();
            if (is_array($chars)) {
                foreach ($chars as $char) {
                    if ($this->chars[$char] != "") {    // keep lang vars for standard chars
                        $new_chars[$char] = $this->chars[$char];
                    } else {
                        $new_chars[$char] = $char;
                    }
                    asort($new_chars);
                }
            }
            $this->setCharacteristics($new_chars);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContentObject()

ilPageContentGUI::getContentObject

(

)

Get content object.

Returns

object content object

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

References $content_obj.

    {
        return $this->content_obj;
    }

getHierId()

ilPageContentGUI::getHierId

(

)

get hierarchical id in dom object

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

References $hier_id.

Referenced by ilPCInteractiveImageGUI\centerAlign(), ilPCMediaObjectGUI\centerAlign(), ilPCMediaObjectGUI\checkFixSize(), ilPCParagraphGUI\determineCharacteristic(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilPCMediaObjectGUI\getAliasValues(), ilPCMediaObjectGUI\initAliasForm(), ilPCInteractiveImageGUI\initForm(), ilPCInteractiveImageGUI\leftAlign(), ilPCMediaObjectGUI\leftAlign(), ilPCInteractiveImageGUI\leftFloatAlign(), ilPCMediaObjectGUI\leftFloatAlign(), ilPCInteractiveImageGUI\rightAlign(), ilPCMediaObjectGUI\rightAlign(), ilPCInteractiveImageGUI\rightFloatAlign(), ilPCMediaObjectGUI\rightFloatAlign(), ilPCMediaObjectGUI\saveAliasProperties(), and ilPCInteractiveImageGUI\update().

    {
        return $this->hier_id;
    }

Here is the caller graph for this function:

getPage()

ilPageContentGUI::getPage

(

)

Get page.

Returns

object page object

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

References $pg_obj.

Referenced by ilPCLoginPageElementGUI\__construct(), ilPCQuestionGUI\copyQuestion(), ilPCListGUI\create(), ilPCPlaceHolderGUI\create(), ilPCContentTemplateGUI\create(), ilPCQuestionOverviewGUI\create(), ilPCGridGUI\create(), ilPCMyCoursesGUI\create(), ilPCBlogGUI\create(), ilPCAMDPageListGUI\create(), ilPCLoginPageElementGUI\create(), ilPCContentIncludeGUI\create(), ilPCConsultationHoursGUI\create(), ilPCVerificationGUI\create(), ilPCSkillsGUI\create(), ilPCResourcesGUI\create(), ilPCSourceCodeGUI\create(), ilPCMapGUI\create(), ilPCProfileGUI\create(), ilPCFileListGUI\create(), ilPCQuestionGUI\create(), ilPCInteractiveImageGUI\create(), ilPCSectionGUI\create(), ilPCTabsGUI\create(), ilPCMediaObjectGUI\create(), ilPCParagraphGUI\create(), ilPCPluggedGUI\createElement(), ilPCParagraphGUI\createJS(), ilPCPluggedGUI\edit(), ilPCPluggedGUI\executeCommand(), ilPCDataTableGUI\getNewTableObject(), ilPCTableGUI\getNewTableObject(), ilPCContentTemplateGUI\initForm(), and ilPCAMDPageListGUI\initForm().

    {
        return $this->pg_obj;
    }

Here is the caller graph for this function:

getPageConfig()

ilPageContentGUI::getPageConfig

(

)

Get Page Config.

Returns

object Page Config

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

References $page_config.

Referenced by ilPCSkillsGUI\create(), ilPCPlaceHolderGUI\edit(), ilPCSkillsGUI\edit(), ilPCDataTableGUI\editData(), ilPCQuestionGUI\feedback(), ilPCPlaceHolderGUI\getAvailableTypes(), getBBMenu(), ilPCConsultationHoursGUI\initForm(), ilPCProfileGUI\initForm(), ilPCSectionGUI\initForm(), ilPCSkillsGUI\insert(), ilPCParagraphGUI\insertHelp(), ilPCPlaceHolderGUI\insertPCText(), ilPCSectionGUI\setValuesFromForm(), and ilPCSkillsGUI\update().

    {
        return $this->page_config;
    }

Here is the caller graph for this function:

getStyle()

ilPageContentGUI::getStyle

(

)

Get style object.

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

References $style, ilObject\_lookupType(), and getStyleId().

Referenced by getBBMenu(), and getTemplateOptions().

    {
        if ((!is_object($this->style) || $this->getStyleId() != $this->style->getId()) && $this->getStyleId() > 0) {
            if (ilObject::_lookupType($this->getStyleId()) == "sty") {
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                $this->style = new ilObjStyleSheet($this->getStyleId());
            }
        }
        
        return $this->style;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStyleId()

ilPageContentGUI::getStyleId

(

)

Get Style Id.

Returns

int Style Id

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

Referenced by ilPCDataTableGUI\editData(), getBBMenu(), getCharacteristicsOfCurrentStyle(), ilPCTabsGUI\getFormValues(), ilPCTableGUI\getPropertiesFormValues(), getStyle(), and ilPCTableGUI\renderTable().

    {
        return $this->styleid;
    }

Here is the caller graph for this function:

getTemplateOptions()

ilPageContentGUI::getTemplateOptions

(

$a_type

)

Get table templates.

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

References $a_type, $options, $style, $t, array, and getStyle().

Referenced by ilPCTabsGUI\initForm().

    {
        $style = $this->getStyle();

        if (is_object($style)) {
            $ts = $style->getTemplates($a_type);
            $options = array();
            foreach ($ts as $t) {
                $options["t:" . $t["id"] . ":" . $t["name"]] = $t["name"];
            }
            return $options;
        }
        return array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveAfter()

ilPageContentGUI::moveAfter

(

)

move content element after another element

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

References $_POST, $_SESSION, $error, $ilErr, and $updated.

    {
        $ilErr = $this->error;

        // check if a target is selected
        if (!isset($_POST["target"])) {
            $ilErr->raiseError($this->lng->txt("no_checkbox"), $ilErr->MESSAGE);
        }

        // check if only one target is selected
        if (count($_POST["target"]) > 1) {
            $ilErr->raiseError($this->lng->txt("only_one_target"), $ilErr->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))) {
            $ilErr->raiseError($this->lng->txt("cont_target_within_source"), $ilErr->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") {
            $ilErr->raiseError($this->lng->txt("cont_operation_not_allowed"), $ilErr->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->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

moveBefore()

ilPageContentGUI::moveBefore

(

)

move content element before another element

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

References $_POST, $_SESSION, $error, $ilErr, and $updated.

    {
        $ilErr = $this->error;

        // check if a target is selected
        if (!isset($_POST["target"])) {
            $ilErr->raiseError($this->lng->txt("no_checkbox"), $ilErr->MESSAGE);
        }

        // check if target is within source
        if (count($_POST["target"]) > 1) {
            $ilErr->raiseError($this->lng->txt("only_one_target"), $ilErr->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))) {
            $ilErr->raiseError($this->lng->txt("cont_target_within_source"), $ilErr->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") {
            $ilErr->raiseError($this->lng->txt("cont_operation_not_allowed"), $ilErr->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);
    }

setCharacteristics()

ilPageContentGUI::setCharacteristics

(

$a_chars

)

Set Characteristics.

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

Referenced by ilPCSectionGUI\__construct(), ilPCParagraphGUI\__construct(), ilPCDataTableGUI\__construct(), ilPCTableGUI\__construct(), ilPCMediaObjectGUI\__construct(), ilPCFileListGUI\__construct(), getCharacteristicsOfCurrentStyle(), and ilPCTableGUI\setBasicTableCellStyles().

    {
        $this->chars = $a_chars;
    }

Here is the caller graph for this function:

setContentObject()

ilPageContentGUI::setContentObject

(

$a_val

)

Set content object.

Parameters

object

$a_val

content object

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

    {
        $this->content_obj = $a_val;
    }

setHierId()

ilPageContentGUI::setHierId

(

$a_hier_id

)

get hierarchical id in dom object

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

Referenced by ilPCGridGUI\afterCreation(), ilPCTabsGUI\afterCreation(), ilPCDataTableGUI\afterCreation(), ilPCInteractiveImageGUI\create(), and ilPCMediaObjectGUI\create().

    {
        $this->hier_id = $a_hier_id;
    }

Here is the caller graph for this function:

setPage()

ilPageContentGUI::setPage

(

$a_val

)

Set page.

Parameters

object

$a_val

page object

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

    {
        $this->pg_obj = $a_val;
    }

setPageConfig()

ilPageContentGUI::setPageConfig

(

$a_val

)

Set Page Config.

Parameters

object

Page Config

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

    {
        $this->page_config = $a_val;
    }

setStyleId()

ilPageContentGUI::setStyleId

(

$a_styleid

)

Set Style Id.

Parameters

int

$a_styleid

Style Id

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

    {
        $this->styleid = $a_styleid;
    }

splitPage()

ilPageContentGUI::splitPage

(

)

split page to new page at specified position

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

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

    {
        $ilErr = $this->error;
        
        if ($this->pg_obj->getParentType() != "lm") {
            $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:

splitPageNext()

ilPageContentGUI::splitPageNext

(

)

split page to next page at specified position

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

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

    {
        $ilErr = $this->error;
        
        if ($this->pg_obj->getParentType() != "lm") {
            $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));
    }

Here is the call graph for this function:

Field Documentation

$common_bb_buttons

ilPageContentGUI::$common_bb_buttons

staticprotected

Initial value:

= array(
        "str" => "Strong", "emp" => "Emph", "imp" => "Important",
        "sup" => "Sup", "sub" => "Sub",
        "com" => "Comment",
        "quot" => "Quotation", "acc" => "Accent", "code" => "Code", "tex" => "Tex",
        "fn" => "Footnote", "xln" => "ExternalLink"
        )

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

$content_obj

ilPageContentGUI::$content_obj

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

Referenced by copy(), ilPCMediaObjectGUI\create(), cut(), deactivate(), getContentObject(), and ilPCTabsGUI\setPropertiesByForm().

$ctrl

ilPageContentGUI::$ctrl

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

Referenced by ilPCFileListGUI\addFileItem(), ilPCInteractiveImageGUI\addPopup(), ilPCTabsGUI\addTab(), ilPCTabsGUI\afterCreation(), ilPCDataTableGUI\afterCreation(), ilPCTabsGUI\cancelTabDeletion(), ilPCInteractiveImageGUI\confirmDeleteOverlays(), ilPCInteractiveImageGUI\confirmPopupDeletion(), ilPCTabsGUI\confirmTabsDeletion(), ilPCQuestionGUI\copyQuestion(), ilPCListGUI\create(), ilPCContentIncludeGUI\create(), ilPCInteractiveImageGUI\create(), ilPCParagraphGUI\createJS(), ilPCGridGUI\deleteCells(), ilPCFileListGUI\deleteFileItem(), ilPCInteractiveImageGUI\deleteOverlays(), ilPCInteractiveImageGUI\deletePopups(), ilPCTabsGUI\deleteTabs(), ilPCQuestionOverviewGUI\edit(), ilPCResourcesGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCMapGUI\edit(), ilPCPluggedGUI\edit(), ilPCTableGUI\edit(), ilPCInteractiveImageGUI\edit(), ilPCQuestionGUI\edit(), ilPCTabsGUI\edit(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellSpan(), ilPCTableGUI\editCellStyle(), ilPCTableGUI\editCellWidth(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilPCFileListGUI\editFiles(), ilPCTabsGUI\editProperties(), ilPCQuestionGUI\executeCommand(), ilPCPluggedGUI\executeCommand(), ilPCQuestionGUI\feedback(), getBBMenu(), ilPCInteractiveImageGUI\getTabs(), ilPCFileItemGUI\initAddFileForm(), ilPCInteractiveImageGUI\initAddOverlaysForm(), ilPCFileListGUI\initEditForm(), ilPCContentTemplateGUI\initForm(), ilPCAMDPageListGUI\initForm(), ilPCMyCoursesGUI\initForm(), ilPCConsultationHoursGUI\initForm(), ilPCBlogGUI\initForm(), ilPCTabsGUI\initForm(), ilPCProfileGUI\initForm(), ilPCVerificationGUI\initForm(), ilPCMapGUI\initForm(), ilPCSectionGUI\initForm(), ilPCSkillsGUI\initForm(), ilPCInteractiveImageGUI\initForm(), ilPCBlogGUI\initPostingForm(), ilPCTableGUI\initPropertiesForm(), ilPCInteractiveImageGUI\insert(), ilPCQuestionGUI\insert(), ilPCTableGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCQuestionGUI\insertFromPool(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromWorkspace(), ilPCFileItemGUI\insertFromWorkspace(), ilPCInteractiveImageGUI\listContentPopups(), ilPCInteractiveImageGUI\listOverlayImages(), ilPCQuestionGUI\listPoolQuestions(), ilPCContentIncludeGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), ilPCParagraphGUI\saveJS(), ilPCInteractiveImageGUI\savePopups(), ilPCFileListGUI\savePositions(), ilPCFileListGUI\savePositionsAndClasses(), ilPCListGUI\saveProperties(), ilPCTabsGUI\saveTabs(), ilPCContentIncludeGUI\selectPool(), ilPCQuestionGUI\selectPool(), ilPCTableGUI\setCellPropertiesSubTabs(), ilPCQuestionGUI\setInsertTabs(), ilPCFileListGUI\setItemTabs(), ilPCTableGUI\setTabs(), ilPCDataTableGUI\setTabs(), ilPCFileItemGUI\setTabs(), ilPCQuestionGUI\setTabs(), ilPCFileListGUI\setTabs(), ilPCTabsGUI\setTabs(), ilPCDataTableGUI\tableAction(), ilPCInteractiveImageGUI\update(), ilPCDataTableGUI\updateJS(), and ilPCInteractiveImageGUI\uploadOverlayImages().

$dom

ilPageContentGUI::$dom

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

$error

ilPageContentGUI::$error

protected

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

Referenced by displayValidationError(), moveAfter(), moveBefore(), splitPage(), and splitPageNext().

$hier_id

ilPageContentGUI::$hier_id

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

Referenced by ilPCQuestionGUI\create(), getHierId(), splitPage(), and splitPageNext().

$lng

ilPageContentGUI::$lng

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

Referenced by __construct(), ilPCTableGUI\_addAlignmentCheckboxes(), ilPCTableGUI\_addSpanInputs(), ilPCTableGUI\_addStyleCheckboxes(), ilPCTableGUI\_addWidthInputs(), ilPCSectionGUI\_getStandardCharacteristics(), ilPCParagraphGUI\_getStandardCharacteristics(), ilPCInteractiveImageGUI\addPopup(), ilPCTabsGUI\addTab(), ilPCMediaObjectGUI\changeObjectReference(), ilPCInteractiveImageGUI\confirmDeleteOverlays(), ilPCInteractiveImageGUI\confirmPopupDeletion(), ilPCTabsGUI\confirmTabsDeletion(), copy(), ilPCListGUI\create(), ilPCContentIncludeGUI\create(), ilPCQuestionGUI\create(), ilPCInteractiveImageGUI\create(), ilPCTabsGUI\create(), ilPCMediaObjectGUI\create(), ilPCTableGUI\create(), ilPCFileListGUI\createFileItem(), cut(), ilPCInteractiveImageGUI\deleteOverlays(), ilPCInteractiveImageGUI\deletePopups(), ilPCQuestionOverviewGUI\edit(), ilPCResourcesGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCMapGUI\edit(), ilPCPluggedGUI\edit(), ilPCTableGUI\edit(), ilPCTabsGUI\edit(), ilPCInteractiveImageGUI\editBaseImage(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellSpan(), ilPCTableGUI\editCellStyle(), ilPCTableGUI\editCellWidth(), ilPCDataTableGUI\editData(), ilPCDataTableGUI\editDataCl(), ilPCFileListGUI\editFiles(), ilPCTabsGUI\editProperties(), ilPCMediaObjectGUI\editStyle(), ilPCInteractiveImageGUI\executeCommand(), ilPCQuestionGUI\executeCommand(), ilPCPluggedGUI\executeCommand(), ilPCMediaObjectGUI\executeCommand(), ilPCMediaObjectGUI\getAliasValues(), getBBMenu(), ilPCParagraphGUI\getCharStyleSelector(), ilPCInteractiveImageGUI\getTabs(), ilPCPlaceHolderGUI\getTypeCaptions(), ilPCFileItemGUI\initAddFileForm(), ilPCInteractiveImageGUI\initAddOverlaysForm(), ilPCMediaObjectGUI\initAliasForm(), ilPCFileListGUI\initEditForm(), ilPCContentTemplateGUI\initForm(), ilPCConsultationHoursGUI\initForm(), ilPCBlogGUI\initForm(), ilPCTabsGUI\initForm(), ilPCVerificationGUI\initForm(), ilPCMapGUI\initForm(), ilPCSectionGUI\initForm(), ilPCSkillsGUI\initForm(), ilPCInteractiveImageGUI\initForm(), ilPCListGUI\initListForm(), ilPCTableGUI\initPropertiesForm(), ilPCInteractiveImageGUI\insert(), ilPCQuestionGUI\insert(), ilPCMediaObjectGUI\insert(), ilPCTableGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCMediaObjectGUI\insertFromPool(), ilPCQuestionGUI\insertFromPool(), ilPCParagraphGUI\insertHelp(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilPCInteractiveImageGUI\listContentPopups(), ilPCInteractiveImageGUI\listOverlayImages(), ilPCQuestionGUI\listPoolQuestions(), ilPCFileItemGUI\newFileItem(), ilPCPlaceHolderGUI\propertyGUI(), ilPCInteractiveImageGUI\savePopups(), ilPCListGUI\saveProperties(), ilPCTabsGUI\saveTabs(), ilPCMediaObjectGUI\selectObjectReference(), ilPCTableGUI\setAlignment(), ilPCTableGUI\setCellPropertiesSubTabs(), ilPCQuestionGUI\setInsertTabs(), ilPCTableGUI\setSpans(), ilPCTableGUI\setStyles(), ilPCTableGUI\setTabs(), ilPCFileListGUI\setTabs(), ilPCQuestionGUI\setTabs(), ilPCTabsGUI\setTabs(), ilPCTableGUI\setWidths(), ilPCPlaceHolderGUI\textCOSelectionGUI(), ilPCDataTableGUI\update(), ilPCInteractiveImageGUI\update(), ilPCDataTableGUI\updateJS(), and ilPCInteractiveImageGUI\uploadOverlayImages().

$log

ilPageContentGUI::$log

protected

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

$page_config

ilPageContentGUI::$page_config = null

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

Referenced by getPageConfig().

$pg_obj

ilPageContentGUI::$pg_obj

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

Referenced by getPage().

$return_location

ilPageContentGUI::$return_location

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

$style_selector_reset

ilPageContentGUI::$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"

static

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

$target_script

ilPageContentGUI::$target_script

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

$tpl

ilPageContentGUI::$tpl

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

Referenced by __construct(), ilPCInteractiveImageGUI\addOverlayImages(), ilPCInteractiveImageGUI\confirmDeleteOverlays(), ilPCInteractiveImageGUI\confirmPopupDeletion(), ilPCTabsGUI\confirmTabsDeletion(), ilPCListGUI\create(), ilPCContentTemplateGUI\create(), ilPCMapGUI\create(), ilPCQuestionOverviewGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCResourcesGUI\edit(), ilPCMyCoursesGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCBlogGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCMapGUI\edit(), ilPCProfileGUI\edit(), ilPCVerificationGUI\edit(), ilPCSkillsGUI\edit(), ilPCSectionGUI\edit(), ilPCPluggedGUI\edit(), ilPCParagraphGUI\edit(), ilPCTableGUI\edit(), ilPCInteractiveImageGUI\edit(), ilPCTabsGUI\edit(), ilPCMediaObjectGUI\editAlias(), ilPCInteractiveImageGUI\editBaseImage(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellSpan(), ilPCTableGUI\editCellStyle(), ilPCTableGUI\editCellWidth(), ilPCDataTableGUI\editDataCl(), ilPCFileListGUI\editFiles(), ilPCBlogGUI\editPosting(), ilPCTabsGUI\editProperties(), ilPCMediaObjectGUI\editStyle(), ilPCInteractiveImageGUI\executeCommand(), ilPCQuestionGUI\executeCommand(), ilPCMediaObjectGUI\executeCommand(), ilPCListGUI\getValues(), ilPCTabsGUI\initForm(), ilPCTableGUI\initPropertiesForm(), ilPCMyCoursesGUI\insert(), ilPCAMDPageListGUI\insert(), ilPCContentTemplateGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCBlogGUI\insert(), ilPCTabsGUI\insert(), ilPCMapGUI\insert(), ilPCProfileGUI\insert(), ilPCVerificationGUI\insert(), ilPCSkillsGUI\insert(), ilPCInteractiveImageGUI\insert(), ilPCMediaObjectGUI\insert(), ilPCTableGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCMediaObjectGUI\insertFromPool(), ilPCQuestionGUI\insertFromPool(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromWorkspace(), ilPCFileItemGUI\insertFromWorkspace(), ilPCBlogGUI\insertPosting(), ilPCResourcesGUI\insertResourcesIntoPageContent(), ilPCInteractiveImageGUI\listContentPopups(), ilPCInteractiveImageGUI\listOverlayImages(), ilPCQuestionGUI\listPoolQuestions(), ilPCContentIncludeGUI\poolSelection(), ilPCMediaObjectGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), ilPCListGUI\saveProperties(), and ilPCMapGUI\update().

$updated

ilPageContentGUI::$updated

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

Referenced by cut(), deactivate(), delete(), moveAfter(), and moveBefore().

---

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

• Services/COPage/classes/class.ilPageContentGUI.php