class.ilNotificationGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once './Services/Object/classes/class.ilObjectGUI.php';
require_once 'Services/Notifications/classes/class.ilNotificationConfig.php';
require_once 'Services/Notifications/classes/class.ilNotificationHandler.php';

class ilNotificationGUI
{
    private $handler = array();

    private $user;

    private $template;

    private $controller;

    private $language;

    private $locatorGUI;

    public function __construct(
        \ilUser $user = null,
        \ilTemplate $template = null,
        \ilCtrl $controller = null,
        \ilLanguage $language = null,
        \ilLocatorGUI $locatorGUI = null,
        \ILIAS\DI\Container $dic = null
    ) {
        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';
    }

    public static function _forwards()
    {
        return array();
    }

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

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

    public function getHandler($type)
    {
        return $this->handler[$type];
    }

    private function getAvailableTypes($types = array())
    {
        return ilNotificationDatabaseHandler::getAvailableTypes($types);
    }

    private function getAvailableChannels($types = array())
    {
        return ilNotificationDatabaseHandler::getAvailableChannels($types);
    }

    public function getOSDNotificationsObject()
    {
        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;
    }

    public function removeOSDNotificationsObject()
    {
        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;
    }

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

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

    private function saveCustomizingOptionObject()
    {
        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();
    }

    public function showSettingsObject()
    {
        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());
    }

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

    private function saveSettingsObject()
    {
        require_once 'Services/Notifications/classes/class.ilNotificationDatabaseHelper.php';

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

        $this->showSettingsObject();
    }
}