ADT based-object GUI base class. More...

Inheritance diagram for ilADTBasedObjectGUI:

Collaboration diagram for ilADTBasedObjectGUI:

Public Member Functions
	__construct (ilObjectGUI $a_parent_gui)
	Constructor Parent GUI is just needed for testing (ilCtrl) More...

	editAction (?ilADTGroupFormBridge $a_form=null)

	updateAction ()
	Parse incoming values and update if valid @noinspection PhpParamsInspection. More...

Protected Member Functions
	initObject ()
	Init ADT-based object. More...

	prepareFormElements (ilADTGroupFormBridge $a_adt_form)
	Prepare/customize form elements. More...

	initForm ()
	Init ADT-based form. More...

Protected Attributes
ilADTBasedObject	$object = null

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

Private Attributes
ilObjectGUI	$gui

Detailed Description

ADT based-object GUI base class.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilADTBasedObjectGUI::__construct ( ilObjectGUI $a_parent_gui )

Constructor Parent GUI is just needed for testing (ilCtrl)

Parameters

ilObjectGUI $a_parent_gui

Definition at line 40 of file class.ilADTBasedObjectGUI.php.

    {
        global $DIC;
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
 
        $this->gui = $a_parent_gui;
        $this->object = $this->initObject();
    }

References $DIC, ILIAS\Repository\ctrl(), initObject(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ editAction()

ilADTBasedObjectGUI::editAction ( ?ilADTGroupFormBridge $a_form = null )

Definition at line 61 of file class.ilADTBasedObjectGUI.php.

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

References initForm().

Referenced by updateAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilADTBasedObjectGUI::initForm ( )

protected

Init ADT-based form.

Returns: ilADTFormBridge $a_form

@noinspection PhpParamsInspection

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

                                 : ilADTFormBridge
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this->gui, "updateAction"));
 
        $adt_form = ilADTFactory::getInstance()->getFormBridgeForInstance($this->object->getProperties());
 
        // has to be done BEFORE prepareFormElements() ...
        $adt_form->setForm($form);
 
        $this->prepareFormElements($adt_form);
 
        $adt_form->addToForm();
        $adt_form->addJS($this->tpl);
 
        // :TODO:
        $form->addCommandButton("updateAction", $this->lng->txt("save"));
 
        return $adt_form;
    }

References ILIAS\Repository\ctrl(), ilADTFactory\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and prepareFormElements().

Referenced by editAction(), and updateAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initObject()

ilADTBasedObjectGUI::initObject ( )

abstractprotected

Init ADT-based object.

Reimplemented in ilADTTestGUI.

Referenced by __construct().

Here is the caller graph for this function:

◆ prepareFormElements()

ilADTBasedObjectGUI::prepareFormElements ( ilADTGroupFormBridge $a_adt_form )

abstractprotected

Prepare/customize form elements.

Parameters

ilADTGroupFormBridge $a_adt_form

Reimplemented in ilADTTestGUI.

Referenced by initForm().

Here is the caller graph for this function:

◆ updateAction()

ilADTBasedObjectGUI::updateAction ( )

Parse incoming values and update if valid @noinspection PhpParamsInspection.

Definition at line 107 of file class.ilADTBasedObjectGUI.php.

                                  : bool
    {
        $adt_form = $this->initForm();
        $valid = $adt_form->getForm()->checkInput();
 
        $old_chksum = $this->object->getProperties()->getCheckSum();
 
        $adt_form->importFromPost();
        $valid = $adt_form->validate();
 
        $changed = ($old_chksum != $this->object->getProperties()->getCheckSum());
 
        // validation errors have top priority
        if (!$valid) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
            return $this->editAction($adt_form);
        }
 
        // :TODO: experimental, update only if necessary
        if ($changed) {
            if ($this->object->update()) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
            } else {
                // error occured in db-layer (primary/unique)
                foreach ($this->object->getDBErrors() as $element_id => $codes) {
                    $element = $adt_form->getElement($element_id);
                    if ($element) {
                        $element->setExternalErrors($this->object->translateDBErrorCodes($codes));
                    }
                }
 
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
                return $this->editAction($adt_form);
            }
        }
 
        $this->ctrl->redirect($this->gui, "edit");
        return true;
    }