This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilModalGUI:

Public Member Functions
	setId (string $a_val)

	getId ()

	setHeading (string $a_val)

	getHeading ()

	setBody (string $a_val)

	getBody ()

	setType (string $a_val)
	Set type. More...

	getType ()

	addButton (ilButtonBase $but)

	getButtons ()
	Get buttons. More...

	getHTML ()

Static Public Member Functions
static	getInstance ()

static	initJS (ilGlobalTemplateInterface $a_main_tpl=null)

Data Fields
const	TYPE_LARGE = "large"

const	TYPE_MEDIUM = "medium"

const	TYPE_SMALL = "small"

Protected Member Functions
	__construct ()

Protected Attributes
string	$heading = ""

string	$body = ""

string	$id = ""

string	$type = self::TYPE_MEDIUM

array	$buttons = array()

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 Modal class

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

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

Constructor & Destructor Documentation

◆ __construct()

ilModalGUI::__construct ( )

protected

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

38 {

39 }

Member Function Documentation

◆ addButton()

ilModalGUI::addButton ( ilButtonBase $but )

Definition at line 92 of file class.ilModalGUI.php.

                                                : void
    {
        $this->buttons[] = $but;
    }

◆ getBody()

ilModalGUI::getBody ( )

Definition at line 72 of file class.ilModalGUI.php.

                             : string
    {
        return $this->body;
    }

References $body.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getButtons()

ilModalGUI::getButtons ( )

Get buttons.

Returns: ilButtonBase[]

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

                                : array
    {
        return $this->buttons;
    }

References $buttons.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHeading()

ilModalGUI::getHeading ( )

Definition at line 62 of file class.ilModalGUI.php.

                                : string
    {
        return $this->heading;
    }

References $heading.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilModalGUI::getHTML ( )

Definition at line 106 of file class.ilModalGUI.php.

                             : string
    {
        $tpl = new ilTemplate("tpl.modal.html", true, true, "Services/UIComponent/Modal");
 
        if (count($this->getButtons()) > 0) {
            foreach ($this->getButtons() as $b) {
                $tpl->setCurrentBlock("button");
                $tpl->setVariable("BUTTON", $b->render());
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("footer");
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("HEADING", $this->getHeading());
 
        $tpl->setVariable("MOD_ID", $this->getId());
        $tpl->setVariable("BODY", $this->getBody());
 
        switch ($this->getType()) {
            case self::TYPE_LARGE:
                $tpl->setVariable("CLASS", "modal-lg");
                break;
 
            case self::TYPE_SMALL:
                $tpl->setVariable("CLASS", "modal-sm");
                break;
        }
 
        return $tpl->get();
    }

References Vendor\Package\$b, $tpl, getBody(), getButtons(), getHeading(), getId(), getType(), TYPE_LARGE, and TYPE_SMALL.

Here is the call graph for this function:

◆ getId()

ilModalGUI::getId ( )

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

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getInstance()

static ilModalGUI::getInstance ( )

static

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

                                        : self
    {
        return new ilModalGUI();
    }

Referenced by ilExAssignmentGUI\addFiles(), ilAssLongmenuCorrectionsInputGUI\buildAnswersModal(), ilObjForumGUI\doHistoryCheck(), ilNewsTimelineGUI\getDeleteModal(), ilNewsTimelineGUI\getEditModal(), ilTestPlayerConfirmationModal\getHTML(), ilInternalLinkGUI\getInitHTML(), ilObjStudyProgrammeTreeGUI\initAsyncUIElements(), ilExerciseManagementGUI\initIndividualDeadlineModal(), ilClozeGapInputBuilderGUI\insert(), ilTestPlayerAbstractGUI\populateDiscardSolutionModal(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), ilTestPlayerAbstractGUI\populateNavWhenChangedModal(), assLongMenuGUI\populateQuestionSpecificFormPart(), and ilNewsTimelineItemGUI\renderMediaModal().

Here is the caller graph for this function:

◆ getType()

ilModalGUI::getType ( )

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

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by getHTML().

Here is the caller graph for this function:

◆ initJS()

static ilModalGUI::initJS ( ilGlobalTemplateInterface $a_main_tpl = null )

static

Definition at line 138 of file class.ilModalGUI.php.

                                                                               : void
    {
        global $DIC;
 
        $tpl = $a_main_tpl ?? $DIC["tpl"];
 
        $tpl->addJavaScript("./Services/UIComponent/Modal/js/Modal.js");
    }

References $DIC, and $tpl.

Referenced by ilObjForumGUI\doHistoryCheck(), ilPageObjectGUI\initEditing(), and ilChatroomViewGUI\showRoom().

Here is the caller graph for this function:

◆ setBody()

ilModalGUI::setBody ( string $a_val )

Definition at line 67 of file class.ilModalGUI.php.

                                          : void
    {
        $this->body = $a_val;
    }

◆ setHeading()

ilModalGUI::setHeading ( string $a_val )

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

                                             : void
    {
        $this->heading = $a_val;
    }

◆ setId()

ilModalGUI::setId ( string $a_val )

Definition at line 46 of file class.ilModalGUI.php.

                                        : void
    {
        $this->id = $a_val;
    }

◆ setType()

ilModalGUI::setType ( string $a_val )

Set type.

Parameters

string $a_val type const ilModalGUI::TYPE_SMALL|ilModalGUI::TYPE_MEDIUM|ilModalGUI::TYPE_LARGE

Definition at line 82 of file class.ilModalGUI.php.

                                          : void
    {
        $this->type = $a_val;
    }

Field Documentation

◆ $body

string ilModalGUI::$body = ""

protected

Definition at line 27 of file class.ilModalGUI.php.

Referenced by getBody().

◆ $buttons

array ilModalGUI::$buttons = array()

protected

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

Referenced by getButtons().

◆ $heading

string ilModalGUI::$heading = ""

protected

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

Referenced by getHeading().

◆ $id

string ilModalGUI::$id = ""

protected

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

Referenced by getId().

◆ $type

string ilModalGUI::$type = self::TYPE_MEDIUM

protected

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

Referenced by getType().

◆ TYPE_LARGE

const ilModalGUI::TYPE_LARGE = "large"

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

Referenced by ilExAssignmentGUI\addFiles(), ilNewsTimelineGUI\getDeleteModal(), ilNewsTimelineGUI\getEditModal(), getHTML(), ilObjStudyProgrammeTreeGUI\initAsyncUIElements(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), and ilNewsTimelineItemGUI\renderMediaModal().

◆ TYPE_MEDIUM

const ilModalGUI::TYPE_MEDIUM = "medium"

Definition at line 31 of file class.ilModalGUI.php.

◆ TYPE_SMALL

const ilModalGUI::TYPE_SMALL = "small"

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

Referenced by getHTML().

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

Services/UIComponent/Modal/classes/class.ilModalGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addButton()

◆ getBody()

◆ getButtons()

◆ getHeading()

◆ getHTML()

◆ getId()

◆ getInstance()

◆ getType()

◆ initJS()

◆ setBody()

◆ setHeading()

◆ setId()

◆ setType()

Field Documentation

◆ $body

◆ $buttons

◆ $heading

◆ $id

◆ $type

◆ TYPE_LARGE

◆ TYPE_MEDIUM

◆ TYPE_SMALL