ilPCListGUI 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 ilPCListGUI:

Collaboration diagram for ilPCListGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert ()
	insert new list form More...
	create ()
	Save list. More...
	edit ()
	edit properties form More...
	saveProperties ()
	Save properties. More...
	initListForm (string $a_mode="edit")
	getValues ()
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	_getListCharacteristics (int $a_style_id, string $type)
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Protected Attributes
ilPropertyFormGUI	$form
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
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

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
	$updated
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="")
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 Class ilPCListGUI

User Interface for LM List Editing

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

Member Function Documentation

_getListCharacteristics()

static ilPCListGUI::_getListCharacteristics ( int  $a_style_id, string  $type  )

static

Definition at line 168 of file class.ilPCListGUI.php.

References ilPageContentGUI\$chars, ilPageContentGUI\$style, ilObject\_lookupType(), and ilObjStyleSheet\getCharacteristics().

Referenced by ilPageObjectGUI\getTinyMenu().

     : array {
        $chars = [];

        if ($a_style_id > 0 &&
            ilObject::_lookupType($a_style_id) == "sty") {
            $style = new ilObjStyleSheet($a_style_id);
            $types = [$type];
            foreach ($types as $t) {
                $chars = array_merge($chars, $style->getCharacteristics($t, false, true));
            }
        }

        return $chars;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilPCListGUI::create

(

)

Save list.

Definition at line 74 of file class.ilPCListGUI.php.

References ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilPageContentGUI\getPage(), initListForm(), and ilGlobalTemplateInterface\setContent().

                            : void
    {
        $tpl = $this->tpl;

        $this->initListForm("create");
        if ($this->form->checkInput()) {
            $this->content_obj = new ilPCList($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->addItems($this->form->getInput("nr_items"));
            $this->content_obj->setStartValue(
                (int) $this->form->getInput("start_value")
            );
            $list_type = $this->form->getInput("list_type");
            $this->content_obj->setListType(
                $list_type
            );
            if ($list_type == "Unordered") {
                $this->content_obj->setNumberingType("");
                $this->content_obj->setStyleClass(
                    $this->form->getInput("bullet_style")
                );
            } else {
                $this->content_obj->setNumberingType(
                    $this->form->getInput("numbering_type")
                );
                $this->content_obj->setStyleClass(
                    $this->form->getInput("number_style")
                );
            }
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

edit()

ilPCListGUI::edit

(

)

edit properties form

Definition at line 115 of file class.ilPCListGUI.php.

References ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), getValues(), and initListForm().

                          : void
    {
        $this->displayValidationError();
        $this->initListForm("edit");
        $this->getValues();
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilPCListGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl().

                                    : void
    {
        // 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) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getValues()

ilPCListGUI::getValues

(

)

Definition at line 332 of file class.ilPCListGUI.php.

References ILIAS\Repository\form().

Referenced by edit().

                               : void
    {
        $values = array();

        $values["start_value"] = $this->content_obj->getStartValue();
        $values["list_type"] = $this->content_obj->getListType();
        $values["numbering_type"] = $this->content_obj->getNumberingType();
        if ($values["list_type"] == "Ordered") {
            $values["number_style"] = $this->content_obj->getStyleClass();
            $values["bullet_style"] = "";
        } else {
            $values["bullet_style"] = $this->content_obj->getStyleClass();
            $values["number_style"] = "";
        }
        $values["item_style_1"] = $this->content_obj->getItemStyleClass();
        $values["item_style_2"] = $this->content_obj->getItemStyleClass();
        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initListForm()

ilPCListGUI::initListForm

(

string

$a_mode = "edit"

)

Definition at line 186 of file class.ilPCListGUI.php.

References ilPageContentGUI\$lng, ilPageContentGUI\$style, ilAdvSelectInputGUI\addOption(), ilSubEnabledFormPropertyGUI\addSubItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilPageContentGUI\getCharacteristics(), ilPageContentGUI\getCharacteristicsOfCurrentStyle(), ILIAS\Repository\lng(), ilSelectInputGUI\setOptions(), ilAdvSelectInputGUI\setValue(), ilRadioOption\setValue(), and ilLanguage\txt().

Referenced by create(), edit(), insert(), and saveProperties().

     : void {
        $lng = $this->lng;
        $this->form = new ilPropertyFormGUI();

        // type
        $radg = new ilRadioGroupInputGUI($lng->txt("type"), "list_type");
        $op1 = new ilRadioOption($lng->txt("cont_bullet_list"), "Unordered");

        // style of bullet list
        $style = new ilAdvSelectInputGUI(
            $this->lng->txt("cont_style"),
            "bullet_style"
        );
        $this->getCharacteristicsOfCurrentStyle(["list_u"]);
        $options = $this->getCharacteristics();
        if ($a_mode == "edit" && $this->content_obj->getListType() == "Unordered"
                && $this->content_obj->getStyleClass() != ""
                && !in_array($this->content_obj->getStyleClass(), $options)) {
            $options[$this->content_obj->getStyleClass()] =
                    $this->content_obj->getStyleClass();
        }
        if (count($options) > 1) {
            foreach ($options as $k => $option) {
                $html = '<ul class="ilc_list_u_' . $k . '"><li class="ilc_list_item_StandardListItem">' .
                    $option . '</li></ul>';
                if ($k == "BulletedList") {
                    $k = "";
                }
                $style->addOption($k, $option, $html);
            }
            $style->setValue("");
            $op1->addSubItem($style);
        }

        $radg->addOption($op1);


        $op2 = new ilRadioOption($lng->txt("cont_numbered_list"), "Ordered");

        // style of numbered list
        $style = new ilAdvSelectInputGUI(
            $this->lng->txt("cont_style"),
            "number_style"
        );
        $this->getCharacteristicsOfCurrentStyle(["list_o"]);
        $options = $this->getCharacteristics();
        if ($a_mode == "edit" && $this->content_obj->getListType() == "Ordered"
                && $this->content_obj->getStyleClass() != ""
                && !in_array($this->content_obj->getStyleClass(), $options)) {
            $options[$this->content_obj->getStyleClass()] =
                    $this->content_obj->getStyleClass();
        }
        if (count($options) > 1) {
            foreach ($options as $k => $option) {
                $html = '<ol class="ilc_list_o_' . $k . '"><li class="ilc_list_item_StandardListItem">' .
                        $option . '</li></ol>';
                if ($k == "NumberedList") {
                    $k = "";
                }
                $style->addOption($k, $option, $html);
            }
            $style->setValue("");
            $op2->addSubItem($style);
        }

        // numeric type
        $options = array(
                "Number" => $this->lng->txt("cont_number_std"),
                "Decimal" => $this->lng->txt("cont_decimal"),
                "Roman" => $this->lng->txt("cont_roman"),
                "roman" => $this->lng->txt("cont_roman_s"),
                "Alphabetic" => $this->lng->txt("cont_alphabetic"),
                "alphabetic" => $this->lng->txt("cont_alphabetic_s")
                );
        $si = new ilSelectInputGUI($this->lng->txt("cont_number_type"), "numbering_type");
        $si->setOptions($options);
        $op2->addSubItem($si);

        // starting value
        $ni = new ilNumberInputGUI($this->lng->txt("cont_start_value"), "start_value");
        $ni->setMaxLength(3);
        $ni->setSize(3);
        $ni->setInfo($lng->txt("cont_start_value_info"));
        $op2->addSubItem($ni);

        $radg->addOption($op2);
        $radg->setValue("Unordered");
        $this->form->addItem($radg);

        // list item type
        $this->getCharacteristicsOfCurrentStyle(["list_item"]);
        $options = $this->getCharacteristics();
        if (count($options) > 1) {
            $style1 = new ilAdvSelectInputGUI(
                $this->lng->txt("cont_list_item_style"),
                "item_style_1"
            );
            $style2 = new ilAdvSelectInputGUI(
                $this->lng->txt("cont_list_item_style"),
                "item_style_2"
            );
            foreach ($options as $k => $option) {
                $html = '<ul style="list-style-type:none;"><li class="ilc_list_item_' . $option . '">' .
                    $option . '</li></ul>';
                if ($k == "BulletedList") {
                    $k = "";
                }
                $style1->addOption($k, $option, $html);
                $style2->addOption($k, $option, $html);
            }
            $style1->setValue("StandardListItem");
            $style2->setValue("StandardListItem");
            $op1->addSubItem($style1);
            $op2->addSubItem($style2);
        }
        $options = $this->getCharacteristicsOfCurrentStyle(["list_item"]);


        // nr of items
        $options = array();
        if ($a_mode == "create") {
            for ($i = 1; $i <= 10; $i++) {
                $options[$i] = $i;
            }
            $si = new ilSelectInputGUI($this->lng->txt("cont_nr_items"), "nr_items");
            $si->setOptions($options);
            $si->setValue(2);
            $this->form->addItem($si);
        }

        // save and cancel commands
        if ($a_mode == "create") {
            $this->form->addCommandButton("create_list", $lng->txt("save"));
            $this->form->addCommandButton("cancelCreate", $lng->txt("cancel"));
            $this->form->setTitle($lng->txt("cont_insert_list"));
        } else {
            $this->form->addCommandButton("saveProperties", $lng->txt("save"));
            $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
            $this->form->setTitle($lng->txt("cont_list_properties"));
        }

        $this->form->setFormAction($this->ctrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCListGUI::insert

(

)

insert new list form

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

References ilPageContentGUI\displayValidationError(), ILIAS\Repository\form(), and initListForm().

                            : void
    {
        $this->displayValidationError();
        $this->initListForm("create");
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

saveProperties()

ilPCListGUI::saveProperties

(

)

Save properties.

Definition at line 126 of file class.ilPCListGUI.php.

References ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), initListForm(), and ilGlobalTemplateInterface\setContent().

                                    : void
    {
        $tpl = $this->tpl;

        $this->initListForm("edit");
        if ($this->form->checkInput()) {
            $this->content_obj->setStartValue(
                $this->form->getInput("start_value")
            );
            $list_type = $this->form->getInput("list_type");
            $this->content_obj->setListType(
                $list_type
            );
            if ($list_type == "Unordered") {
                $this->content_obj->setNumberingType("");
                $this->content_obj->setStyleClass(
                    $this->form->getInput("bullet_style")
                );
                $this->content_obj->setItemStyleClass(
                    $this->form->getInput("item_style_1")
                );
            } else {
                $this->content_obj->setNumberingType(
                    $this->form->getInput("numbering_type")
                );
                $this->content_obj->setStyleClass(
                    $this->form->getInput("number_style")
                );
                $this->content_obj->setItemStyleClass(
                    $this->form->getInput("item_style_2")
                );
            }

            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$form

ilPropertyFormGUI ilPCListGUI::$form

protected

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

---

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

• Services/COPage/PC/List/class.ilPCListGUI.php