ilModalGUI Class Reference

Modal class. More...

Collaboration diagram for ilModalGUI:

Public Member Functions
	setId ($a_val)
	Set id. More...
	getId ()
	Get id. More...
	setHeading ($a_val)
	Set heading. More...
	getHeading ()
	Get heading. More...
	setBody ($a_val)
	Set body. More...
	getBody ()
	Get body. More...
	setType ($a_val)
	Set type. More...
	getType ()
	Get type. More...
	addButton (ilButtonBase $but)
	Add button. More...
	getButtons ()
	Get buttons. More...
	getHTML ()
	Get HTML. More...

Static Public Member Functions
static	getInstance ()
	Get instance. More...
static	initJS (ilTemplate $a_main_tpl=null)
	Init javascript. More...

Data Fields
const	TYPE_LARGE = "large"
const	TYPE_MEDIUM = "medium"
const	TYPE_SMALL = "small"

Protected Member Functions
	__construct ()
	Constructor. More...

Protected Attributes
	$heading = ""
	$body = ""
	$id = ""
	$type = self::TYPE_MEDIUM
	$buttons = array()

Detailed Description

Modal class.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilModalGUI::__construct ( )

protected

Constructor.

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

    {
    }

Member Function Documentation

addButton()

ilModalGUI::addButton

(

ilButtonBase

$but

)

Add button.

Parameters

ilButtonBase

$but

button

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

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

getBody()

ilModalGUI::getBody

(

)

Get body.

Returns

string body

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

References $body.

Referenced by getHTML().

    {
        return $this->body;
    }

Here is the caller graph for this function:

getButtons()

ilModalGUI::getButtons

(

)

Get buttons.

Returns

ilButtonBase[]

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

References $buttons.

Referenced by getHTML().

    {
        return $this->buttons;
    }

Here is the caller graph for this function:

getHeading()

ilModalGUI::getHeading

(

)

Get heading.

Returns

string heading

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

References $heading.

Referenced by getHTML().

    {
        return $this->heading;
    }

Here is the caller graph for this function:

getHTML()

ilModalGUI::getHTML

(

)

Get HTML.

Returns

string html

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

References $tpl, getBody(), getButtons(), getHeading(), getId(), and getType().

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

Here is the call graph for this function:

getId()

ilModalGUI::getId

(

)

Get id.

Returns

string id

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

References $id.

Referenced by getHTML().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstance()

static ilModalGUI::getInstance ( )

static

Get instance.

Returns

ilModalGUI panel instance

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

Referenced by ilExAssignmentGUI\addFiles(), ilSurveyEvaluationGUI\buildExportModal(), ilObjForumGUI\doHistoryCheck(), ilNewsTimelineGUI\getDeleteModal(), ilNewsTimelineGUI\getEditModal(), ilInternalLinkGUI\getInitHTML(), ilObjMediaPoolGUI\getPreviewModalHTML(), ilObjStudyProgrammeTreeGUI\initAsyncUIElements(), ilExerciseManagementGUI\initIndividualDeadlineModal(), ilTermsOfServiceSignedDocumentFormElementGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilExerciseSubmissionTableGUI\parseRow(), ilTestPlayerAbstractGUI\populateDiscardSolutionModal(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), ilTestPlayerAbstractGUI\populateNavWhenChangedModal(), assLongMenuGUI\populateQuestionSpecificFormPart(), ilTermsOfServiceAgreementByLanguageTableGUI\prepareRow(), ilTermsOfServiceAcceptanceHistoryTableGUI\prepareRow(), and ilBadgeRenderer\renderModal().

    {
        return new ilModalGUI();
    }

Here is the caller graph for this function:

getType()

ilModalGUI::getType

(

)

Get type.

Returns

string type

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

References $type.

Referenced by getHTML().

    {
        return $this->type;
    }

Here is the caller graph for this function:

initJS()

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

static

Init javascript.

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

References $DIC, and $tpl.

Referenced by ilNoteGUI\initJavascript(), ilFolderDownloadBackgroundTaskHandler\initObjectListAction(), and ilPageObjectGUI\showPage().

    {
        global $DIC;

        if ($a_main_tpl != null) {
            $tpl = $a_main_tpl;
        } else {
            $tpl = $DIC["tpl"];
        }

        $tpl->addJavascript("./Services/UIComponent/Modal/js/Modal.js");
    }

Here is the caller graph for this function:

setBody()

ilModalGUI::setBody

(

$a_val

)

Set body.

Parameters

string

$a_val

body

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

    {
        $this->body = $a_val;
    }

setHeading()

ilModalGUI::setHeading

(

$a_val

)

Set heading.

Parameters

string

$a_val

heading

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

    {
        $this->heading = $a_val;
    }

setId()

ilModalGUI::setId

(

$a_val

)

Set id.

Parameters

string

$a_val

id

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

    {
        $this->id = $a_val;
    }

setType()

ilModalGUI::setType

(

$a_val

)

Set type.

Parameters

string

$a_val

type const ilModalGUI::TYPE_SMALL|ilModalGUI::TYPE_MEDIUM|ilModalGUI::TYPE_LARGE

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

    {
        $this->type = $a_val;
    }

Field Documentation

$body

ilModalGUI::$body = ""

protected

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

Referenced by getBody().

$buttons

ilModalGUI::$buttons = array()

protected

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

Referenced by getButtons().

$heading

ilModalGUI::$heading = ""

protected

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

Referenced by getHeading().

$id

ilModalGUI::$id = ""

protected

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

Referenced by getId().

$type

ilModalGUI::$type = self::TYPE_MEDIUM

protected

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

Referenced by getType().

TYPE_LARGE

const ilModalGUI::TYPE_LARGE = "large"

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

Referenced by ilExAssignmentGUI\addFiles(), ilNewsTimelineGUI\getDeleteModal(), ilNewsTimelineGUI\getEditModal(), ilObjMediaPoolGUI\getPreviewModalHTML(), ilObjStudyProgrammeTreeGUI\initAsyncUIElements(), ilTermsOfServiceSignedDocumentFormElementGUI\insert(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), ilTermsOfServiceAgreementByLanguageTableGUI\prepareRow(), and ilTermsOfServiceAcceptanceHistoryTableGUI\prepareRow().

TYPE_MEDIUM

const ilModalGUI::TYPE_MEDIUM = "medium"

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

TYPE_SMALL

const ilModalGUI::TYPE_SMALL = "small"

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

Referenced by ilBadgeRenderer\renderModal().

---

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

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