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

Inheritance diagram for ilPageContentGUI:

Collaboration diagram for ilPageContentGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")

	setContentObject (ilPageContent $a_val)

	getContentObject ()

	setPage (ilPageObject $a_val)

	getPage ()

	setPageConfig (ilPageConfig $a_val)

	getPageConfig ()

	setStyleId (int $a_styleid)

	getStyleId ()

	getStyle ()

	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...

	setCharacteristics (array $a_chars)

	getCharacteristics ()

	getHierId ()

	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...

	delete ()

	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 ()

	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 (string $a_type="")
	Get table templates. More...

Static Public Member Functions
static	_getCommonBBButtons ()

Data Fields
ilPageContent	$content_obj

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilPageObject	$pg_obj

string	$hier_id = ""

php4DOMDocument	$dom

	$updated

string	$target_script = ""

string	$return_location = ""

ilPageConfig	$page_config = null

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

Protected Member Functions
	redirectToParent (string $hier_id="")

	getParentReturn (string $hier_id="")

	updateAndReturn ()

	setCurrentTextLang (string $lang_key)

	getCurrentTextLang ()

Protected Attributes
EditSessionRepository	$edit_repo

string	$pc_id = ""

array	$chars

ilObjStyleSheet	$style = null

ilLogger	$log

int	$styleid = 0

EditGUIRequest	$request

string	$sub_command = ""

int	$requested_ref_id = 0

Style Content CharacteristicManager	$char_manager

Static Protected Attributes
static array	$common_bb_buttons

Detailed Description

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilPageContentGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id = `""`,
		string	$a_pc_id = `"0"`
	)

Reimplemented in ilPCAMDFormGUI, ilPCConsultationHoursGUI, ilPCMyCoursesGUI, ilPCAMDPageListGUI, ilPCBlogGUI, ilPCContentIncludeGUI, ilPCContentTemplateGUI, ilPCDataTableGUI, ilPCFileItemGUI, ilPCFileListGUI, ilPCGridCellGUI, ilPCGridGUI, ilPCInteractiveImageGUI, ilPCListGUI, ilPCListItemGUI, ilPCLoginPageElementGUI, ilPCMapGUI, ilPCMediaObjectGUI, ilPCParagraphGUI, ilPCPlaceHolderGUI, ilPCProfileGUI, ilPCQuestionGUI, ilPCQuestionOverviewGUI, ilPCResourcesGUI, ilPCSkillsGUI, ilPCSourceCodeGUI, ilPCTableDataGUI, ilPCTableGUI, ilPCTabsGUI, and ilPCSectionGUI.

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

      {
        global $DIC;
 
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
 
        $this->log = ilLoggerFactory::getLogger('copg');
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $lng;
        $this->pg_obj = $a_pg_obj;
        $this->ctrl = $ilCtrl;
        $this->content_obj = $a_content_obj;
        $service = $DIC->copage()->internal();
        $this->request = $service
            ->gui()
            ->pc()
            ->editRequest();
        $this->edit_repo = $service
            ->repo()
            ->edit();
        $this->sub_command = $this->request->getSubCmd();
        $this->requested_ref_id = $this->request->getRefId();
 
        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();
        }
    }

