ilNotificationGUI Class Reference

Collaboration diagram for ilNotificationGUI:

Public Member Functions
	__construct ()
	Constructor 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()

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

(

)

Constructor public.

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

    {
        $this->type = "not";

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

Member Function Documentation

_forwards()

static ilNotificationGUI::_forwards ( )

static

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

References array.

    {
        return array();
    }

addHandler()

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

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

References $handler, and array.

    {
        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 173 of file class.ilNotificationGUI.php.

References $_GET, $ilCtrl, and object.

    {
        global $ilLocator, $ilCtrl;

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

executeCommand()

ilNotificationGUI::executeCommand

(

)

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

References $ilCtrl.

    {
        global $ilCtrl;

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

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

getAvailableChannels()

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

private

Definition at line 57 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 52 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 47 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 69 of file class.ilNotificationGUI.php.

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

    {
        global $ilUser;

        ilSession::enableWebAccessWithoutSession(true);

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

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

        $notifications         = ilNotificationOSDHandler::getNotificationsForUser($ilUser->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 90 of file class.ilNotificationGUI.php.

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

    {
        global $ilUser;

        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 113 of file class.ilNotificationGUI.php.

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

    {
        global $ilUser;

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

        $this->showSettingsObject();
    }

Here is the call graph for this function:

saveSettingsObject()

ilNotificationGUI::saveSettingsObject ( )

private

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

References $ilCtrl, $ilUser, array, ilNotificationDatabaseHandler\setUserConfig(), and showSettingsObject().

    {
        global $ilUser, $ilCtrl;
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';

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

Here is the call graph for this function:

showSettingsObject()

ilNotificationGUI::showSettingsObject

(

)

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

References $form, $ilCtrl, $ilUser, $lng, $table, $tpl, array, getAvailableChannels(), getAvailableTypes(), ilNotificationDatabaseHandler\loadUserConfig(), and ilCheckboxInputGUI\setValue().

Referenced by saveCustomizingOptionObject(), and saveSettingsObject().

    {
        global $tpl, $ilCtrl, $ilUser, $lng;

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

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

        $lng->loadLanguageModule('notification');

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

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$handler

ilNotificationGUI::$handler = array()

private

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

Referenced by addHandler().

---

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

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