Collaboration diagram for ilTestPlayerConfirmationModal:

Public Member Functions
	__construct (protected UIRenderer $ui_renderer)

	getModalId ()

	setModalId (string $modal_id)

	getHeaderText ()

	setHeaderText (string $header_text)

	getConfirmationText ()

	setConfirmationText (string $confirmation_text)

	getConfirmationCheckboxName ()

	setConfirmationCheckboxName (string $confirmation_checkbox_name)

	getConfirmationCheckboxLabel ()

	setConfirmationCheckboxLabel (string $confirmation_checkbox_label)

	getButtons ()

	addButton (StandardButton\|PrimaryButton\|ilLinkButton $button)

	getParameters ()

	addParameter (ilHiddenInputGUI $hidden_input_gui)

	isConfirmationCheckboxRequired ()

	buildBody ()

	getHTML ()

Protected Attributes
string	$modal_id = ''

string	$header_text = ''

string	$confirmation_text = ''

string	$confirmation_checkbox_name = ''

string	$confirmation_checkbox_label = ''

array	$buttons = []

array	$parameters = []

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestPlayerConfirmationModal::__construct ( protected UIRenderer $ui_renderer )

Definition at line 51 of file class.ilTestPlayerConfirmationModal.php.

53 {

54 }

Member Function Documentation

◆ addButton()

ilTestPlayerConfirmationModal::addButton ( StandardButton|PrimaryButton|ilLinkButton $button )

Definition at line 114 of file class.ilTestPlayerConfirmationModal.php.

     {
         $this->buttons[] = $button;
     }

◆ addParameter()

ilTestPlayerConfirmationModal::addParameter ( ilHiddenInputGUI $hidden_input_gui )

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

     {
         $this->parameters[] = $hidden_input_gui;
     }

◆ buildBody()

ilTestPlayerConfirmationModal::buildBody ( )

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

References getButtons(), getConfirmationCheckboxLabel(), getConfirmationCheckboxName(), getConfirmationText(), getParameters(), and isConfirmationCheckboxRequired().

