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

Collaboration diagram for ilConfirmationGUI:

Public Member Functions
	setFormAction (string $a_form_action)
	getFormAction ()
	setHeaderText (string $a_headertext)
	getHeaderText ()
	setFormName (string $a_name)
	addButton (string $a_txt, string $a_cmd)
	setCancel (string $a_txt, string $a_cmd, string $a_id='')
	setConfirm (string $a_txt, string $a_cmd, string $a_id='')
	addItem (string $a_post_var, string $a_id, string $a_text, string $a_img='', string $a_alt='')
	addHiddenItem (string $a_post_var, string $a_value)
	getHTML ()

Protected Attributes
ilLanguage	$lng
string	$form_action = ''
string	$headertext = ''
string	$cancel_txt = ''
string	$cancel_cmd = ''
string	$cancel_id = ''
string	$confirm_txt = ''
string	$confirm_cmd = ''
string	$confirm_id = ''

Private Attributes
array	$hidden_item = []
array	$item = []
array	$buttons = []
bool	$use_images = false
string	$form_name = ''
ilGlobalTemplateInterface	$main_tpl

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 Confirmation screen class.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 24 of file class.ilConfirmationGUI.php.

Member Function Documentation

addButton()

ilConfirmationGUI::addButton ( string  $a_txt, string  $a_cmd  )

final

Definition at line 79 of file class.ilConfirmationGUI.php.

                                                                 : void
    {
        $this->buttons[] = [
            'txt' => $a_txt,
            'cmd' => $a_cmd
        ];
    }

addHiddenItem()

ilConfirmationGUI::addHiddenItem	(	string	$a_post_var,
		string	$a_value
	)

Definition at line 127 of file class.ilConfirmationGUI.php.

Referenced by ilTestCorrectionsGUI\addHiddenItemsFromArray(), ilDclTextRecordFieldModel\addHiddenItemsToConfirmation(), ilDclFileuploadRecordFieldModel\addHiddenItemsToConfirmation(), ilDclMobRecordFieldModel\addHiddenItemsToConfirmation(), ilDclBaseRecordFieldModel\addHiddenItemsToConfirmation(), ilTestPassDeletionConfirmationGUI\build(), ilTestSettingsChangeConfirmationGUI\populateParametersFromPost(), and ilTestSettingsChangeConfirmationGUI\populateParametersFromPropertyForm().

     : void {
        $this->hidden_item[] = [
            'var' => $a_post_var,
            'value' => $a_value
        ];
    }

Here is the caller graph for this function:

addItem()

ilConfirmationGUI::addItem	(	string	$a_post_var,
		string	$a_id,
		string	$a_text,
		string	$a_img = '',
		string	$a_alt = ''
	)

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

     : void {
        $this->item[] = [
            'var' => $a_post_var,
            'id' => $a_id,
            'text' => $a_text,
            'img' => $a_img,
            'alt' => $a_alt
        ];

        if ($a_img !== '') {
            $this->use_images = true;
        }
    }

getFormAction()

ilConfirmationGUI::getFormAction ( )

final

Definition at line 59 of file class.ilConfirmationGUI.php.

References $form_action.

Referenced by getHTML().

                                         : string
    {
        return $this->form_action;
    }

Here is the caller graph for this function:

getHeaderText()

ilConfirmationGUI::getHeaderText

(

)

Definition at line 69 of file class.ilConfirmationGUI.php.

References $headertext.

Referenced by getHTML().

                                   : string
    {
        return $this->headertext;
    }

Here is the caller graph for this function:

getHTML()

ilConfirmationGUI::getHTML ( )

final

Definition at line 137 of file class.ilConfirmationGUI.php.

References Vendor\Package\$b, getFormAction(), getHeaderText(), and ilSubmitButton\getInstance().

                                   : string
    {
        if ($this->headertext === '') {
            throw new RuntimeException('Please provide a header text before rendering the confirmation dialogue');
        }

        if ($this->form_action === '') {
            throw new RuntimeException('Please provide a form action before rendering the confirmation dialogue');
        }

        if ($this->confirm_txt === '' || $this->confirm_cmd === '') {
            throw new RuntimeException('Please provide a confirmation button label and command before rendering the confirmation dialogue');
        }

        if ($this->cancel_txt === '' || $this->cancel_cmd === '') {
            throw new RuntimeException('Please provide a cancel button label and command before rendering the confirmation dialogue');
        }

        $this->main_tpl->setOnScreenMessage('question', $this->getHeaderText());

        // delete/handle items
        if (count($this->item) > 0) {
            $ctab = new ilConfirmationTableGUI($this->use_images);
            $ctab->setData($this->item);

            foreach ($this->buttons as $b) {
                $ctab->addCommandButton($b["cmd"], $b["txt"]);
            }
            $ctab->addCommandButton($this->confirm_cmd, $this->confirm_txt);
            $ctab->addCommandButton($this->cancel_cmd, $this->cancel_txt);
            $ctab->setFormAction($this->getFormAction());
            foreach ($this->hidden_item as $hidden_item) {
                $ctab->addHiddenInput($hidden_item["var"], $hidden_item["value"]);
            }

            if ($this->form_name !== '') {
                $ctab->setFormName($this->form_name);
            }

            return $ctab->getHTML();
        }

        // simple version, just ask for confirmation
        $tb = new ilToolbarGUI();
        $tb->setPreventDoubleSubmission(true);
        $tb->setFormAction($this->getFormAction());
        if ($this->hidden_item) {
            foreach ($this->hidden_item as $hidden_item) {
                $hiddenInput = new ilHiddenInputGUI($hidden_item['var']);
                $hiddenInput->setValue($hidden_item['value']);
                $tb->addInputItem($hiddenInput);
            }
        }
        $confirm = ilSubmitButton::getInstance();
        $confirm->setCommand($this->confirm_cmd);
        $confirm->setCaption($this->confirm_txt, false);
        $confirm->setId($this->confirm_id);

        $cancel = ilSubmitButton::getInstance();
        $cancel->setCommand($this->cancel_cmd);
        $cancel->setCaption($this->cancel_txt, false);

        if ($this->cancel_id !== '') {
            $cancel->setId($this->cancel_id);
        }

        $tb->addStickyItem($confirm);
        $tb->addStickyItem($cancel);

        return $tb->getHTML();
    }

