ilNotificationGUI Class Reference

Collaboration diagram for ilNotificationGUI:

Public Member Functions
	__construct (\ilUser $user=null, \ilTemplate $template=null, \ilCtrl $controller=null, \ilLanguage $language=null, \ilLocatorGUI $locatorGUI=null, \ILIAS\DI\Container $dic=null)
	public More...
	executeCommand ()
	getHandler ($type)
	getOSDNotificationsObject ()
	Returns the pending on screen notifications for a user request. More...
	removeOSDNotificationsObject ()
	addHandler ($channel, ilNotificationHandler $handler)
	showSettingsObject ()
	addLocatorItems ()

Static Public Member Functions
static	_forwards ()

Private Member Functions
	getAvailableTypes ($types=array())
	getAvailableChannels ($types=array())
	saveCustomizingOptionObject ()
	saveSettingsObject ()

Private Attributes
	$handler = array()
	$user
	$template
	$controller
	$language
	$locatorGUI

Detailed Description

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e.de

Version

$Id$ ilNotificationGUI: ilNotificationGUI: ilPersonalProfileGUI, ilPersonalDesktopGUI

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

Constructor & Destructor Documentation

__construct()

ilNotificationGUI::__construct	(	\ilUser	$user = null,
		\ilTemplate	$template = null,
		\ilCtrl	$controller = null,
		\ilLanguage	$language = null,
		\ilLocatorGUI	$locatorGUI = null,
		\ILIAS\DI\Container	$dic = null
	)

public

Parameters

ilUser | null	$user
ilTemplate | null	$template
ilCtrl | null	$controller
ilLanguage | null	$language
ilLocatorGUI | null	$locatorGUI
\ILIAS\DI\Container | null	$dic

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

References $controller, $DIC, $language, $locatorGUI, $template, $user, and user().

      {
        if ($dic === null) {
            global $DIC;
            $dic = $DIC;
        }

        if ($user === null) {
            $user = $dic->user();
        }
        $this->user = $user;

        if ($template === null) {
            $template = $dic->ui()->mainTemplate();
        }
        $this->template = $template;

        if ($controller === null) {
            $controller = $dic->ctrl();
        }
        $this->controller = $controller;

        if ($language === null) {
            $language = $dic->language();
        }
        $this->language = $language;

        if ($locatorGUI === null) {
            $locatorGUI = $dic['ilLocator'];
        }
        $this->locatorGUI = $locatorGUI;

        $this->type = "not";

        require_once 'Services/Notifications/classes/class.ilNotificationSetupHelper.php';
    }

Here is the call graph for this function:

Member Function Documentation

_forwards()

static ilNotificationGUI::_forwards ( )

static

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

    {
        return array();
    }

addHandler()

ilNotificationGUI::addHandler	(		$channel,
		ilNotificationHandler	$handler
	)

Definition at line 159 of file class.ilNotificationGUI.php.

References $handler.

    {
        if (!array_key_exists($channel, $this->handler) || !is_array($this->handler[$channel])) {
            $this->handler[$channel] = array();
        }

        $this->handler[$channel][] = $handler;
    }

addLocatorItems()

ilNotificationGUI::addLocatorItems

(

)

Definition at line 215 of file class.ilNotificationGUI.php.

References $_GET.

    {
        if (is_object($this->object)) {
            $this->locatorGUI->addItem(
                $this->object->getTitle(),
                $this->controller->getLinkTarget($this, ''),
                '',
                $_GET["ref_id"]
            );
        }
    }

executeCommand()

ilNotificationGUI::executeCommand

(

)

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

    {
        if (!$this->controller->getCmd()) {
            return;
        }

        $cmd = $this->controller->getCmd() . 'Object';
        $this->$cmd();
    }

getAvailableChannels()

ilNotificationGUI::getAvailableChannels (   $types = array() )

private

Definition at line 111 of file class.ilNotificationGUI.php.

References ilNotificationDatabaseHandler\getAvailableChannels().

