ilPCSectionGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCSectionGUI:

Collaboration diagram for ilPCSectionGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj=null, string $a_hier_id="", string $a_pc_id="")
	getHTML (array $params)
	checkInput (ilPropertyFormGUI $form)
	executeCommand ()
	insert (?ilPropertyFormGUI $a_form=null)
	edit (bool $a_insert=false, ?ilPropertyFormGUI $a_form=null)
	initForm (bool $a_insert=false)
	create ()
	update ()
	setValuesFromForm (ilPropertyFormGUI $form)
Public Member Functions inherited from ilPageContentGUI
	__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 ()
	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	_getStandardCharacteristics ()
static	_getCharacteristics (int $a_style_id)
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Additional Inherited Members
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
array bool null	$updated = null
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning User Interface for Section Editing

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPCSectionGUI: ilPropertyFormGUI

Definition at line 24 of file class.ilPCSectionGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCSectionGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj = null,
		string	$a_hier_id = "",
		string	$a_pc_id = ""
	)

Reimplemented from ilPageContentGUI.

Definition at line 26 of file class.ilPCSectionGUI.php.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), _getStandardCharacteristics(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilPageContentGUI\setCharacteristics().

Here is the call graph for this function:

Member Function Documentation

_getCharacteristics()

static ilPCSectionGUI::_getCharacteristics ( int  $a_style_id )

static

Definition at line 141 of file class.ilPCSectionGUI.php.

                                                               : array
    {
        global $DIC;
 
        $service = $DIC->contentStyle()->internal();
        $request = $DIC->copage()->internal()
                       ->gui()
                       ->pc()
                       ->editRequest();
        $requested_ref_id = $request->getRefId();
        $access_manager = $service->domain()->access(
            $requested_ref_id,
            $DIC->user()->getId()
        );
        $char_manager = $service->domain()->characteristic(
            $a_style_id,
            $access_manager
        );
 
        $std_chars = ilPCSectionGUI::_getStandardCharacteristics();
        $chars = $std_chars;
        if ($a_style_id > 0 &&
            ilObject::_lookupType($a_style_id) == "sty") {
            $style = new ilObjStyleSheet($a_style_id);
            $chars = $style->getCharacteristics("section");
            $new_chars = array();
            foreach ($chars as $char) {
                if ($char_manager->isOutdated("section", $char)) {
                    continue;
                }
                if (($std_chars[$char] ?? "") != "") {  // keep lang vars for standard chars
                    $new_chars[$char] = $std_chars[$char];
                } else {
                    $new_chars[$char] = $char;
                }
                asort($new_chars);
            }
            $chars = $new_chars;
        }
        return $chars;
    }

References ilPageContentGUI\$char_manager, ilPageContentGUI\$chars, $DIC, ilPageContentGUI\$request, ilPageContentGUI\$requested_ref_id, $service, ilPageContentGUI\$style, _getStandardCharacteristics(), ilObject\_lookupType(), and ilObjStyleSheet\getCharacteristics().

Here is the call graph for this function:

_getStandardCharacteristics()

static ilPCSectionGUI::_getStandardCharacteristics ( )

static

Definition at line 113 of file class.ilPCSectionGUI.php.

                                                        : array
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        return array("Block" => $lng->txt("cont_Block"),
            "Mnemonic" => $lng->txt("cont_Mnemonic"),
            "Remark" => $lng->txt("cont_Remark"),
            "Example" => $lng->txt("cont_Example"),
            "Additional" => $lng->txt("cont_Additional"),
            "Special" => $lng->txt("cont_Special"),
 
            "Attention" => $lng->txt("cont_Attention"),
            "Background" => $lng->txt("cont_Background"),
            "Citation" => $lng->txt("cont_Citation"),
            "Confirmation" => $lng->txt("cont_Confirmation"),
            "Information" => $lng->txt("cont_Information"),
            "Interaction" => $lng->txt("cont_Interaction"),
            "Link" => $lng->txt("cont_char_link"),
            "Literature" => $lng->txt("cont_Literature"),
            "Separator" => $lng->txt("cont_Separator"),
            "StandardCenter" => $lng->txt("cont_StandardCenter"),
 
            "Excursus" => $lng->txt("cont_Excursus"),
            "AdvancedKnowledge" => $lng->txt("cont_AdvancedKnowledge"));
    }