Here is the call graph for this function:

setCancel()

ilConfirmationGUI::setCancel ( string  $a_txt, string  $a_cmd, string  $a_id = ''  )

final

Definition at line 87 of file class.ilConfirmationGUI.php.

Referenced by ilTestPassDeletionConfirmationGUI\build(), and ilTestAnswerOptionalQuestionsConfirmationGUI\build().

     : void {
        $this->cancel_txt = $a_txt;
        $this->cancel_cmd = $a_cmd;
        $this->cancel_id = $a_id;
    }

Here is the caller graph for this function:

setConfirm()

ilConfirmationGUI::setConfirm ( string  $a_txt, string  $a_cmd, string  $a_id = ''  )

final

Definition at line 97 of file class.ilConfirmationGUI.php.

Referenced by ilTestPassDeletionConfirmationGUI\build(), and ilTestAnswerOptionalQuestionsConfirmationGUI\build().

     : void {
        $this->confirm_txt = $a_txt;
        $this->confirm_cmd = $a_cmd;
        $this->confirm_id = $a_id;
    }

Here is the caller graph for this function:

setFormAction()

ilConfirmationGUI::setFormAction ( string  $a_form_action )

final

Definition at line 54 of file class.ilConfirmationGUI.php.

Referenced by ilTestPassDeletionConfirmationGUI\__construct().

                                                              : void
    {
        $this->form_action = $a_form_action;
    }

Here is the caller graph for this function:

setFormName()

ilConfirmationGUI::setFormName

(

string

$a_name

)

Definition at line 74 of file class.ilConfirmationGUI.php.

                                               : void
    {
        $this->form_name = $a_name;
    }

setHeaderText()

ilConfirmationGUI::setHeaderText

(

string

$a_headertext

)

Definition at line 64 of file class.ilConfirmationGUI.php.

Referenced by ilTestPassDeletionConfirmationGUI\build(), ilTestAnswerOptionalQuestionsConfirmationGUI\build(), and ilTestSettingsChangeConfirmationGUI\build().

                                                       : void
    {
        $this->headertext = $a_headertext;
    }

Here is the caller graph for this function:

Field Documentation

$buttons

array ilConfirmationGUI::$buttons = []

private

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

$cancel_cmd

string ilConfirmationGUI::$cancel_cmd = ''

protected

Definition at line 38 of file class.ilConfirmationGUI.php.

$cancel_id

string ilConfirmationGUI::$cancel_id = ''

protected

Definition at line 39 of file class.ilConfirmationGUI.php.

$cancel_txt

string ilConfirmationGUI::$cancel_txt = ''

protected

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

$confirm_cmd

string ilConfirmationGUI::$confirm_cmd = ''

protected

Definition at line 41 of file class.ilConfirmationGUI.php.

$confirm_id

string ilConfirmationGUI::$confirm_id = ''

protected

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

$confirm_txt

string ilConfirmationGUI::$confirm_txt = ''

protected

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

$form_action

string ilConfirmationGUI::$form_action = ''

protected

Definition at line 35 of file class.ilConfirmationGUI.php.

Referenced by getFormAction().

$form_name

string ilConfirmationGUI::$form_name = ''

private

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

$headertext

string ilConfirmationGUI::$headertext = ''

protected

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

Referenced by getHeaderText().

$hidden_item

array ilConfirmationGUI::$hidden_item = []

private

Definition at line 28 of file class.ilConfirmationGUI.php.

$item

array ilConfirmationGUI::$item = []

private

Definition at line 30 of file class.ilConfirmationGUI.php.

Referenced by ilTestSettingsChangeConfirmationGUI\populateParametersFromPropertyForm().

$lng

ilLanguage ilConfirmationGUI::$lng

protected

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

Referenced by ilTestAnswerOptionalQuestionsConfirmationGUI\__construct(), and ilTestPassDeletionConfirmationGUI\__construct().

$main_tpl

ilGlobalTemplateInterface ilConfirmationGUI::$main_tpl

private

Definition at line 43 of file class.ilConfirmationGUI.php.

$use_images

bool ilConfirmationGUI::$use_images = false

private

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

---

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

• Services/UIComponent/Confirmation/class.ilConfirmationGUI.php