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

Collaboration diagram for ilPCProfileGUI:

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)
	Insert new personal data form. More...
	edit (?ilPropertyFormGUI $a_form=null)
	Edit personal data form. More...
	create ()
	Create new personal data. More...
	update ()
	Update personal data. More...
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)
	Init profile form. More...
	getFieldsValues ()
	Gather field values. More...
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
ILIAS HTTP Services	$http
ilToolbarGUI	$toolbar
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 Class ilPCProfileGUI Handles user commands on personal data

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 24 of file class.ilPCProfileGUI.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\toolbar().

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $this->http = $DIC->http();
        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()

ilPCProfileGUI::create

(

)

Create new personal data.

Definition at line 178 of file class.ilPCProfileGUI.php.

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

                            : void
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $this->content_obj = new ilPCProfile($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->setFields(
                $form->getInput("mode"),
                $this->getFieldsValues()
            );
            $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()

ilPCProfileGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Edit personal data form.

Definition at line 77 of file class.ilPCProfileGUI.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()

ilPCProfileGUI::executeCommand

(

)

Definition at line 44 of file class.ilPCProfileGUI.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:

getFieldsValues()

ilPCProfileGUI::getFieldsValues ( )

protected

Gather field values.

Definition at line 162 of file class.ilPCProfileGUI.php.

References ILIAS\FileDelivery\http().

Referenced by create(), and update().

                                        : array
    {
        $fields = array();
        foreach ($this->http->request()->getParsedBody() as $name => $value) {
            if (substr($name, 0, 4) == "chk_") {
                if ($value) {
                    $fields[] = substr($name, 4);
                }
            }
        }
        return $fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilPCProfileGUI::initForm ( bool  $a_insert = false )

protected

Init profile form.

Definition at line 92 of file class.ilPCProfileGUI.php.

References ilPageContentGUI\$ctrl, $toolbar, ilToolbarGUI\addButton(), ilPageContentGUI\getPageConfig(), ILIAS\Repository\lng(), and ilRadioOption\setInfo().

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

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

        $is_template = ($this->getPageConfig()->getEnablePCType("PlaceHolder"));

        if (!$is_template) {
            $ilToolbar->addButton(
                $this->lng->txt("cont_edit_personal_data"),
                $ilCtrl->getLinkTargetByClass("ildashboardgui", "jumptoprofile"),
                "profile"
            );

            $lng_suffix = "";
        } else {
            $lng_suffix = "_template";
        }

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_profile"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_profile"));
        }

        $mode = new ilRadioGroupInputGUI($this->lng->txt("cont_profile_mode"), "mode");
        $form->addItem($mode);

        $mode_inherit = new ilRadioOption($this->lng->txt("cont_profile_mode_inherit"), "inherit");
        $mode_inherit->setInfo($this->lng->txt("cont_profile_mode" . $lng_suffix . "_inherit_info"));
        $mode->addOption($mode_inherit);

        $mode_manual = new ilRadioOption($this->lng->txt("cont_profile_mode_manual"), "manual");
        $mode_manual->setInfo($this->lng->txt("cont_profile_mode_manual_info"));
        $mode->addOption($mode_manual);

        $prefs = array();
        if ($a_insert) {
            $mode->setValue("inherit");
        } else {
            $mode_value = $this->content_obj->getMode();
            $mode->setValue($mode_value);

            $prefs = array();
            if ($mode_value == "manual") {
                foreach ($this->content_obj->getFields() as $name) {
                    $prefs["public_" . $name] = "y";
                }
            }
        }

        $profile = new ilPersonalProfileGUI();
        $profile->showPublicProfileFields($form, $prefs, $mode_manual, $is_template);

        if ($a_insert) {
            $form->addCommandButton("create", $this->lng->txt("save"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $form->addCommandButton("update", $this->lng->txt("save"));
            $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()

ilPCProfileGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

Insert new personal data form.

Definition at line 62 of file class.ilPCProfileGUI.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()

ilPCProfileGUI::update

(

)

Update personal data.

Definition at line 200 of file class.ilPCProfileGUI.php.

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

                            : void
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $this->content_obj->setFields(
                $form->getInput("mode"),
                $this->getFieldsValues()
            );
            $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

$http

ILIAS HTTP Services ilPCProfileGUI::$http

protected

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

$toolbar

ilToolbarGUI ilPCProfileGUI::$toolbar

protected

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

Referenced by initForm().

---

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

• components/ILIAS/COPage/PC/Profile/class.ilPCProfileGUI.php