ilPCAMDFormGUI Class Reference

AMD Form Page UI. More...

Inheritance diagram for ilPCAMDFormGUI:

Collaboration diagram for ilPCAMDFormGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert (?Form\Standard $form=null)
	edit ()
	editTemplate (?Form\Standard $form=null)
	getTemplateForm (bool $edit=false)
	create ()
	update ()
	editPortfolio (?ilPropertyFormGUI $form=null)
	Edit courses form. More...
	getPortfolioForm (bool $edit=false)
	updateAdvancedMetaData ()
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
	isTemplate ()
	getRecordIdsFromForm (Form\Standard $form)
	getAdvRecords ()
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
ILIAS DI UIServices	$ui
StandardGUIRequest	$port_request
ServerRequestInterface	$http_request
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

AMD Form Page UI.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilPCAMDFormGUI: ilPageEditorGUI ilPCAMDFormGUI: ilPropertyFormGUI

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

Constructor & Destructor Documentation

__construct()

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

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

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

      {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->ui = $DIC->ui();
        $this->http_request = $DIC->http()->request();
        $this->port_request = $DIC->portfolio()
            ->internal()
            ->gui()
            ->standardRequest();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);

        $this->lng->loadLanguageModule("prtt");
        $this->lng->loadLanguageModule("prtf");
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCAMDFormGUI::create

(

)

Definition at line 144 of file class.ilPCAMDFormGUI.php.

