ilLightboxGUI Class Reference

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

Collaboration diagram for ilLightboxGUI:

Public Member Functions
	__construct (string $a_id)
	setId (string $a_val)
	getId ()
	setWidth (string $a_val)
	getWidth ()
	addLightbox (\ilGlobalTemplateInterface $a_tpl=null)
	getHTML ()

Static Public Member Functions
static	getLocalLightboxJsPath ()

Protected Attributes
ilGlobalTemplateInterface	$tpl
string	$id = ""
string	$width

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 Lightbox handling

Author

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

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

Constructor & Destructor Documentation

__construct()

ilLightboxGUI::__construct

(

string

$a_id

)

Definition at line 29 of file class.ilLightboxGUI.php.

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->setId($a_id);
    }

References $DIC, and setId().

Here is the call graph for this function:

Member Function Documentation

addLightbox()

ilLightboxGUI::addLightbox

(

\ilGlobalTemplateInterface

$a_tpl = null

)

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

                                                                         : void
    {
        $tpl = $this->tpl;
 
        if ($a_tpl === null) {
            $a_tpl = $tpl;
        }
 
        $a_tpl->addJavaScript(self::getLocalLightboxJsPath());
        $a_tpl->addLightbox($this->getHTML(), $this->getId());
    }

References $tpl, ilGlobalTemplateInterface\addJavaScript(), getHTML(), and getId().

Here is the call graph for this function:

getHTML()

ilLightboxGUI::getHTML

(

)

Definition at line 74 of file class.ilLightboxGUI.php.

                             : string
    {
        $tpl = new ilTemplate("tpl.lightbox.html", true, true, "Services/UIComponent/Lightbox");
        $tpl->setVariable("LIGHTBOX_CONTENT", "");
        $tpl->setVariable("ID", $this->getId());
        if ($this->getWidth() !== "") {
            $tpl->setVariable("WIDTH", "width: " . $this->getWidth() . ";");
        }
        return $tpl->get();
    }

References $tpl, ilGlobalTemplateInterface\get(), getId(), getWidth(), and ilGlobalTemplateInterface\setVariable().

Referenced by addLightbox().

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilLightboxGUI::getId

(

)

Definition at line 42 of file class.ilLightboxGUI.php.

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by addLightbox(), and getHTML().

Here is the caller graph for this function:

getLocalLightboxJsPath()

static ilLightboxGUI::getLocalLightboxJsPath ( )

static

Definition at line 57 of file class.ilLightboxGUI.php.

                                                   : string
    {
        return "./Services/UIComponent/Lightbox/js/Lightbox.js";
    }

getWidth()

ilLightboxGUI::getWidth

(

)

Definition at line 52 of file class.ilLightboxGUI.php.

                              : string
    {
        return $this->width;
    }

References $width.

Referenced by getHTML().

Here is the caller graph for this function:

setId()

ilLightboxGUI::setId

(

string

$a_val

)

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

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

Referenced by __construct().

Here is the caller graph for this function:

setWidth()

ilLightboxGUI::setWidth

(

string

$a_val

)

Definition at line 47 of file class.ilLightboxGUI.php.

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

Field Documentation

$id

string ilLightboxGUI::$id = ""

protected

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

Referenced by getId().

$tpl

ilGlobalTemplateInterface ilLightboxGUI::$tpl

protected

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

Referenced by addLightbox(), and getHTML().

$width

string ilLightboxGUI::$width

protected

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

Referenced by getWidth().

---

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

• Services/UIComponent/Lightbox/classes/class.ilLightboxGUI.php