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

Public Member Functions
	__construct (string $content_container_id=null)
	initJs ()
	Setup the message templates and add the js onload code. More...
	getHTML ()
	Returns the component (returns the js tag) More...
	getContentContainerId ()
	Gets the target container for the notification. More...
	setContentContainerId (?string $content_container_id)
	Sets the target container for the notification. More...
	getJsPath ()
	Return the path for the java scripts. More...
	setJsPath (string $js_path)
	Sets the path for the java scripts. More...
	getJsConfig ($key)
	Gets a setting of the jquery-plugin config. More...
	addJsConfig ($key, $value)
	Sets Jquery settings for the plugin. More...

Protected Attributes
bool	$js_init
string	$content_container_id
string	$js_path
array	$js_config

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 Class ilAsyncNotifications Allows displaying async notifications on a page

Author

Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

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

Constructor & Destructor Documentation

__construct()

ilAsyncNotifications::__construct

(

string

$content_container_id = null

)

Definition at line 50 of file class.ilAsyncNotifications.php.

    {
        $this->js_init = false;
        $this->js_path = "./Modules/StudyProgramme/templates/js/";
        $this->content_container_id = $content_container_id ?? "ilContentContainer";
    }

Member Function Documentation

addJsConfig()

ilAsyncNotifications::addJsConfig	(		$key,
			$value
	)

Sets Jquery settings for the plugin.

Parameters

mixed	$key
mixed	$value

Definition at line 144 of file class.ilAsyncNotifications.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by initJs().

                                             : void
    {
        $this->js_config[$key] = $value;
    }

Here is the caller graph for this function:

getContentContainerId()

ilAsyncNotifications::getContentContainerId

(

)

Gets the target container for the notification.

Definition at line 99 of file class.ilAsyncNotifications.php.

References $content_container_id.

                                           : ?string
    {
        return $this->content_container_id;
    }

getHTML()

ilAsyncNotifications::getHTML

(

)

Returns the component (returns the js tag)

Definition at line 91 of file class.ilAsyncNotifications.php.

References initJs().

                             : void
    {
        $this->initJs();
    }

Here is the call graph for this function:

getJsConfig()

ilAsyncNotifications::getJsConfig

(

$key

)

Gets a setting of the jquery-plugin config.

Returns

mixed $key

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

References ILIAS\LTI\ToolProvider\$key.

    {
        return $this->js_config[$key];
    }

getJsPath()

ilAsyncNotifications::getJsPath

(

)

Return the path for the java scripts.

Definition at line 115 of file class.ilAsyncNotifications.php.

References $js_path.

Referenced by initJs().

                               : string
    {
        return $this->js_path;
    }

Here is the caller graph for this function:

initJs()

ilAsyncNotifications::initJs

(

)

Setup the message templates and add the js onload code.

Definition at line 60 of file class.ilAsyncNotifications.php.

References $DIC, $tpl, addJsConfig(), getJsPath(), and ilUtil\getSystemMessageHTML().

Referenced by getHTML().

                            : void
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        if (!$this->js_init) {
            $tpl->addJavaScript($this->getJsPath() . 'ilStudyProgramme.js');

            // TODO: DW -> refactor ilUtil
            $templates['info'] = ilUtil::getSystemMessageHTML("[MESSAGE]");
            $templates['success'] = ilUtil::getSystemMessageHTML("[MESSAGE]", 'success');
            $templates['failure'] = ilUtil::getSystemMessageHTML("[MESSAGE]", 'failure');
            $templates['question'] = ilUtil::getSystemMessageHTML("[MESSAGE]", 'question');

            $this->addJsConfig('templates', $templates);

            $tpl->addOnLoadCode(
                "$('#" .
                $this->content_container_id .
                "').study_programme_notifications(" .
                json_encode($this->js_config, JSON_THROW_ON_ERROR) .
                ");"
            );

            $this->js_init = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContentContainerId()

ilAsyncNotifications::setContentContainerId

(

?string

$content_container_id

)

Sets the target container for the notification.

Definition at line 107 of file class.ilAsyncNotifications.php.

References $content_container_id.

                                                                        : void
    {
        $this->content_container_id = $content_container_id;
    }

setJsPath()

ilAsyncNotifications::setJsPath

(

string

$js_path

)

Sets the path for the java scripts.

Definition at line 123 of file class.ilAsyncNotifications.php.

References $js_path.

                                              : void
    {
        $this->js_path = $js_path;
    }

Field Documentation

$content_container_id

string ilAsyncNotifications::$content_container_id

protected

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

Referenced by getContentContainerId(), and setContentContainerId().

$js_config

array ilAsyncNotifications::$js_config

protected

Definition at line 48 of file class.ilAsyncNotifications.php.

$js_init

bool ilAsyncNotifications::$js_init

protected

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

$js_path

string ilAsyncNotifications::$js_path

protected

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

Referenced by getJsPath(), and setJsPath().

---

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

• Modules/StudyProgramme/classes/helpers/class.ilAsyncNotifications.php