ilOverlayGUI 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 ilOverlayGUI:

Public Member Functions
	__construct (string $a_overlay_el_id)
	setAnchor (string $a_anchor_el_id, string $a_ov_corner="tl", string $a_anch_corner="bl")
	setSize (string $a_width="", string $a_height="")
	setFixedCenter (bool $a_fixed_center=true)
	setVisible (bool $a_visible=true)
	setTrigger (string $a_el_id, string $a_event="click", ?string $a_trigger_anchor_el_id=null)
	setAutoHide (bool $a_val)
	getAutoHide ()
	setCloseElementId (string $a_val)
	getCloseElementId ()
	getOnLoadCode ()
	add ()
	getTriggerOnLoadCode (string $a_tr_id, string $a_tr_event, string $a_anchor_el_id, bool $a_center=false, string $a_ov_corner="tl", string $a_anch_corner="bl")
	addTrigger (string $a_tr_id, string $a_tr_event, string $a_anchor_el_id, bool $a_center=false, string $a_ov_corner="tl", string $a_anch_corner="bl")

Protected Attributes
ilGlobalTemplateInterface	$tpl
string	$width = ""
string	$height = ""
bool	$fixed_center = false
bool	$visible = false
string	$anchor_el_id = ""
string	$anchor_ov_corner = ""
string	$anchor_anch_corner = ""
bool	$auto_hide = false
string	$close_el = null
string	$trigger_el_id = ''
string	$trigger_event = ''
string	$trigger_anchor_el_id = null
string	$overlay_el_id = ''

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 This is a utility class for the yui overlays. this only works, if a parent has class="yui-skin-sam" attached.

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

Constructor & Destructor Documentation

__construct()

ilOverlayGUI::__construct

(

string

$a_overlay_el_id

)

Definition at line 40 of file class.ilOverlayGUI.php.

References $DIC, and $GLOBALS.

    {
        global $DIC;

        // please check learning modules (e.g. rating) before removing this globals
        // use (they do not use standard template)
        $this->tpl = $GLOBALS["tpl"];
        $this->overlay_el_id = $a_overlay_el_id;
    }

Member Function Documentation

add()

ilOverlayGUI::add

(

)

Definition at line 143 of file class.ilOverlayGUI.php.

References $DIC, $tpl, ilGlobalTemplateInterface\addJavaScript(), ilGlobalTemplateInterface\addOnLoadCode(), getOnLoadCode(), and ilYuiUtil\initOverlay().

                         : void
    {
        $tpl = $this->tpl;
        self::initJavascript();
        $tpl->addOnLoadCode($this->getOnLoadCode());
    }

Here is the call graph for this function:

addTrigger()

ilOverlayGUI::addTrigger	(	string	$a_tr_id,
		string	$a_tr_event,
		string	$a_anchor_el_id,
		bool	$a_center = false,
		string	$a_ov_corner = "tl",
		string	$a_anch_corner = "bl"
	)

Definition at line 174 of file class.ilOverlayGUI.php.

References $tpl, ilGlobalTemplateInterface\addOnLoadCode(), and getTriggerOnLoadCode().

     : void {
        $tpl = $this->tpl;

        self::initJavascript();
        $tpl->addOnLoadCode($this->getTriggerOnLoadCode(
            $a_tr_id,
            $a_tr_event,
            $a_anchor_el_id,
            $a_center,
            $a_ov_corner,
            $a_anch_corner
        ));
    }

Here is the call graph for this function:

getAutoHide()

ilOverlayGUI::getAutoHide

(

)

Definition at line 98 of file class.ilOverlayGUI.php.

References $auto_hide.

                                 : bool
    {
        return $this->auto_hide;
    }

getCloseElementId()

ilOverlayGUI::getCloseElementId

(

)

Definition at line 108 of file class.ilOverlayGUI.php.

References $close_el.

                                       : string
    {
        return $this->close_el;
    }

getOnLoadCode()

ilOverlayGUI::getOnLoadCode

(

)

Definition at line 113 of file class.ilOverlayGUI.php.

References $auto_hide, $close_el, $fixed_center, $height, $trigger_anchor_el_id, $trigger_el_id, $trigger_event, $visible, and $width.

Referenced by add().

                                   : string
    {
        // yui cfg string
        $yuicfg["visible"] = $this->visible;

        if ($this->width !== "") {
            $yuicfg["width"] = $this->width;
        }

        if ($this->height !== "") {
            $yuicfg["height"] = $this->height;
        }
        $yuicfg["fixedcenter"] = $this->fixed_center;
        if ($this->anchor_el_id !== "") {
            $yuicfg["context"] = array($this->anchor_el_id, $this->anchor_ov_corner,
                    $this->anchor_anch_corner, array("beforeShow", "windowResize"));
        }
        // general cfg string
        $cfg["yuicfg"] = $yuicfg;
        $cfg["trigger"] = $this->trigger_el_id;
        $cfg["trigger_event"] = $this->trigger_event;
        $cfg["anchor_id"] = $this->trigger_anchor_el_id;
        $cfg["auto_hide"] = $this->auto_hide;
        $cfg["close_el"] = $this->close_el;

        //var_dump(json_encode($cfg, JSON_THROW_ON_ERROR));
        return 'il.Overlay.add("' . $this->overlay_el_id . '", ' .
            json_encode($cfg, JSON_THROW_ON_ERROR) . '); ';
    }