References $DIC, ilPageContentGUI\$lng, and ilLanguage\txt().

Referenced by __construct(), and _getCharacteristics().

Here is the call graph for this function:

Here is the caller graph for this function:

checkInput()

ilPCSectionGUI::checkInput

(

ilPropertyFormGUI

$form

)

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

                                                       : bool
    {
        $ret = $form->checkInput();
        if ($ret) {
            $from = $form->getItemByPostVar("active_from")->getDate();
            $to = $form->getItemByPostVar("active_to")->getDate();
            if ($from && $to && $from->get(IL_CAL_UNIX) > $to->get(IL_CAL_UNIX)) {
                $form->getItemByPostVar("active_to")->setAlert(
                    $this->lng->txt("copg_active_to_small")
                );
                $ret = false;
            }
        }
        return $ret;
    }

References ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilPCSectionGUI::create

(

)

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

                            : void
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $this->content_obj = new ilPCSection($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
 
            $this->setValuesFromForm($form);
 
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
 
        $this->insert($form);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

edit()

ilPCSectionGUI::edit	(	bool	$a_insert = false,
		?ilPropertyFormGUI	$a_form = null
	)

Definition at line 218 of file class.ilPCSectionGUI.php.

     : void {
        $tpl = $this->tpl;
 
        $this->displayValidationError();
 
        if (!$a_form) {
            $a_form = $this->initForm($a_insert);
        }
 
        $tpl->setContent($a_form->getHTML());
    }

Referenced by insert().

Here is the caller graph for this function:

executeCommand()

ilPCSectionGUI::executeCommand

(

)

Returns

mixed

Exceptions

ilCtrlException

Definition at line 187 of file class.ilPCSectionGUI.php.

                                    : mixed
    {
        $ret = "";
 
        $this->getCharacteristicsOfCurrentStyle(["section"]);   // scorm-2004
 
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);
 
        // get current command
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case "ilpropertyformgui":
                $form = $this->initForm(true);
                $this->ctrl->forwardCommand($form);
                break;
 
            default:
                $ret = $this->$cmd();
                break;
        }
 
        return $ret;
    }

References ILIAS\Repository\ctrl(), ilPageContentGUI\getCharacteristicsOfCurrentStyle(), and initForm().

Here is the call graph for this function:

getHTML()

ilPCSectionGUI::getHTML

(

array

$params

)

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

                                          : string
    {
        $this->getCharacteristicsOfCurrentStyle(["section"]);
 
        if ($params["form"] == true) {
            $insert = !($this->content_obj);
            $form = $this->initForm($params["insert"] ?? false);
            $form->setShowTopButtons(false);
 
            $onload_code = [];
            $char = $form->getItemByPostVar("characteristic");
            //$onload_code = array_merge($onload_code, $char->getOnloadCode());
 
            $from = $form->getItemByPostVar("active_from");
            $from->setSideBySide(false);
            $onload_code = array_merge($onload_code, $from->getOnloadCode());
 
            $to = $form->getItemByPostVar("active_to");
            $to->setSideBySide(false);
            $onload_code = array_merge($onload_code, $to->getOnloadCode());
 
            $link = $form->getItemByPostVar("link");
            $onload_code = array_merge($onload_code, $link->getOnloadCode());
 
            $rep_sel = $form->getItemByPostVar("permission_ref_id");
            $on_load_code3 = "";
            $on_load_code4 = [];
            if ($rep_sel) {
                $exp = $rep_sel->getExplorerGUI();
                $this->ctrl->setParameterByClass("ilformpropertydispatchgui", "postvar", "permission_ref_id");
                $onload_code = array_merge($onload_code, [$exp->getOnloadCode()]);
 
                $this->ctrl->setParameterByClass("ilformpropertydispatchgui", "postvar", "");
                $onload_code = array_merge($onload_code, $rep_sel->getOnloadCode());
            }
 
            if (($params["validation"] ?? false) === true) {
                $this->checkInput($form);
                $form->setValuesByPost();
            }
 
            $html = $params["ui_wrapper"]->getRenderedForm(
                $form,
                $params["buttons"]
            );
 
            $html .= "<script>" .
                implode("\n", $onload_code) .
                "</script>";
 
            return $html;
        }
        return "";
    }