References $data, $http_request, ilPageContentGUI\$lng, ilPageContentGUI\$request, ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), getRecordIdsFromForm(), getTemplateForm(), ILIAS\UICore\GlobalTemplate\setContent(), ilLanguage\txt(), and ILIAS\Repository\ui().

                            : void
    {
        $request = $this->http_request;
        $form = $this->getTemplateForm();
        $lng = $this->lng;
        $tpl = $this->tpl;

        if ($request->getMethod() === "POST") {
            $form = $form->withRequest($request);
            $data = $form->getData();
            if (is_null($data)) {
                $tpl->setContent($this->ui->renderer()->render($form));
                return;
            }
            if (is_array($data["sec"])) {
                $this->content_obj = new ilPCAMDForm($this->getPage());
                $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                $this->content_obj->setRecordIds($this->getRecordIdsFromForm($form));
                $this->updated = $this->pg_obj->update();
                if (!$this->updated) {
                    $tpl->setContent($this->ui->renderer()->render($form));
                    return;
                }
                $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
            }
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

edit()

ilPCAMDFormGUI::edit

(

)

Definition at line 93 of file class.ilPCAMDFormGUI.php.

References editPortfolio(), editTemplate(), and isTemplate().

                          : void
    {
        if ($this->isTemplate()) {
            $this->editTemplate();
            return;
        }
        $this->editPortfolio();
    }

Here is the call graph for this function:

editPortfolio()

ilPCAMDFormGUI::editPortfolio

(

?ilPropertyFormGUI

$form = null

)

Edit courses form.

Definition at line 239 of file class.ilPCAMDFormGUI.php.

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

Referenced by edit(), and updateAdvancedMetaData().

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

        $this->displayValidationError();

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

Here is the call graph for this function:

Here is the caller graph for this function:

editTemplate()

ilPCAMDFormGUI::editTemplate

(

?Form\Standard

$form = null

)

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), getTemplateForm(), ILIAS\UICore\GlobalTemplate\setContent(), and ILIAS\Repository\ui().

Referenced by edit().

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

        $this->displayValidationError();

        if (!$form) {
            $form = $this->getTemplateForm(true);
        }
        $tpl->setContent($this->ui->renderer()->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCAMDFormGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl(), and getPortfolioForm().

                                    : 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) {
            case "ilpropertyformgui":
                $form = $this->getPortfolioForm(true);
                $this->ctrl->forwardCommand($form);
                break;

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

Here is the call graph for this function:

getAdvRecords()

ilPCAMDFormGUI::getAdvRecords ( )

protected

Definition at line 190 of file class.ilPCAMDFormGUI.php.

References $id, ilPageContentGUI\$requested_ref_id, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilPageContentGUI\getPage(), and isTemplate().

Referenced by getPortfolioForm(), getRecordIdsFromForm(), and getTemplateForm().

                                      : array
    {
        if ($this->isTemplate()) {
            $id = $this->requested_ref_id;
            $is_ref_id = true;
        } else {
            $id = $this->getPage()->getPortfolioId();
            $is_ref_id = false;
        }

        $recs = \ilAdvancedMDRecord::_getSelectedRecordsByObject($this->getPage()->getParentType(), $id, "pfpg", $is_ref_id);
        return $recs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPortfolioForm()

ilPCAMDFormGUI::getPortfolioForm

(

bool

$edit = false

)

Definition at line 251 of file class.ilPCAMDFormGUI.php.

References ilPageContentGUI\$content_obj, ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, $r, ilPageObject\buildDom(), getAdvRecords(), ilCtrl\getFormAction(), ILIAS\Survey\Mode\getId(), ilPageContentGUI\getPage(), ilAdvancedMDRecordGUI\MODE_EDITOR, and ilLanguage\txt().

Referenced by editPortfolio(), executeCommand(), and updateAdvancedMetaData().

                                                        : ilPropertyFormGUI
    {
        $content_obj = $this->content_obj;
        if (is_null($content_obj)) {
            $page = new ilPortfolioPage($this->port_request->getPortfolioPageId());
            $page->buildDom();
            $content_obj = $page->getContentObjectForPcId($this->request->getPCId());
        }

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

        $selected = [];
        if ($edit) {
            $selected = $content_obj->getRecordIds();
        }
        $recs = $this->getAdvRecords();
        foreach ($recs as $r) {
            $val = (in_array($r->getRecordId(), $selected));
        }

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ctrl->getFormAction($this, "updateAdvancedMetaData"));

        $form->setTitle($lng->txt("prtf_edit_data"));

        $this->record_gui = new ilAdvancedMDRecordGUI(
            ilAdvancedMDRecordGUI::MODE_EDITOR,
            'prtf',
            $this->getPage()->getPortfolioId(),
            'pfpg',
            $this->getPage()->getId(),
            false
        );
        $this->record_gui->setRecordFilter($selected);
        $this->record_gui->setPropertyForm($form);
        $this->record_gui->parse();

        $form->addCommandButton("updateAdvancedMetaData", $lng->txt("save"));
        $form->addCommandButton("cancel", $lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecordIdsFromForm()

ilPCAMDFormGUI::getRecordIdsFromForm ( Form\Standard  $form )

protected

Definition at line 173 of file class.ilPCAMDFormGUI.php.

References $data, $r, and getAdvRecords().

Referenced by create(), and update().

                                                                : array
    {
        $data = $form->getData();
        $ids = [];
        if (!is_null($data) && is_array($data["sec"])) {
            $recs = $this->getAdvRecords();
            $ids = [];
            foreach ($recs as $r) {
                $rec_id = $data["sec"]["rec" . $r->getRecordId()];
                if (isset($rec_id) && $rec_id) {
                    $ids[] = $r->getRecordId();
                }
            }
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateForm()

ilPCAMDFormGUI::getTemplateForm

(

bool

$edit = false

)

Definition at line 114 of file class.ilPCAMDFormGUI.php.

References ilPageContentGUI\$ctrl, Vendor\Package\$f, $r, $ui, getAdvRecords(), ilCtrl\getLinkTarget(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\withValue().

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

                                                       : Form\Standard
    {
        $ui = $this->ui;
        $f = $ui->factory();
        $ctrl = $this->ctrl;

        $selected = [];
        if ($edit) {
            $selected = $this->content_obj->getRecordIds();
        }
        $recs = $this->getAdvRecords();
        $fields = array();
        foreach ($recs as $r) {
            $val = (in_array($r->getRecordId(), $selected));
            $fields["rec" . $r->getRecordId()] =
                $f->input()->field()->checkbox($r->getTitle(), $r->getDescription())
                  ->withValue($val);
        }

        // section
        $section1 = $f->input()->field()->section($fields, $this->lng->txt("prtt_select_datasets"));

        if ($edit) {
            $form_action = $ctrl->getLinkTarget($this, "update");
        } else {
            $form_action = $ctrl->getLinkTarget($this, "create_amdfrm");
        }
        return $f->input()->container()->form()->standard($form_action, ["sec" => $section1]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCAMDFormGUI::insert

(

?Form\Standard

$form = null

)

Definition at line 81 of file class.ilPCAMDFormGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), getTemplateForm(), ILIAS\UICore\GlobalTemplate\setContent(), and ILIAS\Repository\ui().

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

        $this->displayValidationError();

        if (!$form) {
            $form = $this->getTemplateForm();
        }
        $tpl->setContent($this->ui->renderer()->render($form));
    }

Here is the call graph for this function:

isTemplate()

ilPCAMDFormGUI::isTemplate ( )

protected

Definition at line 76 of file class.ilPCAMDFormGUI.php.

References ilPageContentGUI\getPage().

Referenced by edit(), and getAdvRecords().

                                   : bool
    {
        return ($this->getPage()->getParentType() === "prtt");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCAMDFormGUI::update

(

)

Definition at line 204 of file class.ilPCAMDFormGUI.php.

References $data, $http_request, ilPageContentGUI\$lng, ilPageContentGUI\$request, ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), getRecordIdsFromForm(), getTemplateForm(), ILIAS\UICore\GlobalTemplate\setContent(), ilLanguage\txt(), and ILIAS\Repository\ui().

                            : void
    {
        $request = $this->http_request;
        $form = $this->getTemplateForm(true);
        $lng = $this->lng;
        $tpl = $this->tpl;

        if ($request->getMethod() === "POST") {
            $form = $form->withRequest($request);
            $data = $form->getData();
            if (is_null($data)) {
                $tpl->setContent($this->ui->renderer()->render($form));
                return;
            }
            if (is_array($data["sec"])) {
                $this->content_obj->setRecordIds($this->getRecordIdsFromForm($form));
                $this->updated = $this->pg_obj->update();
                if (!$this->updated) {
                    $tpl->setContent($this->ui->renderer()->render($form));
                    return;
                }
                $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
            }
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

updateAdvancedMetaData()

ilPCAMDFormGUI::updateAdvancedMetaData

(

)

Definition at line 295 of file class.ilPCAMDFormGUI.php.

References ilPageContentGUI\$lng, ILIAS\Repository\ctrl(), editPortfolio(), getPortfolioForm(), and ilLanguage\txt().

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

        $form = $this->getPortfolioForm(true);

        // needed for proper advanced MD validation
        $form->checkInput();
        if (!$this->record_gui->importEditFormPostValues()) {
            $this->editPortfolio($form); // #16470
            return;
        }

        if ($this->record_gui->writeEditForm()) {
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        }
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

Field Documentation

$http_request

ServerRequestInterface ilPCAMDFormGUI::$http_request

protected

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

Referenced by create(), and update().

$port_request

StandardGUIRequest ilPCAMDFormGUI::$port_request

protected

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

$record_gui

ilAdvancedMDRecordGUI ilPCAMDFormGUI::$record_gui

protected

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

$ui

ILIAS DI UIServices ilPCAMDFormGUI::$ui

protected

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

Referenced by getTemplateForm().

---

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

• components/ILIAS/Portfolio/Page/class.ilPCAMDFormGUI.php