References $DIC, $lng, $service, ILIAS\Repository\ctrl(), ilPageObject\getDom(), ilLoggerFactory\getLogger(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ _getCommonBBButtons()

static ilPageContentGUI::_getCommonBBButtons ( )

static

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

                                                : array
    {
        return self::$common_bb_buttons;
    }

References $common_bb_buttons.

Referenced by ilObjAdvancedEditingGUI\initPageEditorForm(), ilObjAdvancedEditingGUI\savePageEditorSettingsObject(), and ilPCParagraphGUI\xml2outputJS().

Here is the caller graph for this function:

◆ cancel()

ilPageContentGUI::cancel ( )

Cancel.

Reimplemented in ilPCParagraphGUI, and ilPCPlaceHolderGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cancelCreate()

ilPageContentGUI::cancelCreate ( )

cancel creating page content

Reimplemented in ilPCSourceCodeGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cancelUpdate()

ilPageContentGUI::cancelUpdate ( )

cancel update

Reimplemented in ilPCSourceCodeGUI.

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ copy()

ilPageContentGUI::copy ( )

Copy single element.

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

                          : void
    {
        $this->pg_obj->copyContents(array($this->hier_id . ":" . $this->pc_id));
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cut()

ilPageContentGUI::cut ( )

Cut single element.

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

                         : void
    {
        $updated = $this->pg_obj->cutContents(array($this->hier_id . ":" . $this->pc_id));
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
 
        $this->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References $updated, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ deactivate()

ilPageContentGUI::deactivate ( )

gui function set enabled if is not enabled and vice versa

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

                                : void
    {
        $obj = &$this->content_obj;
 
        if ($obj->isEnabled()) {
            $obj->disable();
        } else {
            $obj->enable();
        }
        $this->updateAndReturn();
    }

References $content_obj, ilPageContent\disable(), and updateAndReturn().

Here is the call graph for this function:

◆ delete()

ilPageContentGUI::delete ( )

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

                            : void
    {
        $updated = $this->pg_obj->deleteContent($this->hier_id);
        if ($updated !== true) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References $updated, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ displayValidationError()

ilPageContentGUI::displayValidationError ( )

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

                                            : void
    {
        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 />";
                }
            }
            $this->tpl->setOnScreenMessage('failure', $error_str);
        } elseif ($this->updated != "" && $this->updated !== true) {
            $this->tpl->setOnScreenMessage('failure', "<b>Error(s):</b><br />" .
                $this->updated);
        }
    }

Referenced by ilPCContentTemplateGUI\create(), ilPCMapGUI\create(), ilPCListGUI\edit(), ilPCMapGUI\edit(), ilPCSourceCodeGUI\edit(), ilPCVerificationGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCPluggedGUI\edit(), ilPCResourcesGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCMyCoursesGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCBlogGUI\edit(), ilPCProfileGUI\edit(), ilPCSkillsGUI\edit(), ilPCLearningHistoryGUI\edit(), ilPCAMDFormGUI\editPortfolio(), ilPCAMDFormGUI\editTemplate(), ilPCContentTemplateGUI\insert(), ilPCGridGUI\insert(), ilPCListGUI\insert(), ilPCMapGUI\insert(), ilPCSourceCodeGUI\insert(), ilPCVerificationGUI\insert(), ilPCAMDFormGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCMyCoursesGUI\insert(), ilPCAMDPageListGUI\insert(), ilPCBlogGUI\insert(), ilPCFileListGUI\insert(), ilPCProfileGUI\insert(), ilPCSkillsGUI\insert(), ilPCLearningHistoryGUI\insert(), ilPCQuestionGUI\insert(), ilPCFileItemGUI\newItemAfter(), ilPCFileItemGUI\newItemBefore(), ilPCFileListGUI\selectFile(), and ilPCMapGUI\update().

Here is the caller graph for this function:

◆ getCharacteristics()

ilPageContentGUI::getCharacteristics ( )

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

                                        : array
    {
        return $this->chars ?? [];
    }

◆ getCharacteristicsOfCurrentStyle()

ilPageContentGUI::getCharacteristicsOfCurrentStyle ( array $a_type )

Get characteristics of current style and call setCharacteristics, if style is given.

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

                                                                   : void
    {
        global $DIC;
        $service = $DIC->contentStyle()->internal();
        $access_manager = $service->domain()->access(
            $this->requested_ref_id,
            $DIC->user()->getId()
        );
 
        if ($this->getStyleId() > 0 &&
            ilObject::_lookupType($this->getStyleId()) == "sty") {
            $char_manager = $service->domain()->characteristic(
                $this->getStyleId(),
                $access_manager
            );
 
            if (!is_array($a_type)) {
                $a_type = array($a_type);
            }
            $chars = $char_manager->getByTypes($a_type, false, false);
            $new_chars = array();
            foreach ($chars as $char) {
                if (($this->chars[$char->getCharacteristic()] ?? "") != "") {   // keep lang vars for standard chars
                    $title = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                    if ($title == "") {
                        $title = $this->chars[$char->getCharacteristic()];
                    }
                    $new_chars[$char->getCharacteristic()] = $title;
                } else {
                    $new_chars[$char->getCharacteristic()] = $char_manager->getPresentationTitle(
                        $char->getType(),
                        $char->getCharacteristic()
                    );
                }
            }
            $this->setCharacteristics($new_chars);
        }
    }

References $char_manager, $chars, $DIC, $service, ilObject\_lookupType(), getStyleId(), and setCharacteristics().

Referenced by ilPCDataTableGUI\executeCommand(), ilPCFileListGUI\executeCommand(), ilPCSectionGUI\executeCommand(), ilPCTableGUI\executeCommand(), and ilPCSectionGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContentObject()

ilPageContentGUI::getContentObject ( )

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

                                      : ?ilPageContent
    {
        return $this->content_obj;
    }

References $content_obj.

◆ getCurrentTextLang()

ilPageContentGUI::getCurrentTextLang ( )

protected

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

                                           : string
    {
        return $this->edit_repo->getTextLang($this->requested_ref_id);
    }

Referenced by ilPCSourceCodeGUI\insert().

Here is the caller graph for this function:

◆ getHierId()

ilPageContentGUI::getHierId ( )

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

                               : string
    {
        return $this->hier_id;
    }

References $hier_id.

◆ getPage()

ilPageContentGUI::getPage ( )

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

                             : ilPageObject
    {
        return $this->pg_obj;
    }

References $pg_obj.

Referenced by ilPCLoginPageElementGUI\__construct(), ilPCQuestionGUI\copyQuestion(), ilPCAMDFormGUI\create(), ilPCConsultationHoursGUI\create(), ilPCMyCoursesGUI\create(), ilPCAMDPageListGUI\create(), ilPCBlogGUI\create(), ilPCContentIncludeGUI\create(), ilPCContentTemplateGUI\create(), ilPCGridGUI\create(), ilPCListGUI\create(), ilPCLoginPageElementGUI\create(), ilPCMapGUI\create(), ilPCPlaceHolderGUI\create(), ilPCProfileGUI\create(), ilPCQuestionGUI\create(), ilPCResourcesGUI\create(), ilPCSourceCodeGUI\create(), ilPCVerificationGUI\create(), ilPCLearningHistoryGUI\create(), ilPCPluggedGUI\createElement(), ilPCCurriculumGUI\createNewPageContent(), ilPCLauncherGUI\createNewPageContent(), ilPCPluggedGUI\edit(), ilPCPluggedGUI\executeCommand(), ilPCAMDFormGUI\getAdvRecords(), ilPCDataTableGUI\getNewTableObject(), ilPCAMDFormGUI\getPortfolioForm(), ilPCContentTemplateGUI\initForm(), ilPCAMDPageListGUI\initForm(), and ilPCAMDFormGUI\isTemplate().

Here is the caller graph for this function:

◆ getPageConfig()

ilPageContentGUI::getPageConfig ( )

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

                                   : ilPageConfig
    {
        return $this->page_config;
    }

References $page_config.

Referenced by ilPCPlaceHolderGUI\edit(), ilPCSkillsGUI\edit(), ilPCQuestionGUI\feedback(), ilPCConsultationHoursGUI\initForm(), ilPCProfileGUI\initForm(), and ilPCSkillsGUI\insert().

Here is the caller graph for this function:

◆ getParentReturn()

ilPageContentGUI::getParentReturn ( string $hier_id = "" )

protected

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

                                                            : string
    {
        if ($hier_id == "") {
            $hier_id = $this->hier_id;
        }
        $ilCtrl = $this->ctrl;
        $pcid = $this->pg_obj->getPCIdForHierId($hier_id);
        return $ilCtrl->getParentReturn($this) . "#add" . $pcid;
    }

References $ctrl, $hier_id, and ilCtrl\getParentReturn().

Here is the call graph for this function:

◆ getStyle()

ilPageContentGUI::getStyle ( )

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

                              : ?ilObjStyleSheet
    {
        if ((!is_object($this->style) || $this->getStyleId() != $this->style->getId()) && $this->getStyleId() > 0) {
            if (ilObject::_lookupType($this->getStyleId()) == "sty") {
                $this->style = new ilObjStyleSheet($this->getStyleId());
            }
        }
        return $this->style;
    }

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

Referenced by getTemplateOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleId()

ilPageContentGUI::getStyleId ( )

Reimplemented in ilPCPlaceHolderGUI.

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

                                : int
    {
        return $this->styleid;
    }

References $styleid.

Referenced by getCharacteristicsOfCurrentStyle(), and getStyle().

Here is the caller graph for this function:

◆ getTemplateOptions()

ilPageContentGUI::getTemplateOptions ( string $a_type = "" )

Get table templates.

Reimplemented in ilPCTableGUI.

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

                                                           : array
    {
        $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();
    }

References $style, getStyle(), and ilObjStyleSheet\getTemplates().

Here is the call graph for this function:

◆ moveAfter()

ilPageContentGUI::moveAfter ( )

move content element after another element

Exceptions

ilCOPagePCEditException

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

                               : void
    {
        $target = $this->request->getStringArray("target");
        // check if a target is selected
        if (count($target) == 0) {
            throw new ilCOPagePCEditException(
                $this->lng->txt("no_checkbox")
            );
        }
 
        // check if only one target is selected
        if (count($target) > 1) {
            throw new ilCOPagePCEditException(
                $this->lng->txt("only_one_target")
            );
        }
 
        $a_hid = explode(":", $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))) {
            throw new ilCOPagePCEditException($this->lng->txt("cont_target_within_source"));
        }
 
        // 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") {
            throw new ilCOPagePCEditException($this->lng->txt("cont_operation_not_allowed"));
        }
 
        // 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) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->log->debug("return to parent jump" . $this->hier_id);
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References $updated, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ moveBefore()

