ilConfirmationGUI Class Reference

Confirmation screen class. More...

Inheritance diagram for ilConfirmationGUI:

Collaboration diagram for ilConfirmationGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	setFormAction ($a_form_action)
	getFormAction ()
	setHeaderText ($a_headertext)
	Set Set header text. More...
	getHeaderText ()
	Get Set header text. More...
	addButton ($a_txt, $a_cmd)
	Set cancel button command and text. More...
	setCancel ($a_txt, $a_cmd, $a_id="")
	Set cancel button command and text. More...
	setConfirm ($a_txt, $a_cmd, $a_id="")
	Set confirmation button command and text. More...
	addItem ( $a_post_var, $a_id, $a_text, $a_img="", $a_alt="")
	Add row item. More...
	addHiddenItem ($a_post_var, $a_value)
	Add hidden item. More...
	getHTML ()
	Get confirmation screen HTML. More...
	setFormName ($a_name)
	Set form name. More...

Protected Attributes
	$lng

Private Attributes
	$hidden_item = array()
	$item = array()
	$use_images = false
	$buttons = array()
	$form_name

Detailed Description

Confirmation screen class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilConfirmationGUI::__construct

(

)

Constructor.

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

References $DIC.

    {
        global $DIC;

        $this->lng = $DIC->language();
    }

Member Function Documentation

addButton()

ilConfirmationGUI::addButton (   $a_txt,   $a_cmd  )

final

Set cancel button command and text.

Parameters

string	cancel text
string	cancel command

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

    {
        $this->buttons[] = array(
            "txt" => $a_txt, "cmd" => $a_cmd);
    }

addHiddenItem()

ilConfirmationGUI::addHiddenItem	(		$a_post_var,
			$a_value
	)

Add hidden item.

Parameters

string	name of post variable used for id (e.g. "id[]")
mixed	value

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

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

    {
        $this->hidden_item[] = array("var" => $a_post_var, "value" => $a_value);
    }

Here is the caller graph for this function:

addItem()

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

Add row item.

Parameters

string	name of post variable used for id (e.g. "id[]")
mixed	id value
string	item text
string	item image path

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

      {
        $this->item[] = array("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 44 of file class.ilConfirmationGUI.php.

Referenced by getHTML().

    {
        return $this->form_action;
    }

Here is the caller graph for this function:

getHeaderText()

ilConfirmationGUI::getHeaderText

(

)

Get Set header text.

Returns

string Set header text

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

Referenced by getHTML().

    {
        return $this->headertext;
    }

Here is the caller graph for this function:

getHTML()

ilConfirmationGUI::getHTML ( )

final

Get confirmation screen HTML.

Returns

string HTML code.

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

References Vendor\Package\$b, $hidden_item, $lng, getFormAction(), getHeaderText(), ilSubmitButton\getInstance(), and ilUtil\sendQuestion().

    {
        $lng = $this->lng;
        
        ilUtil::sendQuestion($this->getHeaderText());
        
        include_once("./Services/Utilities/classes/class.ilConfirmationTableGUI.php");

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

            // other buttons
            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();
        } else { // simple version, just ask for confirmation
            $tb = new ilToolbarGUI();
            $tb->setPreventDoubleSubmission(true);
            $tb->setFormAction($this->getFormAction());
            if ($this->hidden_item) {
                require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                foreach ($this->hidden_item as $hidden_item) {
                    $hiddenInput = new ilHiddenInputGUI($hidden_item['var']);
                    $hiddenInput->setValue($hidden_item['value']);
                    $tb->addInputItem($hiddenInput);
                }
            }
            require_once 'Services/UIComponent/Button/classes/class.ilSubmitButton.php';
            $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);
            $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 (   $a_txt,   $a_cmd,   $a_id = ""  )

final

Set cancel button command and text.

Parameters

string	cancel text
string	cancel command

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

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

    {
        $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 (   $a_txt,   $a_cmd,   $a_id = ""  )

final

Set confirmation button command and text.

Parameters

string	confirmation button text
string	confirmation button command

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

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

    {
        $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 (   $a_form_action )

final

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

Referenced by ilTestPassDeletionConfirmationGUI\__construct(), ilCalendarAppointmentGUI\cancelBooking(), ilCalendarAppointmentGUI\confirmRegister(), and ilCalendarAppointmentGUI\confirmUnregister().

    {
        $this->form_action = $a_form_action;
    }

Here is the caller graph for this function:

setFormName()

ilConfirmationGUI::setFormName

(

$a_name

)

Set form name.

Parameters

string

$a_name

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

    {
        $this->form_name = $a_name;
    }

setHeaderText()

ilConfirmationGUI::setHeaderText

(

$a_headertext

)

Set Set header text.

Parameters

string

$a_headertext

Set header text

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

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

    {
        $this->headertext = $a_headertext;
    }

Here is the caller graph for this function:

Field Documentation

$buttons

ilConfirmationGUI::$buttons = array()

private

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

$form_name

ilConfirmationGUI::$form_name

private

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

$hidden_item

ilConfirmationGUI::$hidden_item = array()

private

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

Referenced by getHTML().

$item

ilConfirmationGUI::$item = array()

private

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

Referenced by ilTestSettingsChangeConfirmationGUI\populateParametersFromPropertyForm().

$lng

ilConfirmationGUI::$lng

protected

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

Referenced by getHTML().

$use_images

ilConfirmationGUI::$use_images = false

private

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

---

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

• Services/Utilities/classes/class.ilConfirmationGUI.php