References ilPageContentGUI\$content_obj, $params, checkInput(), ILIAS\Repository\ctrl(), ilPageContentGUI\getCharacteristicsOfCurrentStyle(), and initForm().

Here is the call graph for this function:

initForm()

ilPCSectionGUI::initForm

(

bool

$a_insert = false

)

Definition at line 233 of file class.ilPCSectionGUI.php.

     : ilPropertyFormGUI {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $a_seleted_value = "";
 
        // edit form
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_section"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_section"));
        }
 
        // characteristic selection
        $char_prop = new ilSelectInputGUI(
            $this->lng->txt("cont_characteristic"),
            "characteristic"
        );
        $chars = $this->getCharacteristics();
        if (is_object($this->content_obj)) {
            if (($chars[$a_seleted_value] ?? "") == "" && ($this->content_obj->getCharacteristic() != "")) {
                $chars = array_merge(
                    array($this->content_obj->getCharacteristic() => $this->content_obj->getCharacteristic()),
                    $chars
                );
            }
        }
 
        $selected = ($a_insert)
            ? "Block"
            : $this->content_obj->getCharacteristic();
 
        $options = [];
        foreach ($chars as $k => $char) {
            $options[$k] = $char;
        }
        $char_prop->setOptions($options);
 
        $char_prop->setValue($selected);
        $form->addItem($char_prop);
 
        // link input
        //
        $cb = new ilCheckboxInputGUI($lng->txt("cont_link"), "link_cb");
 
        $ac = new ilLinkInputGUI($this->lng->txt('cont_target'), 'link');
        if ($this->getPageConfig()->getEnableInternalLinks()) {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::BOTH);
        } else {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::EXT);
        }
        $ac->setRequired(true);
        $ac->setInfo($this->lng->txt("copg_sec_link_info"));
        $ac->setInternalLinkDefault(
            $this->getPageConfig()->getIntLinkHelpDefaultType(),
            $this->getPageConfig()->getIntLinkHelpDefaultId()
        );
        $link_types = array();
        foreach ($this->getPageConfig()->getIntLinkFilters() as $f) {
            $link_types[] = $f;
        }
        $ac->setInternalLinkFilterTypes($link_types);
        $ac->setFilterWhiteList(
            $this->getPageConfig()->getIntLinkFilterWhiteList()
        );
 
        if (!$a_insert) {
            $l = $this->content_obj->getLink();
            if ($l["LinkType"] == "IntLink") {
                $target_frame = $l["TargetFrame"];
                if (trim($target_frame) === "") {
                    $target_frame = trim($l["Anchor"]);
                }
                $ac->setValueByIntLinkAttributes($l["Type"], $l["Target"], $target_frame);
                $cb->setChecked(true);
            } elseif ($l["LinkType"] == "ExtLink") {
                $ac->setValue($l["Href"]);
                $cb->setChecked(true);
            } else {
                $ac->setValue("https://");
            }
        } else {
            $ac->setValue("https://");
        }
        $form->addItem($cb);
        $ac->setParentForm($form);
        $cb->addSubItem($ac);
 
 
        // activation
 
        // active from
        $act_cb = new ilCheckboxInputGUI($lng->txt("cont_activation"), "activation");
        $form->addItem($act_cb);
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_from"), "active_from");
        if (!$a_insert && ($from = $this->content_obj->getActiveFrom()) > 0) {
            $dt_prop->setDate(new ilDateTime($from, IL_CAL_UNIX));
            $act_cb->setChecked(true);
        }
        $dt_prop->setShowTime(true);
        $act_cb->addSubItem($dt_prop);
 
        // active to
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_to"), "active_to");
        if (!$a_insert && ($to = $this->content_obj->getActiveTo()) > 0) {
            $dt_prop->setDate(new ilDateTime($to, IL_CAL_UNIX));
            $act_cb->setChecked(true);
        }
        $dt_prop->setShowTime(true);
        $act_cb->addSubItem($dt_prop);
 
        // rep selector
        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            $perm_cb = new ilCheckboxInputGUI($lng->txt("cont_permission_handling"), "permission_handling");
            $form->addItem($perm_cb);
 
            $rs = new ilRepositorySelector2InputGUI($lng->txt("cont_permission_object"), "permission_ref_id", false, $form);
            //$rs->setParent($this);
            $rs->setParentForm($form);
            $rs->setRequired(true);
            $perm_cb->addSubItem($rs);
 
            // permission
            $options = array(
                "read" => $lng->txt("read"),
                "write" => $lng->txt("write"),
                "visible" => $lng->txt("visible"),
                "no_read" => $lng->txt("cont_no_read")
            );
            $si = new ilSelectInputGUI($lng->txt("permission"), "permission");
            $si->setInfo($lng->txt("cont_permission_object_desc"));
            $si->setOptions($options);
            $perm_cb->addSubItem($si);
 
            if (!$a_insert) {
                $si->setValue($this->content_obj->getPermission());
                $rs->setValue($this->content_obj->getPermissionRefId());
                if ($this->content_obj->getPermissionRefId() > 0) {
                    $perm_cb->setChecked(true);
                }
            }
        }
 
        // protection
        if ($this->getPageConfig()->getSectionProtection() == ilPageConfig::SEC_PROTECT_EDITABLE) {
            $cb = new ilCheckboxInputGUI($lng->txt("cont_sec_protected"), "protected");
            $cb->setInfo($this->getPageConfig()->getSectionProtectionInfo());
            if (!$a_insert) {
                $cb->setChecked($this->content_obj->getProtected());
            }
            $form->addItem($cb);
        }
 
        // save/cancel buttons
        if ($a_insert) {
            $form->addCommandButton("create", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $form->addCommandButton("update", $lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
        return $form;
    }

Referenced by executeCommand(), and getHTML().

Here is the caller graph for this function:

insert()

ilPCSectionGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

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

                                                             : void
    {
        $this->edit(true, $a_form);
    }

References edit().

Here is the call graph for this function:

setValuesFromForm()

ilPCSectionGUI::setValuesFromForm

(

ilPropertyFormGUI

$form

)

Definition at line 434 of file class.ilPCSectionGUI.php.

                                                              : void
    {
        $this->content_obj->setCharacteristic($form->getInput("characteristic"));
 
        $activation = (bool) $form->getInput("activation");
        $from = $form->getItemByPostVar("active_from")->getDate();
        if ($activation && $from) {
            $this->content_obj->setActiveFrom($from->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveFrom(0);
        }
 
        $to = $form->getItemByPostVar("active_to")->getDate();
        if ($activation && $to) {
            $this->content_obj->setActiveTo($to->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveTo(0);
        }
 
        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            $permission_handling = (bool) $form->getInput("permission_handling");
            if ($permission_handling) {
                $this->content_obj->setPermissionRefId((int) $form->getInput("permission_ref_id"));
                $this->content_obj->setPermission($form->getInput("permission"));
            } else {
                $this->content_obj->setPermissionRefId(0);
                $this->content_obj->setPermission("");
            }
        }
 
        if ($form->getInput("link_cb") !== "") {
            if ($form->getInput("link_mode") == "ext" && $form->getInput("link") != "") {
                $this->content_obj->setExtLink($form->getInput("link"));
            } elseif ($form->getInput("link_mode") == "int" && $form->getInput("link") != "") {
                $la = $form->getItemByPostVar("link")->getIntLinkAttributes();
                if (($la["Type"] ?? "") != "") {
                    $anchor = "";
                    if (trim($la["TargetFrame"]) !== "" &&
                        !in_array($la["TargetFrame"], ["Media", "FAQ", "Glossary", "New"])) {
                        $anchor = trim($la["TargetFrame"]);
                        $la["TargetFrame"] = "";
                    }
                    $this->content_obj->setIntLink($la["Type"], $la["Target"], $la["TargetFrame"], $anchor);
                }
            } else {
                $this->content_obj->setNoLink();
            }
        } else {
            $this->content_obj->setNoLink();
        }
 
        if ($this->getPageConfig()->getSectionProtection() == ilPageConfig::SEC_PROTECT_EDITABLE) {
            $this->content_obj->setProtected($form->getInput("protected"));
        }
    }

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, and ilPageConfig\SEC_PROTECT_EDITABLE.

Here is the call graph for this function:

update()

ilPCSectionGUI::update

(

)

Definition at line 418 of file class.ilPCSectionGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

---

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

• components/ILIAS/COPage/PC/Section/class.ilPCSectionGUI.php