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

Collaboration diagram for ilPCLoginPageElementGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert ()
	edit (bool $a_insert=false)
	create ()
	Create new Login Page Element. More...
	update ()
	Update Login page element. 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 Attributes
ilObjectDefinition	$obj_definition
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;"
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 ilLoginPageElementGUI

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilPCLoginPageElementGUI:

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

Constructor & Destructor Documentation

__construct()

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

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

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

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->obj_definition = $DIC["objDefinition"];
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);

        if (!is_object($this->content_obj)) {
            $this->content_obj = new ilPCLoginPageElement($this->getPage());
        }
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCLoginPageElementGUI::create

(

)

Create new Login Page Element.

Definition at line 130 of file class.ilPCLoginPageElementGUI.php.

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

                            : void
    {
        $this->content_obj = new ilPCLoginPageElement($this->getPage());
        $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->content_obj->setLoginPageElementType(
            $this->request->getString("type")
        );
        $this->content_obj->setAlignment(
            $this->request->getString("horizontal_align")
        );

        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->insert();
        }
    }

Here is the call graph for this function:

edit()

ilPCLoginPageElementGUI::edit

(

bool

$a_insert = false

)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), ilPCLoginPageElement\getAllTypes(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\setContent(), ilSelectInputGUI\setOptions(), ilRadioOption\setValue(), and ilLanguage\txt().

Referenced by insert(), and update().

                                                : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        $this->displayValidationError();

        // edit form
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_login_page"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_login_page"));
        }

        // type selection
        $type_prop = new ilRadioGroupInputGUI($this->lng->txt("cont_type"), "type");

        foreach (ilPCLoginPageElement::getAllTypes() as $index => $lang_key) {
            $types[$index] = $this->lng->txt('cont_lpe_' . $lang_key);

            $option = new ilRadioOption($this->lng->txt('cont_lpe_' . $lang_key), $index);
            $type_prop->addOption($option);
        }

        $selected = $a_insert
            ? ""
            : $this->content_obj->getLoginPageElementType();
        $type_prop->setValue($selected);
        $form->addItem($type_prop);

        // horizonal align
        $align_prop = new ilSelectInputGUI($this->lng->txt("cont_align"), "horizontal_align");
        $options = array(
            "Left" => $lng->txt("cont_left"),
            "Center" => $lng->txt("cont_center"),
            "Right" => $lng->txt("cont_right"));
        #                       "LeftFloat" => $lng->txt("cont_left_float"),
        #                       "RightFloat" => $lng->txt("cont_right_float"));
        $align_prop->setOptions($options);
        $align_prop->setValue($this->content_obj->getAlignment());
        $form->addItem($align_prop);


        // save/cancel buttons
        if ($a_insert) {
            $form->addCommandButton("create", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            $form->addCommandButton("update_login_page_element", $lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
        }
        $html = $form->getHTML();
        $tpl->setContent($html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCLoginPageElementGUI::executeCommand

(

)

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

insert()

ilPCLoginPageElementGUI::insert

(

)

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

References edit().

Referenced by create().

                            : void
    {
        $this->edit(true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCLoginPageElementGUI::update

(

)

Update Login page element.

Definition at line 152 of file class.ilPCLoginPageElementGUI.php.

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

                            : void
    {
        $this->content_obj->setLoginPageElementType(
            $this->request->getString("type")
        );
        $this->content_obj->setAlignment(
            $this->request->getString("horizontal_align")
        );
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->pg_obj->addHierIDs();
            $this->edit();
        }
    }

Here is the call graph for this function:

Field Documentation

$obj_definition

ilObjectDefinition ilPCLoginPageElementGUI::$obj_definition

protected

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

---

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

• components/ILIAS/COPage/PC/Login/class.ilPCLoginPageElementGUI.php