ilPageContentGUI::moveBefore ( )

move content element before another element

Exceptions

ilCOPagePCEditException

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

                                : void
    {
        $target = $this->request->getStringArray("target");
        // check if a target is selected
        if (count($target) == 0) {
            throw new ilCOPagePCEditException($this->lng->txt("no_checkbox"));
        }
 
        // check if target is within source
        if (count($target) > 1) {
            throw new ilCOPagePCEditException($this->lng->txt("only_one_target"));
        }
 
        $a_hid = explode(":", $target[0]);
 
        // check if target is within source
        if ($this->hier_id == substr($a_hid[0], 0, strlen($this->hier_id))) {
            throw new ilCOPagePCEditException($this->lng->txt("cont_target_within_source"));
        }
 
        // 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") {
            throw new ilCOPagePCEditException($this->lng->txt("cont_operation_not_allowed"));
        }
 
        // 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) {
            $this->edit_repo->setPageError($updated);
        } else {
            $this->edit_repo->clearPageError();
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

References $updated, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ redirectToParent()

ilPageContentGUI::redirectToParent ( string $hier_id = "" )

protected

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

                                                             : void
    {
        $ilCtrl = $this->ctrl;
        if ($hier_id == "") {
            $hier_id = $this->hier_id;
        }
        $pcid = $this->pg_obj->getPCIdForHierId($hier_id);
        $ilCtrl->returnToParent($this, "add" . $pcid);
    }

References $ctrl, and $hier_id.

Referenced by updateAndReturn().

Here is the caller graph for this function:

◆ setCharacteristics()

ilPageContentGUI::setCharacteristics ( array $a_chars )

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

                                                      : void
    {
        $this->chars = $a_chars;
    }

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

Here is the caller graph for this function:

◆ setContentObject()

ilPageContentGUI::setContentObject ( ilPageContent $a_val )

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

                                                          : void
    {
        $this->content_obj = $a_val;
    }

◆ setCurrentTextLang()

ilPageContentGUI::setCurrentTextLang ( string $lang_key )

protected

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

                                                           : void
    {
        $this->edit_repo->setTextLang($this->requested_ref_id, $lang_key);
    }

Referenced by ilPCSourceCodeGUI\create().

Here is the caller graph for this function:

◆ setHierId()

ilPageContentGUI::setHierId ( string $a_hier_id )

set hierarchical id in dom object

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

                                                : void
    {
        $this->hier_id = $a_hier_id;
    }

Referenced by ilPCGridGUI\afterCreation().

Here is the caller graph for this function:

◆ setPage()

ilPageContentGUI::setPage ( ilPageObject $a_val )

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

                                                : void
    {
        $this->pg_obj = $a_val;
    }

◆ setPageConfig()

ilPageContentGUI::setPageConfig ( ilPageConfig $a_val )

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

                                                      : void
    {
        $this->page_config = $a_val;
    }

◆ setStyleId()

ilPageContentGUI::setStyleId ( int $a_styleid )

Reimplemented in ilPCPlaceHolderGUI.

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

                                              : void
    {
        $this->styleid = $a_styleid;
    }

◆ splitPage()

ilPageContentGUI::splitPage ( )

split page to new page at specified position

Exceptions

ilCOPagePCEditException

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

                               : void
    {
        if ($this->pg_obj->getParentType() != "lm") {
            throw new ilCOPagePCEditException("Split method called for wrong parent type (" .
                $this->pg_obj->getParentType() . ")");
        } 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));
    }

