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

Collaboration diagram for ilPCAMDPageListGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert (?ilPropertyFormGUI $a_form=null)
	edit (?ilPropertyFormGUI $a_form=null)
	create ()
	update ()
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...

Protected Member Functions
	initForm (bool $a_insert=false)
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
ilAdvancedMDRecordGUI	$record_gui = null
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

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
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;"
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 Handles user commands on advanced md page list

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

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

Definition at line 27 of file class.ilPCAMDPageListGUI.php.

References ILIAS\GlobalScreen\Provider\__construct().

      {
        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

create()

ilPCAMDPageListGUI::create

(

)

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

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

                            : void
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $elements = $this->record_gui->importSearchForm();
            if (is_array($elements)) {
                $this->content_obj = new ilPCAMDPageList($this->getPage());
                $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                $this->content_obj->setData($elements, $form->getInput("mode"));
                $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()

ilPCAMDPageListGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 68 of file class.ilPCAMDPageListGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by update().

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

        $this->displayValidationError();

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCAMDPageListGUI::executeCommand

(

)

Returns

mixed

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

References ILIAS\Repository\ctrl().

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

        return $ret;
    }

Here is the call graph for this function:

initForm()

ilPCAMDPageListGUI::initForm ( bool  $a_insert = false )

protected

Definition at line 80 of file class.ilPCAMDPageListGUI.php.

References ilPageContentGUI\$ctrl, ILIAS\Survey\Mode\getId(), ilPageContentGUI\getPage(), ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_SEARCH, and ilSelectInputGUI\setOptions().

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

                                                       : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_amd_page_list"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_amd_page_list"));
        }
        $form->setDescription($this->lng->txt("wiki_page_list_form_info"));

        $mode = new ilSelectInputGUI($this->lng->txt("wiki_page_list_mode"), "mode");
        $mode->setOptions(array(
            0 => $this->lng->txt("wiki_page_list_mode_unordered"),
            1 => $this->lng->txt("wiki_page_list_mode_ordered")
        ));
        $mode->setRequired(true);
        $form->addItem($mode);

        $this->record_gui = new ilAdvancedMDRecordGUI(
            ilAdvancedMDRecordGUI::MODE_SEARCH,
            'wiki',
            $this->getPage()->getWikiId(),
            'wpg',
            $this->getPage()->getId()
        );
        $this->record_gui->setPropertyForm($form);

        if (!$a_insert) {
            $mode->setValue($this->content_obj->getMode());
            $this->record_gui->setSearchFormValues($this->content_obj->getFieldValues());
        }

        $this->record_gui->parse();

        $no_fields = (count($form->getItems()) === 1);
        if ($no_fields) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("wiki_pg_list_no_search_fields"));
        }

        if ($a_insert) {
            if (!$no_fields) {
                $form->addCommandButton("create", $this->lng->txt("select"));
            }
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            if (!$no_fields) {
                $form->addCommandButton("update", $this->lng->txt("select"));
            }
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCAMDPageListGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 56 of file class.ilPCAMDPageListGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by create().

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

        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCAMDPageListGUI::update

(

)

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

References ILIAS\Repository\ctrl(), edit(), and initForm().

                            : void
    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            $elements = $this->record_gui->importSearchForm();
            if (is_array($elements)) {
                $this->content_obj->setData($elements, $form->getInput("mode"));
                $this->updated = $this->pg_obj->update();
                if ($this->updated === true) {
                    $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                }
            }
        }

        $this->pg_obj->addHierIDs();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$record_gui

ilAdvancedMDRecordGUI ilPCAMDPageListGUI::$record_gui = null

protected

Definition at line 25 of file class.ilPCAMDPageListGUI.php.

---

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

• components/ILIAS/Wiki/classes/class.ilPCAMDPageListGUI.php