Collaboration diagram for ILIAS\Notes\NotificationsManager:

Public Member Functions
	__construct (InternalDataService $data, InternalRepoService $repo, InternalDomainService $domain, \ILIAS\Blog\InternalGUIService $blog_gui)

	sendNotifications (Note $note, bool $a_changed=false)
	Sends all comments to a list of accounts configured in the global administration. More...

	notifyObserver (array $observer, string $action, Note $note)
	Notify observers on update/create. More...

Protected Attributes
ilAccessHandler	$access

ilSetting	$settings

InternalDomainService	$domain

InternalRepoService	$repo

InternalDataService	$data

ILIAS Blog InternalGUIService	$blog_gui

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notes\NotificationsManager::__construct	(	InternalDataService	$data,
		InternalRepoService	$repo,
		InternalDomainService	$domain,
		\ILIAS\Blog\InternalGUIService	$blog_gui
	)

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

      {
        $this->data = $data;
        $this->repo = $repo;
        $this->domain = $domain;
        $this->settings = $domain->settings();
        $this->access = $domain->access();
        $this->blog_gui = $blog_gui;
    }

References ILIAS\Notes\NotificationsManager\$blog_gui, ILIAS\Notes\NotificationsManager\$data, ILIAS\Notes\NotificationsManager\$domain, ILIAS\Notes\NotificationsManager\$repo, ILIAS\Repository\access(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ notifyObserver()

ILIAS\Notes\NotificationsManager::notifyObserver	(	array	$observer,
		string	$action,
		Note	$note
	)

Notify observers on update/create.

Definition at line 197 of file class.NotificationsManager.php.

     : void {
        foreach ($observer as $item) {
            $context = $note->getContext();
            $param[] = $context->getObjId();
            $param[] = $context->getSubObjId();
            $param[] = $context->getType();
            $param[] = $action;
            $param[] = $note->getId();
            call_user_func_array($item, $param);
        }
    }

References $param, ILIAS\Notes\Note\getContext(), and ILIAS\Notes\Note\getId().

Here is the call graph for this function:

◆ sendNotifications()

ILIAS\Notes\NotificationsManager::sendNotifications	(	Note	$note,
		bool	$a_changed = `false`
	)

Sends all comments to a list of accounts configured in the global administration.

Todo:: : get rid of object type specific code

Definition at line 56 of file class.NotificationsManager.php.

     : void {
        $settings = $this->settings;
        $access = $this->access;
 
        $obj_title = "";
        $type_lv = "";
 
        // no notifications for notes
        if ($note->getType() === Note::PRIVATE) {
            return;
        }
 
        $recipients = $settings->get("comments_noti_recip", '');
        $recipients = explode(",", $recipients);
 
        // blog: blog_id, 0, "blog"
        // lm: lm_id, page_id, "pg" (ok)
        // sahs: sahs_id, node_id, node_type
        // info_screen: obj_id, 0, obj_type (ok)
        // portfolio: port_id, page_id, "portfolio_page" (ok)
        // wiki: wiki_id, wiki_page_id, "wpg" (ok)
 
        $context = $note->getContext();
        $rep_obj_id = $context->getObjId();
        $sub_obj_id = $context->getSubObjId();
        $obj_type = $context->getType();
 
        // resolve repository references for object-specific notifications
        $ref_ids = array();
        $wsp_id = 0;
        if (
            ($obj_type === "blp" && $context->getInRepository())
            || ($sub_obj_id === 0 && $obj_type !== "blp")
            || in_array($obj_type, array("pg", "wpg"), true)
        ) {
            $obj_title = \ilObject::_lookupTitle($rep_obj_id);
            $type_lv = "obj_" . $obj_type;
            $ref_ids = \ilObject::_getAllReferences($rep_obj_id);
        }
        if ($obj_type === "blp" && !$context->getInRepository()) {
            $wsp_id = (new \ilWorkspaceTree(0))->lookupNodeId($rep_obj_id);
        }
        $wsp_tree = $wsp_id > 0 ? new \ilWorkspaceTree(0) : null;
        $wsp_access = $wsp_tree === null ? null : new \ilWorkspaceAccessHandler($wsp_tree);
 
        if ($obj_type === "wpg") {
            $type_lv = "obj_wiki";
        }
        if ($obj_type === "pg") {
            $type_lv = "obj_lm";
        }
        if ($obj_type === "blp") {
            $obj_title = \ilObject::_lookupTitle($rep_obj_id);
            $type_lv = "obj_blog";
        }
        if ($obj_type === "pfpg") {
            $obj_title = \ilObject::_lookupTitle($rep_obj_id);
            $type_lv = "portfolio";
        }
        if ($obj_type === "dcl") {
            $obj_title = \ilObject::_lookupTitle($rep_obj_id);
            $type_lv = "obj_dcl";
        }
 
        foreach ($recipients as $r) {
            $login = trim($r);
            if (($user_id = \ilObjUser::_lookupId($login)) > 0) {
                $link = "";
                if ($wsp_id > 0 && $wsp_tree !== null && $wsp_access !== null) {
                    if ($wsp_access->checkAccessOfUser($wsp_tree, $user_id, "read", "", $wsp_id)) {
                        $link = $this->blog_gui
                            ->permanentLink(0, $wsp_id)
                            ->getPermanentLink($sub_obj_id);
                    }
                }
                foreach ($ref_ids as $ref_id) {
                    if ($access->checkAccessOfUser($user_id, "read", "", $ref_id)) {
                        if ($sub_obj_id === 0 && $obj_type !== "blog") {
                            $link = \ilLink::_getLink($ref_id);
                        } elseif ($obj_type === "wpg") {
                            $title = \ilWikiPage::lookupTitle($sub_obj_id);
                            $link = \ilLink::_getStaticLink(
                                $ref_id,
                                "wiki",
                                true,
                                "_" . \ilWikiUtil::makeUrlTitle($title)
                            );
                        } elseif ($obj_type === "pg") {
                            $link = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . "&target=pg_" . $sub_obj_id . "_" . $ref_id;
                        } elseif ($obj_type === "blp") {
                            $link = $this->blog_gui
                                ->permanentLink($ref_id)
                                ->getPermanentLink($sub_obj_id);
                        }
                    }
                }
                if ($obj_type === "pfpg") {
                    $link = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . "&target=prtf_" . $rep_obj_id;
                }
 
                // use language of recipient to compose message
                $ulng = \ilLanguageFactory::_getLanguageOfUser($user_id);
                $ulng->loadLanguageModule('note');
 
                if ($a_changed) {
                    $subject = sprintf($ulng->txt('note_comment_notification_subjectc'), $obj_title . " (" . $ulng->txt($type_lv) . ")");
                } else {
                    $subject = sprintf($ulng->txt('note_comment_notification_subject'), $obj_title . " (" . $ulng->txt($type_lv) . ")");
                }
                $message = sprintf($ulng->txt('note_comment_notification_salutation'), \ilObjUser::_lookupFullname($user_id)) . "\n\n";
 
                $message .= sprintf($ulng->txt('note_comment_notification_user_has_written'), \ilUserUtil::getNamePresentation($note->getAuthor())) . "\n\n";
 
                $message .= $note->getText() . "\n\n";
 
                if ($link !== "") {
                    $message .= $ulng->txt('note_comment_notification_link') . ": " . $link . "\n\n";
                }
 
                $message .= $ulng->txt('note_comment_notification_reason') . "\n\n";
 
                $mail_obj = new \ilMail(ANONYMOUS_USER_ID);
                $mail_obj->appendInstallationSignature(true);
                $mail_obj->enqueue(
                    \ilObjUser::_lookupLogin($user_id),
                    "",
                    "",
                    $subject,
                    $message,
                    MailAttachments::empty()
                );
            }
        }
    }