References ilLMPageObject\_splitPage(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ splitPageNext()

ilPageContentGUI::splitPageNext ( )

split page to next page at specified position

Exceptions

ilCOPagePCEditException

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

                                   : void
    {
        if ($this->pg_obj->getParentType() != "lm") {
            throw new ilCOPagePCEditException("Split method called for wrong parent type (" .
            $this->pg_obj->getParentType() . ")");
        } 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));
    }

References ilLMPageObject\_splitPageNext(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ updateAndReturn()

ilPageContentGUI::updateAndReturn ( )

protected

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

                                        : void
    {
        $up = $this->pg_obj->update();
        if ($up === true) {
            $this->edit_repo->clearPageError();
        } else {
            $this->edit_repo->setPageError($this->pg_obj->update());
        }
        $this->redirectToParent();
    }

References redirectToParent().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $char_manager

Style Content CharacteristicManager ilPageContentGUI::$char_manager

protected

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

Referenced by ilPCParagraphGUI\_getCharacteristics(), ilPCSectionGUI\_getCharacteristics(), and getCharacteristicsOfCurrentStyle().

◆ $chars

array ilPageContentGUI::$chars

protected

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

Referenced by ilPCParagraphGUI\_getCharacteristics(), ilPCSectionGUI\_getCharacteristics(), and getCharacteristicsOfCurrentStyle().

◆ $common_bb_buttons

array 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 56 of file class.ilPageContentGUI.php.

Referenced by _getCommonBBButtons().

◆ $content_obj

ilPageContent ilPageContentGUI::$content_obj

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

Referenced by deactivate(), getContentObject(), and ilPCAMDFormGUI\getPortfolioForm().

◆ $ctrl

ilCtrl ilPageContentGUI::$ctrl

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

Referenced by ilPCDataTableGUI\afterCreation(), ilPCQuestionGUI\copyQuestion(), ilPCGridGUI\deleteCells(), ilPCQuestionGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCPluggedGUI\edit(), ilPCResourcesGUI\edit(), ilPCPluggedGUI\executeCommand(), ilPCQuestionGUI\executeCommand(), ilPCQuestionGUI\feedback(), getParentReturn(), ilPCAMDFormGUI\getPortfolioForm(), ilPCAMDFormGUI\getTemplateForm(), ilPCFileItemGUI\initAddFileForm(), ilPCMyCoursesGUI\initForm(), ilPCContentTemplateGUI\initForm(), ilPCConsultationHoursGUI\initForm(), ilPCAMDPageListGUI\initForm(), ilPCBlogGUI\initForm(), ilPCProfileGUI\initForm(), ilPCLearningHistoryGUI\initForm(), ilPCMapGUI\initForm(), ilPCQuestionGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromWorkspace(), ilPCQuestionGUI\listPoolQuestions(), ilPCContentIncludeGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), redirectToParent(), ilPCContentIncludeGUI\selectPool(), ilPCQuestionGUI\selectPool(), ilPCQuestionGUI\setInsertTabs(), ilPCQuestionGUI\setTabs(), ilPCFileItemGUI\setTabs(), ilPCDataTableGUI\tableAction(), and ilPCDataTableGUI\updateJS().

