ilPCProfileGUI Class Reference

Class ilPCProfileGUI. More...

Inheritance diagram for ilPCProfileGUI:

Collaboration diagram for ilPCProfileGUI:

Public Member Functions
	__construct (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	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 ($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...
	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...

Protected Member Functions
	initForm ($a_insert=false)
	Init profile form. More...
	getFieldsValues ()
	Gather field values. More...
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...

Protected Attributes
	$toolbar
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
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;"
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

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

Version

$I$

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

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

    {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        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 208 of file class.ilPCProfileGUI.php.

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

    {
        $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.

Parameters

ilPropertyFormGUI

$a_form

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

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

Referenced by update().

    {
        $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

(

)

execute command

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

References $ret.

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

getFieldsValues()

ilPCProfileGUI::getFieldsValues ( )

protected

Gather field values.

Returns

array

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

References $_POST, and $name.

Referenced by create(), and update().

    {
        $fields = array();
        foreach ($_POST as $name => $value) {
            if (substr($name, 0, 4) == "chk_") {
                if ($value) {
                    $fields[] = substr($name, 4);
                }
            }
        }
        return $fields;
    }

Here is the caller graph for this function:

initForm()

ilPCProfileGUI::initForm (   $a_insert = false )

protected

Init profile form.

Parameters

bool

$a_insert

Returns

ilPropertyFormGUI

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

References ilPageContentGUI\$ctrl, $ilCtrl, $name, $toolbar, ilPageContentGUI\getPageConfig(), and ilRadioOption\setInfo().

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

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

        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_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_profile", $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.

Parameters

ilPropertyFormGUI

$a_form

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

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

Referenced by create().

    {
        $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 230 of file class.ilPCProfileGUI.php.

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

    {
        $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

$toolbar

ilPCProfileGUI::$toolbar

protected

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

Referenced by initForm().

---

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

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