ilPCSectionGUI Class Reference

Class ilPCSectionGUI. More...

Inheritance diagram for ilPCSectionGUI:

Collaboration diagram for ilPCSectionGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	getHTML (array $params)
	Get HTML. More...
	executeCommand ()
	execute command More...
	insert (ilPropertyFormGUI $a_form=null)
	Insert new section form. More...
	edit ($a_insert=false, ilPropertyFormGUI $a_form=null)
	Edit section form. More...
	initForm ($a_insert=false)
	Init editing form. More...
	create ()
	Create new Section. More...
	update ()
	Update Section. More...
	setValuesFromForm ($form)
	Set values from form. More...
Public Member Functions inherited from ilPageContentGUI
	__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...
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. 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	_getStandardCharacteristics ()
	Get standard characteristics. More...
static	_getCharacteristics ($a_style_id)
	Get characteristics. More...
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...

Additional Inherited Members
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$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 ($hier_id="")
	Redirect to parent. More...
	getParentReturn ($hier_id="")
Protected Attributes inherited from ilPageContentGUI
	$error
	$log
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCSectionGUI.

User Interface for Section Editing

Author

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

Version

$Id$

ilPCSectionGUI: ilPropertyFormGUI

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getCharacteristics()

static ilPCSectionGUI::_getCharacteristics (   $a_style_id )

static

Get characteristics.

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

References _getStandardCharacteristics(), and ilObject\_lookupType().