◆ $dom

php4DOMDocument ilPageContentGUI::$dom

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

◆ $edit_repo

EditSessionRepository ilPageContentGUI::$edit_repo

protected

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

◆ $hier_id

string ilPageContentGUI::$hier_id = ""

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

Referenced by getHierId(), getParentReturn(), and redirectToParent().

◆ $lng

ilLanguage ilPageContentGUI::$lng

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

Referenced by __construct(), ilPCParagraphGUI\_getStandardCharacteristics(), ilPCSectionGUI\_getStandardCharacteristics(), ilPCAMDFormGUI\create(), ilPCLoginPageElementGUI\edit(), ilPCResourcesGUI\edit(), ilPCPluggedGUI\executeCommand(), ilPCLearningHistoryGUI\getPlaceholderPresentation(), ilPCAMDFormGUI\getPortfolioForm(), ilPCInteractiveImageGUI\getTabs(), ilPCFileItemGUI\initAddFileForm(), ilPCGridGUI\initCreationForm(), ilPCContentTemplateGUI\initForm(), ilPCLearningHistoryGUI\initForm(), ilPCMapGUI\initForm(), ilPCQuestionGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCQuestionGUI\listPoolQuestions(), ilPCFileItemGUI\newFileItem(), ilPCQuestionGUI\setInsertTabs(), ilPCAMDFormGUI\update(), ilPCDataTableGUI\update(), ilPCAMDFormGUI\updateAdvancedMetaData(), and ilPCDataTableGUI\updateJS().

