Collaboration diagram for ilTestPlayerConfirmationModal:

Public Member Functions
	getModalId ()

	setModalId ($modalId)

	getHeaderText ()

	setHeaderText ($headerText)

	getConfirmationText ()

	setConfirmationText ($confirmationText)

	getConfirmationCheckboxName ()

	setConfirmationCheckboxName ($confirmationCheckboxName)

	getConfirmationCheckboxLabel ()

	setConfirmationCheckboxLabel ($confirmationCheckboxLabel)

	getButtons ()

	addButton (ilLinkButton $button)

	getParameters ()

	addParameter (ilHiddenInputGUI $hiddenInputGUI)

	isConfirmationCheckboxRequired ()

	buildBody ()

	getHTML ()

	buildModalButtonInstance ($buttonId)

Protected Attributes
	$modalId = ''

	$headerText = ''

	$confirmationText = ''

	$confirmationCheckboxName = ''

	$confirmationCheckboxLabel = ''

	$buttons = array()

	$parameters = array()

Detailed Description

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

Member Function Documentation

◆ addButton()

ilTestPlayerConfirmationModal::addButton ( ilLinkButton $button )

Parameters

ilLinkButton $button

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

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

◆ addParameter()

ilTestPlayerConfirmationModal::addParameter ( ilHiddenInputGUI $hiddenInputGUI )

Parameters

ilHiddenInputGUI $hiddenInputGUI

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

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

◆ buildBody()

ilTestPlayerConfirmationModal::buildBody ( )

Returns: string

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

    {
        $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');
            $tpl->setVariable('BUTTON', $button->render());
            $tpl->parseCurrentBlock();
        }
        
        $tpl->setVariable('CONFIRMATION_TEXT', $this->getConfirmationText());
        
        return $tpl->get();
    }

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

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildModalButtonInstance()

ilTestPlayerConfirmationModal::buildModalButtonInstance ( $buttonId )

Parameters

string $buttonId

Returns: ilLinkButton

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

    {
        $button = ilLinkButton::getInstance();
        
        $button->setUrl('#');
        $button->setId($buttonId);
        
        return $button;
    }

References ilLinkButton\getInstance().

Here is the call graph for this function:

◆ getButtons()

ilTestPlayerConfirmationModal::getButtons ( )

Returns: ilLinkButton[]

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

    {
        return $this->buttons;
    }

References $buttons.

Referenced by buildBody().

Here is the caller graph for this function:

◆ getConfirmationCheckboxLabel()

ilTestPlayerConfirmationModal::getConfirmationCheckboxLabel ( )

Returns: string

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

    {
        return $this->confirmationCheckboxLabel;
    }

References $confirmationCheckboxLabel.

Referenced by buildBody(), and isConfirmationCheckboxRequired().

Here is the caller graph for this function:

◆ getConfirmationCheckboxName()

ilTestPlayerConfirmationModal::getConfirmationCheckboxName ( )

Returns: string

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

    {
        return $this->confirmationCheckboxName;
    }

References $confirmationCheckboxName.

Referenced by buildBody(), and isConfirmationCheckboxRequired().

Here is the caller graph for this function:

◆ getConfirmationText()

ilTestPlayerConfirmationModal::getConfirmationText ( )

Returns: string

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

    {
        return $this->confirmationText;
    }

References $confirmationText.

Referenced by buildBody().

Here is the caller graph for this function:

◆ getHeaderText()

ilTestPlayerConfirmationModal::getHeaderText ( )

Returns: string

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

    {
        return $this->headerText;
    }

References $headerText.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilTestPlayerConfirmationModal::getHTML ( )

Returns: string

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

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

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

Here is the call graph for this function:

◆ getModalId()

ilTestPlayerConfirmationModal::getModalId ( )

Returns: string

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

    {
        return $this->modalId;
    }

References $modalId.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getParameters()

ilTestPlayerConfirmationModal::getParameters ( )

Returns: ilHiddenInputGUI[]

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

    {
        return $this->parameters;
    }

References $parameters.

Referenced by buildBody().

Here is the caller graph for this function:

◆ isConfirmationCheckboxRequired()

ilTestPlayerConfirmationModal::isConfirmationCheckboxRequired ( )

Returns: bool

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

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

References getConfirmationCheckboxLabel(), and getConfirmationCheckboxName().

Referenced by buildBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConfirmationCheckboxLabel()

ilTestPlayerConfirmationModal::setConfirmationCheckboxLabel ( $confirmationCheckboxLabel )

Parameters

string $confirmationCheckboxLabel

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

    {
        $this->confirmationCheckboxLabel = $confirmationCheckboxLabel;
    }

References $confirmationCheckboxLabel.

◆ setConfirmationCheckboxName()

ilTestPlayerConfirmationModal::setConfirmationCheckboxName ( $confirmationCheckboxName )

Parameters

string $confirmationCheckboxName

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

    {
        $this->confirmationCheckboxName = $confirmationCheckboxName;
    }

References $confirmationCheckboxName.

◆ setConfirmationText()

ilTestPlayerConfirmationModal::setConfirmationText ( $confirmationText )

Parameters

string $confirmationText

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

    {
        $this->confirmationText = $confirmationText;
    }

References $confirmationText.

◆ setHeaderText()

ilTestPlayerConfirmationModal::setHeaderText ( $headerText )

Parameters

string $headerText

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

    {
        $this->headerText = $headerText;
    }

References $headerText.

◆ setModalId()

ilTestPlayerConfirmationModal::setModalId ( $modalId )

Parameters

string $modalId

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

    {
        $this->modalId = $modalId;
    }

References $modalId.

Field Documentation

◆ $buttons

ilTestPlayerConfirmationModal::$buttons = array()

protected

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

Referenced by getButtons().

◆ $confirmationCheckboxLabel

ilTestPlayerConfirmationModal::$confirmationCheckboxLabel = ''

protected

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

Referenced by getConfirmationCheckboxLabel(), and setConfirmationCheckboxLabel().

◆ $confirmationCheckboxName

ilTestPlayerConfirmationModal::$confirmationCheckboxName = ''

protected

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

Referenced by getConfirmationCheckboxName(), and setConfirmationCheckboxName().

◆ $confirmationText

ilTestPlayerConfirmationModal::$confirmationText = ''

protected

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

Referenced by getConfirmationText(), and setConfirmationText().

◆ $headerText

ilTestPlayerConfirmationModal::$headerText = ''

protected

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

Referenced by getHeaderText(), and setHeaderText().

◆ $modalId

ilTestPlayerConfirmationModal::$modalId = ''

protected

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

Referenced by getModalId(), and setModalId().

◆ $parameters

ilTestPlayerConfirmationModal::$parameters = array()

protected

Definition at line 48 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

Member Function Documentation

◆ addButton()

◆ addParameter()

◆ buildBody()

◆ buildModalButtonInstance()

◆ getButtons()

◆ getConfirmationCheckboxLabel()

◆ getConfirmationCheckboxName()

◆ getConfirmationText()

◆ getHeaderText()

◆ getHTML()

◆ getModalId()

◆ getParameters()

◆ isConfirmationCheckboxRequired()

◆ setConfirmationCheckboxLabel()

◆ setConfirmationCheckboxName()

◆ setConfirmationText()

◆ setHeaderText()

◆ setModalId()

Field Documentation

◆ $buttons

◆ $confirmationCheckboxLabel

◆ $confirmationCheckboxName

◆ $confirmationText

◆ $headerText

◆ $modalId

◆ $parameters