Referenced by showSettingsObject().

    {
        return ilNotificationDatabaseHandler::getAvailableChannels($types);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableTypes()

ilNotificationGUI::getAvailableTypes (   $types = array() )

private

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

References ilNotificationDatabaseHandler\getAvailableTypes().

Referenced by showSettingsObject().

    {
        return ilNotificationDatabaseHandler::getAvailableTypes($types);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHandler()

ilNotificationGUI::getHandler

(

$type

)

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

References $type.

    {
        return $this->handler[$type];
    }

getOSDNotificationsObject()

ilNotificationGUI::getOSDNotificationsObject

(

)

Returns the pending on screen notifications for a user request.

Todo:

this method should move to a better place as it handels channel sprecific things.

ilUser $ilUser

Returns

string

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

References $result, ilSession\enableWebAccessWithoutSession(), exit, ilNotificationOSDHandler\getNotificationsForUser(), and user().

    {
        ilSession::enableWebAccessWithoutSession(true);

        if ($this->user->getId() == ANONYMOUS_USER_ID) {
            return '{}';
        }

        require_once 'Services/Notifications/classes/class.ilNotificationEchoHandler.php';
        require_once 'Services/Notifications/classes/class.ilNotificationOSDHandler.php';

        $notifications = ilNotificationOSDHandler::getNotificationsForUser(
            $this->user->getId(),
            true,
            (int) $_REQUEST['max_age']
        );

        $result = new stdClass();
        $result->notifications = $notifications;
        $result->server_time = time();
        echo json_encode($result);
        exit;
    }

Here is the call graph for this function:

removeOSDNotificationsObject()

ilNotificationGUI::removeOSDNotificationsObject

(

)

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

References ilSession\enableWebAccessWithoutSession(), exit, and ilNotificationOSDHandler\removeNotification().

    {
        ilSession::enableWebAccessWithoutSession(true);

        require_once 'Services/Notifications/classes/class.ilNotificationEchoHandler.php';
        require_once 'Services/Notifications/classes/class.ilNotificationOSDHandler.php';

        ilNotificationOSDHandler::removeNotification($_REQUEST['notification_id']);

        exit;
    }

Here is the call graph for this function:

saveCustomizingOptionObject()

ilNotificationGUI::saveCustomizingOptionObject ( )

private

Definition at line 168 of file class.ilNotificationGUI.php.

References $_POST, showSettingsObject(), and user().

    {
        if ($_POST['enable_custom_notification_configuration']) {
            $this->user->writePref('use_custom_notification_setting', 1);
        } else {
            $this->user->writePref('use_custom_notification_setting', 0);
        }

        $this->showSettingsObject();
    }

Here is the call graph for this function:

saveSettingsObject()

ilNotificationGUI::saveSettingsObject ( )

private

Definition at line 227 of file class.ilNotificationGUI.php.

References ilNotificationDatabaseHandler\setUserConfig(), showSettingsObject(), and user().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';

        ilNotificationDatabaseHandler::setUserConfig(
            $this->user->getId(),
            $_REQUEST['notification'] ? $_REQUEST['notification'] : array()
        );

        $this->showSettingsObject();
    }

Here is the call graph for this function:

showSettingsObject()

ilNotificationGUI::showSettingsObject

(

)

Definition at line 179 of file class.ilNotificationGUI.php.

References $form, $table, getAvailableChannels(), getAvailableTypes(), ilNotificationDatabaseHandler\loadUserConfig(), ilCheckboxInputGUI\setValue(), and user().

Referenced by saveCustomizingOptionObject(), and saveSettingsObject().

    {
        require_once 'Services/Notifications/classes/class.ilNotificationSettingsTable.php';
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';

        $userTypes = ilNotificationDatabaseHandler::loadUserConfig($this->user->getId());

        $this->language->loadLanguageModule('notification');

        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $chk = new ilCheckboxInputGUI($this->language->txt('enable_custom_notification_configuration'), 'enable_custom_notification_configuration');
        $chk->setValue('1');
        $chk->setChecked($this->user->getPref('use_custom_notification_setting') == 1);
        $form->addItem($chk);

        $form->setFormAction($this->controller->getFormAction($this, 'showSettingsObject'));
        $form->addCommandButton('saveCustomizingOption', $this->language->txt('save'));
        $form->addCommandButton('showSettings', $this->language->txt('cancel'));

        $table = new ilNotificationSettingsTable($this, 'a title', $this->getAvailableChannels(array('set_by_user')), $userTypes);

        $table->setFormAction($this->controller->getFormAction($this, 'saveSettings'));
        $table->setData($this->getAvailableTypes(array('set_by_user')));

        if ($this->user->getPref('use_custom_notification_setting') == 1) {
            $table->addCommandButton('saveSettings', $this->language->txt('save'));
            $table->addCommandButton('showSettings', $this->language->txt('cancel'));
            $table->setEditable(true);
        } else {
            $table->setEditable(false);
        }

        $this->template->setContent($form->getHtml() . $table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$controller

ilNotificationGUI::$controller

private

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

Referenced by __construct().

$handler

ilNotificationGUI::$handler = array()

private

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

Referenced by addHandler().

$language

ilNotificationGUI::$language

private

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

Referenced by __construct().

$locatorGUI

ilNotificationGUI::$locatorGUI

private

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

Referenced by __construct().

$template

ilNotificationGUI::$template

private

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

Referenced by __construct().

$user

ilNotificationGUI::$user

private

Definition at line 20 of file class.ilNotificationGUI.php.

Referenced by __construct().

---

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

• Services/Notifications/classes/class.ilNotificationGUI.php