◆ $log

ilLogger ilPageContentGUI::$log

protected

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

◆ $page_config

ilPageConfig ilPageContentGUI::$page_config = null

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

Referenced by getPageConfig().

◆ $pc_id

string ilPageContentGUI::$pc_id = ""

protected

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

Referenced by ilPCMediaObjectGUI\__construct().

◆ $pg_obj

ilPageObject ilPageContentGUI::$pg_obj

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

Referenced by getPage().

◆ $request

EditGUIRequest ilPageContentGUI::$request

protected

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

Referenced by ilPCMediaObjectGUI\__construct(), ilPCParagraphGUI\_getCharacteristics(), ilPCSectionGUI\_getCharacteristics(), ilPCAMDFormGUI\create(), and ilPCAMDFormGUI\update().

◆ $requested_ref_id

int ilPageContentGUI::$requested_ref_id = 0

protected

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

Referenced by ilPCParagraphGUI\_getCharacteristics(), ilPCSectionGUI\_getCharacteristics(), ilPCResourcesGUI\edit(), and ilPCAMDFormGUI\getAdvRecords().

◆ $return_location

string ilPageContentGUI::$return_location = ""

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

◆ $style

ilObjStyleSheet ilPageContentGUI::$style = null

protected

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

Referenced by ilPCSectionGUI\_getCharacteristics(), getStyle(), and getTemplateOptions().