Here is the caller graph for this function:

getTriggerOnLoadCode()

ilOverlayGUI::getTriggerOnLoadCode	(	string	$a_tr_id,
		string	$a_tr_event,
		string	$a_anchor_el_id,
		bool	$a_center = false,
		string	$a_ov_corner = "tl",
		string	$a_anch_corner = "bl"
	)

Definition at line 161 of file class.ilOverlayGUI.php.

Referenced by addTrigger().

     : string {
        $center = ($a_center) ? "true" : "false";
        return 'il.Overlay.addTrigger("' . $a_tr_id . '","' . $a_tr_event . '","' . $this->overlay_el_id . '","' .
            $a_anchor_el_id . '", ' . $center . ',"' . $a_ov_corner . '","' . $a_anch_corner . '"); ';
    }

Here is the caller graph for this function:

setAnchor()

ilOverlayGUI::setAnchor	(	string	$a_anchor_el_id,
		string	$a_ov_corner = "tl",
		string	$a_anch_corner = "bl"
	)

Parameters

string	$a_anchor_el_id	anchor element id
string	$a_ov_corner	overlay corner ("tl", "tr", "bl", "br") aligned to...
string	$a_anch_corner	anchor corner ("tl", "tr", "bl", "br")

Definition at line 55 of file class.ilOverlayGUI.php.

     : void {
        $this->anchor_el_id = $a_anchor_el_id;
        $this->anchor_ov_corner = $a_ov_corner;
        $this->anchor_anch_corner = $a_anch_corner;
    }

setAutoHide()

ilOverlayGUI::setAutoHide

(

bool

$a_val

)

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

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

setCloseElementId()

ilOverlayGUI::setCloseElementId

(

string

$a_val

)

Definition at line 103 of file class.ilOverlayGUI.php.

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

setFixedCenter()

ilOverlayGUI::setFixedCenter

(

bool

$a_fixed_center = true

)

Definition at line 73 of file class.ilOverlayGUI.php.

                                                               : void
    {
        $this->fixed_center = $a_fixed_center;
    }

setSize()

ilOverlayGUI::setSize	(	string	$a_width = "",
		string	$a_height = ""
	)

Definition at line 65 of file class.ilOverlayGUI.php.

     : void {
        $this->width = $a_width;
        $this->height = $a_height;
    }

setTrigger()

ilOverlayGUI::setTrigger	(	string	$a_el_id,
		string	$a_event = "click",
		?string	$a_trigger_anchor_el_id = null
	)

Definition at line 83 of file class.ilOverlayGUI.php.

     : void {
        $this->trigger_el_id = $a_el_id;
        $this->trigger_event = $a_event;
        $this->trigger_anchor_el_id = $a_trigger_anchor_el_id;
    }

setVisible()

ilOverlayGUI::setVisible

(

bool

$a_visible = true

)

Definition at line 78 of file class.ilOverlayGUI.php.

                                                      : void
    {
        $this->visible = $a_visible;
    }

Field Documentation

$anchor_anch_corner

string ilOverlayGUI::$anchor_anch_corner = ""

protected

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

$anchor_el_id

string ilOverlayGUI::$anchor_el_id = ""

protected

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

$anchor_ov_corner

string ilOverlayGUI::$anchor_ov_corner = ""

protected

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

$auto_hide

bool ilOverlayGUI::$auto_hide = false

protected

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

Referenced by getAutoHide(), and getOnLoadCode().

$close_el

string ilOverlayGUI::$close_el = null

protected

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

Referenced by getCloseElementId(), and getOnLoadCode().

$fixed_center

bool ilOverlayGUI::$fixed_center = false

protected

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

Referenced by getOnLoadCode().

$height

string ilOverlayGUI::$height = ""

protected

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

Referenced by getOnLoadCode().

$overlay_el_id

string ilOverlayGUI::$overlay_el_id = ''

protected

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

$tpl

ilGlobalTemplateInterface ilOverlayGUI::$tpl

protected

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

Referenced by add(), and addTrigger().

$trigger_anchor_el_id

string ilOverlayGUI::$trigger_anchor_el_id = null

protected

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

Referenced by getOnLoadCode().

$trigger_el_id

string ilOverlayGUI::$trigger_el_id = ''

protected

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

Referenced by getOnLoadCode().

$trigger_event

string ilOverlayGUI::$trigger_event = ''

protected

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

Referenced by getOnLoadCode().

$visible

bool ilOverlayGUI::$visible = false

protected

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

Referenced by getOnLoadCode().

$width

string ilOverlayGUI::$width = ""

protected

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

Referenced by getOnLoadCode().

---

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

• Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php