Referenced by ILIAS\COPage\Editor\Components\Section\SectionStyleSelector\getStyleSelector(), and ilPageEditorGUI\initCharacteristicForm().

    {
        $std_chars = ilPCSectionGUI::_getStandardCharacteristics();
        $chars = $std_chars;
        if ($a_style_id > 0 &&
            ilObject::_lookupType($a_style_id) == "sty") {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            $style = new ilObjStyleSheet($a_style_id);
            $chars = $style->getCharacteristics("section");
            $new_chars = array();
            foreach ($chars as $char) {
                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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getStandardCharacteristics()

static ilPCSectionGUI::_getStandardCharacteristics ( )

static

Get standard characteristics.

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

References $DIC, and ilPageContentGUI\$lng.

Referenced by __construct(), and _getCharacteristics().

    {
        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_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"));
    }

Here is the caller graph for this function:

create()

ilPCSectionGUI::create

(

)

Create new Section.

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

References ilPageContentGUI\getPage(), initForm(), insert(), and setValuesFromForm().

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

Here is the call graph for this function:

edit()

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

Edit section form.

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and initForm().

Referenced by insert(), and update().

    {
        $tpl = $this->tpl;
        
        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm($a_insert);
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCSectionGUI::executeCommand

(

)

execute command

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

References $ret, ilPageContentGUI\getCharacteristicsOfCurrentStyle(), and initForm().

    {
        $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":
                include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
                $form = $this->initForm(true);
                $this->ctrl->forwardCommand($form);
                break;

            default:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

Here is the call graph for this function:

getHTML()

ilPCSectionGUI::getHTML

(

array

$params

)

Get HTML.

Parameters

array

$params

Returns

string

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

References ilPageContentGUI\getCharacteristicsOfCurrentStyle(), and initForm().

    {
        $this->getCharacteristicsOfCurrentStyle("section");

        if ($params["form"] == true) {
            $insert = (bool) !($this->content_obj);
            $form = $this->initForm($insert);
            $form->setShowTopButtons(false);

            $from = $form->getItemByPostVar("active_from");
            $from->setSideBySide(false);
            $on_load_code1 = $from->getOnloadCode();
            $to = $form->getItemByPostVar("active_to");
            $to->setSideBySide(false);
            $on_load_code2 = $to->getOnloadCode();

            $rep_sel = $form->getItemByPostVar("permission_ref_id");
            $on_load_code3 = "";
            if ($rep_sel) {
                $exp = $rep_sel->getExplorerGUI();
                $this->ctrl->setParameterByClass("ilformpropertydispatchgui", "postvar", "permission_ref_id");
                $on_load_code3 = $exp->getOnloadCode();
                $this->ctrl->setParameterByClass("ilformpropertydispatchgui", "postvar", "");
            }

            $html = $params["ui_wrapper"]->getRenderedForm(
                $form,
                $params["buttons"]
            );

            $html .= "<script>" .
                implode("\n", array_merge($on_load_code1, $on_load_code2)) .
                "\n" . $on_load_code3 .
                "</script>";

            return $html;
        }
        return "";
    }

Here is the call graph for this function:

initForm()

ilPCSectionGUI::initForm

(

$a_insert = false

)

Init editing form.

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

References ilPageContentGUI\$ctrl, Vendor\Package\$f, ilPageContentGUI\$lng, $si, ilLinkInputGUI\BOTH, ilLinkInputGUI\EXT, ilPageContentGUI\getCharacteristics(), ilPageContentGUI\getPageConfig(), IL_CAL_UNIX, ilLinkInputGUI\setAllowedLinkTypes(), ilDateTimeInputGUI\setDate(), and ilFormPropertyGUI\setParent().

Referenced by create(), edit(), executeCommand(), getHTML(), and update().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        // edit form
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $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
        require_once("./Services/Form/classes/class.ilAdvSelectInputGUI.php");
        $char_prop = new ilAdvSelectInputGUI(
            $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();
            
        foreach ($chars as $k => $char) {
            $html = '<div class="ilCOPgEditStyleSelectionItem"><div class="ilc_section_' . $k . '" style="' . self::$style_selector_reset . '">' .
                $char . '</div></div>';
            $char_prop->addOption($k, $char, $html);
        }

        $char_prop->setValue($selected);
        $form->addItem($char_prop);

        // link input
        include_once 'Services/Form/classes/class.ilLinkInputGUI.php';
        $ac = new ilLinkInputGUI($this->lng->txt('cont_link'), 'link');
        if ($this->getPageConfig()->getEnableInternalLinks()) {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::BOTH);
        } else {
            $ac->setAllowedLinkTypes(ilLinkInputGUI::EXT);
        }
        $ac->setRequired(false);
        $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") {
                $ac->setValueByIntLinkAttributes($l["Type"], $l["Target"], $l["TargetFrame"]);
            }
            if ($l["LinkType"] == "ExtLink") {
                $ac->setValue($l["Href"]);
            }
        }
        $form->addItem($ac);

        // activation

        // active from
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_from"), "active_from");
        if (!$a_insert && ($from = $this->content_obj->getActiveFrom()) != "") {
            $dt_prop->setDate(new ilDateTime($from, IL_CAL_UNIX));
        }
        $dt_prop->setShowTime(true);
        $form->addItem($dt_prop);

        // active to
        $dt_prop = new ilDateTimeInputGUI($lng->txt("cont_active_to"), "active_to");
        if (!$a_insert && ($to = $this->content_obj->getActiveTo()) != "") {
            $dt_prop->setDate(new ilDateTime($to, IL_CAL_UNIX));
        }
        $dt_prop->setShowTime(true);
        $form->addItem($dt_prop);

        // rep selector
        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            include_once("./Services/Form/classes/class.ilRepositorySelector2InputGUI.php");
            $rs = new ilRepositorySelector2InputGUI($lng->txt("cont_permission_object"), "permission_ref_id");
            $rs->setParent($this);
            $form->addItem($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);
            $form->addItem($si);

            if (!$a_insert) {
                $si->setValue($this->content_obj->getPermission());
                $rs->setValue($this->content_obj->getPermissionRefId());
            }
        }

        // save/cancel buttons
        if ($a_insert) {
            $form->addCommandButton("create_section", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $form->addCommandButton("update", $lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCSectionGUI::insert

(

ilPropertyFormGUI

$a_form = null

)

Insert new section form.

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

References edit().

Referenced by create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setValuesFromForm()

ilPCSectionGUI::setValuesFromForm

(

$form

)

Set values from form.

Parameters

object

$form

form object

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

References $_POST, ilPageContentGUI\getPageConfig(), and IL_CAL_UNIX.

Referenced by create(), and update().

    {
        $this->content_obj->setCharacteristic($_POST["characteristic"]);

        $from = $form->getItemByPostVar("active_from")->getDate();
        if ($from) {
            $this->content_obj->setActiveFrom($from->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveFrom(0);
        }

        $to = $form->getItemByPostVar("active_to")->getDate();
        if ($to) {
            $this->content_obj->setActiveTo($to->get(IL_CAL_UNIX));
        } else {
            $this->content_obj->setActiveTo(0);
        }

        if ($this->getPageConfig()->getEnablePermissionChecks()) {
            $this->content_obj->setPermissionRefId($_POST["permission_ref_id"]);
            $this->content_obj->setPermission($_POST["permission"]);
        }

        if ($_POST["link_mode"] == "ext" && $_POST["link"] != "") {
            $this->content_obj->setExtLink($_POST["link"]);
        } elseif ($_POST["link_mode"] == "int" && $_POST["link"] != "") {
            // $_POST["link"] is "crs|96", "chap|2", "term|1", "wpage|1"
            //                  var_dump($_POST);
            $la = $form->getItemByPostVar("link")->getIntLinkAttributes();
            //                  echo "<br>";
            //                  var_dump($la); exit;
            if ($la["Type"] != "") {
                $this->content_obj->setIntLink($la["Type"], $la["Target"], $la["TargetFrame"]);
            }
        } else {
            $this->content_obj->setNoLink();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCSectionGUI::update

(

)

Update Section.

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

References edit(), initForm(), and setValuesFromForm().

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

Here is the call graph for this function:

---

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

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