◆ $style_selector_reset

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

static

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

◆ $styleid

int ilPageContentGUI::$styleid = 0

protected

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

Referenced by getStyleId(), and ilPCPlaceHolderGUI\getStyleId().

◆ $sub_command

string ilPageContentGUI::$sub_command = ""

protected

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

Referenced by ilPCQuestionGUI\executeCommand(), ilPCMediaObjectGUI\insert(), ilPCFileListGUI\insert(), ilPCFileItemGUI\newItemAfter(), and ilPCFileItemGUI\newItemBefore().

◆ $target_script

string ilPageContentGUI::$target_script = ""

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

◆ $tpl

ilGlobalTemplateInterface ilPageContentGUI::$tpl

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

Referenced by ilPCAMDFormGUI\create(), ilPCContentTemplateGUI\create(), ilPCListGUI\create(), ilPCMapGUI\create(), ilPCMapGUI\edit(), ilPCLoginPageElementGUI\edit(), ilPCPluggedGUI\edit(), ilPCResourcesGUI\edit(), ilPCConsultationHoursGUI\edit(), ilPCMyCoursesGUI\edit(), ilPCAMDPageListGUI\edit(), ilPCBlogGUI\edit(), ilPCProfileGUI\edit(), ilPCSkillsGUI\edit(), ilPCLearningHistoryGUI\edit(), ilPCAMDFormGUI\editPortfolio(), ilPCAMDFormGUI\editTemplate(), ilPCContentTemplateGUI\insert(), ilPCMapGUI\insert(), ilPCAMDFormGUI\insert(), ilPCConsultationHoursGUI\insert(), ilPCMyCoursesGUI\insert(), ilPCAMDPageListGUI\insert(), ilPCBlogGUI\insert(), ilPCProfileGUI\insert(), ilPCSkillsGUI\insert(), ilPCLearningHistoryGUI\insert(), ilPCContentIncludeGUI\insertFromPool(), ilPCFileItemGUI\insertFromRepository(), ilPCFileListGUI\insertFromRepository(), ilPCFileItemGUI\insertFromWorkspace(), ilPCQuestionGUI\listPoolQuestions(), ilPCContentIncludeGUI\poolSelection(), ilPCQuestionGUI\poolSelection(), ilPCListGUI\saveProperties(), ilPCAMDFormGUI\update(), and ilPCMapGUI\update().

◆ $updated

ilPageContentGUI::$updated

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

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

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

Services/COPage/classes/class.ilPageContentGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCommonBBButtons()

◆ cancel()

◆ cancelCreate()

◆ cancelUpdate()

◆ copy()

◆ cut()

◆ deactivate()

◆ delete()

◆ displayValidationError()

◆ getCharacteristics()

◆ getCharacteristicsOfCurrentStyle()

◆ getContentObject()

◆ getCurrentTextLang()

◆ getHierId()

◆ getPage()

◆ getPageConfig()

◆ getParentReturn()

◆ getStyle()

◆ getStyleId()

◆ getTemplateOptions()

◆ moveAfter()

◆ moveBefore()

◆ redirectToParent()

◆ setCharacteristics()

◆ setContentObject()

◆ setCurrentTextLang()

◆ setHierId()

◆ setPage()

◆ setPageConfig()

◆ setStyleId()

◆ splitPage()

◆ splitPageNext()

◆ updateAndReturn()

Field Documentation

◆ $char_manager

◆ $chars

◆ $common_bb_buttons

◆ $content_obj

◆ $ctrl

◆ $dom

◆ $edit_repo

◆ $hier_id

◆ $lng

◆ $log

◆ $page_config

◆ $pc_id

◆ $pg_obj

◆ $request

◆ $requested_ref_id

◆ $return_location

◆ $style

◆ $style_selector_reset

◆ $styleid

◆ $sub_command

◆ $target_script

◆ $tpl

◆ $updated