Referenced by getHTML().

                                : string
     {
         $tpl = new ilTemplate('tpl.tst_player_confirmation_modal.html', true, true, 'Modules/Test');
 
         if ($this->isConfirmationCheckboxRequired()) {
             $tpl->setCurrentBlock('checkbox');
             $tpl->setVariable('CONFIRMATION_CHECKBOX_NAME', $this->getConfirmationCheckboxName());
             $tpl->setVariable('CONFIRMATION_CHECKBOX_LABEL', $this->getConfirmationCheckboxLabel());
             $tpl->parseCurrentBlock();
         }
 
         foreach ($this->getParameters() as $parameter) {
             $tpl->setCurrentBlock('hidden_inputs');
             $tpl->setVariable('HIDDEN_INPUT', $parameter->getToolbarHTML());
             $tpl->parseCurrentBlock();
         }
 
         foreach ($this->getButtons() as $button) {
             $tpl->setCurrentBlock('buttons');
             if ($button instanceof StandardButton || $button instanceof PrimaryButton) {
                 $button_str = $this->ui_renderer->render($button);
             } elseif ($button instanceof ilLinkButton) {
                 $button_str = $button->render();
             }
 
             $tpl->setVariable('BUTTON', $button_str);
             $tpl->parseCurrentBlock();
         }
 
         $tpl->setVariable('CONFIRMATION_TEXT', $this->getConfirmationText());
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getButtons()

ilTestPlayerConfirmationModal::getButtons ( )

Returns: []

Definition at line 109 of file class.ilTestPlayerConfirmationModal.php.

References $buttons.

Referenced by buildBody().

                                 : array
     {
         return $this->buttons;
     }

Here is the caller graph for this function:

◆ getConfirmationCheckboxLabel()

ilTestPlayerConfirmationModal::getConfirmationCheckboxLabel ( )

Definition at line 96 of file class.ilTestPlayerConfirmationModal.php.

References $confirmation_checkbox_label.

Referenced by buildBody(), and isConfirmationCheckboxRequired().

                                                   : string
     {
         return $this->confirmation_checkbox_label;
     }

Here is the caller graph for this function:

◆ getConfirmationCheckboxName()

ilTestPlayerConfirmationModal::getConfirmationCheckboxName ( )

Definition at line 86 of file class.ilTestPlayerConfirmationModal.php.

References $confirmation_checkbox_name.

Referenced by buildBody(), and isConfirmationCheckboxRequired().

                                                  : string
     {
         return $this->confirmation_checkbox_name;
     }

Here is the caller graph for this function:

◆ getConfirmationText()

ilTestPlayerConfirmationModal::getConfirmationText ( )

Definition at line 76 of file class.ilTestPlayerConfirmationModal.php.

References $confirmation_text.

Referenced by buildBody().

                                          : string
     {
         return $this->confirmation_text;
     }

Here is the caller graph for this function:

◆ getHeaderText()

ilTestPlayerConfirmationModal::getHeaderText ( )

Definition at line 66 of file class.ilTestPlayerConfirmationModal.php.

References $header_text.

Referenced by getHTML().

                                    : string
     {
         return $this->header_text;
     }

Here is the caller graph for this function:

◆ getHTML()

ilTestPlayerConfirmationModal::getHTML ( )

Definition at line 171 of file class.ilTestPlayerConfirmationModal.php.

References buildBody(), getHeaderText(), ilModalGUI\getInstance(), and getModalId().

                              : string
     {
         $modal = ilModalGUI::getInstance();
         $modal->setId($this->getModalId());
         $modal->setHeading($this->getHeaderText());
         $modal->setBody($this->buildBody());
         return $modal->getHTML();
     }

Here is the call graph for this function:

◆ getModalId()

ilTestPlayerConfirmationModal::getModalId ( )

Definition at line 56 of file class.ilTestPlayerConfirmationModal.php.

References $modal_id.

Referenced by getHTML().

                                 : string
     {
         return $this->modal_id;
     }

Here is the caller graph for this function:

◆ getParameters()

ilTestPlayerConfirmationModal::getParameters ( )

Returns: ilHiddenInputGUI[]

Definition at line 122 of file class.ilTestPlayerConfirmationModal.php.

References $parameters.

Referenced by buildBody().

                                    : array
     {
         return $this->parameters;
     }

Here is the caller graph for this function:

◆ isConfirmationCheckboxRequired()

ilTestPlayerConfirmationModal::isConfirmationCheckboxRequired ( )

Definition at line 132 of file class.ilTestPlayerConfirmationModal.php.

References getConfirmationCheckboxLabel(), and getConfirmationCheckboxName().

Referenced by buildBody().

                                                     : bool
     {
         return strlen($this->getConfirmationCheckboxName()) && strlen($this->getConfirmationCheckboxLabel());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConfirmationCheckboxLabel()

ilTestPlayerConfirmationModal::setConfirmationCheckboxLabel ( string $confirmation_checkbox_label )

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

References $confirmation_checkbox_label.

     {
         $this->confirmation_checkbox_label = $confirmation_checkbox_label;
     }

◆ setConfirmationCheckboxName()

ilTestPlayerConfirmationModal::setConfirmationCheckboxName ( string $confirmation_checkbox_name )

Definition at line 91 of file class.ilTestPlayerConfirmationModal.php.

References $confirmation_checkbox_name.

     {
         $this->confirmation_checkbox_name = $confirmation_checkbox_name;
     }

◆ setConfirmationText()

ilTestPlayerConfirmationModal::setConfirmationText ( string $confirmation_text )

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

References $confirmation_text.

     {
         $this->confirmation_text = $confirmation_text;
     }

◆ setHeaderText()

ilTestPlayerConfirmationModal::setHeaderText ( string $header_text )

Definition at line 71 of file class.ilTestPlayerConfirmationModal.php.

References $header_text.

     {
         $this->header_text = $header_text;
     }

◆ setModalId()

ilTestPlayerConfirmationModal::setModalId ( string $modal_id )

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

References $modal_id.

     {
         $this->modal_id = $modal_id;
     }

Field Documentation

◆ $buttons

array ilTestPlayerConfirmationModal::$buttons = []

protected

Definition at line 44 of file class.ilTestPlayerConfirmationModal.php.

Referenced by getButtons().

◆ $confirmation_checkbox_label

string ilTestPlayerConfirmationModal::$confirmation_checkbox_label = ''

protected

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

Referenced by getConfirmationCheckboxLabel(), and setConfirmationCheckboxLabel().

◆ $confirmation_checkbox_name

string ilTestPlayerConfirmationModal::$confirmation_checkbox_name = ''

protected

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

Referenced by getConfirmationCheckboxName(), and setConfirmationCheckboxName().

◆ $confirmation_text

string ilTestPlayerConfirmationModal::$confirmation_text = ''

protected

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

Referenced by getConfirmationText(), and setConfirmationText().

◆ $header_text

string ilTestPlayerConfirmationModal::$header_text = ''

protected

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

Referenced by getHeaderText(), and setHeaderText().

◆ $modal_id

string ilTestPlayerConfirmationModal::$modal_id = ''

protected

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

Referenced by getModalId(), and setModalId().

◆ $parameters

array ilTestPlayerConfirmationModal::$parameters = []

protected

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

Referenced by getParameters().

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

Modules/Test/classes/class.ilTestPlayerConfirmationModal.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addButton()

◆ addParameter()

◆ buildBody()

◆ getButtons()

◆ getConfirmationCheckboxLabel()

◆ getConfirmationCheckboxName()

◆ getConfirmationText()

◆ getHeaderText()

◆ getHTML()

◆ getModalId()

◆ getParameters()

◆ isConfirmationCheckboxRequired()

◆ setConfirmationCheckboxLabel()

◆ setConfirmationCheckboxName()

◆ setConfirmationText()

◆ setHeaderText()

◆ setModalId()

Field Documentation

◆ $buttons

◆ $confirmation_checkbox_label

◆ $confirmation_checkbox_name

◆ $confirmation_text

◆ $header_text

◆ $modal_id

◆ $parameters