ilBuddySystemNotification Class Reference

Class ilBuddyList. More...

Collaboration diagram for ilBuddySystemNotification:

Public Member Functions
	__construct (protected ilObjUser $sender, protected ilSetting $settings)
	getRecipientIds ()
	setRecipientIds (array $recipientIds)
	send ()

Data Fields
const	CONTACT_REQUEST_KEY = 'contact_requested_by'

Protected Member Functions
	hasPublicProfile (int $recipientUsrId)

Protected Attributes
array	$recipientIds = []

Detailed Description

Class ilBuddyList.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 31 of file class.ilBuddySystemNotification.php.

Constructor & Destructor Documentation

__construct()

ilBuddySystemNotification::__construct	(	protected ilObjUser	$sender,
		protected ilSetting	$settings
	)

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

    {
    }

Member Function Documentation

getRecipientIds()

ilBuddySystemNotification::getRecipientIds

(

)

Returns

int[]

Definition at line 44 of file class.ilBuddySystemNotification.php.

References $recipientIds.

Referenced by send().

                                     : array
    {
        return $this->recipientIds;
    }

Here is the caller graph for this function:

hasPublicProfile()

ilBuddySystemNotification::hasPublicProfile ( int  $recipientUsrId )

protected

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

References ilObjPortfolio\getDefaultPortfolio().

Referenced by send().

                                                            : bool
    {
        $portfolioId = ilObjPortfolio::getDefaultPortfolio($this->sender->getId());
        if (is_numeric($portfolioId) && $portfolioId > 0) {
            return (new ilPortfolioAccessHandler())->checkAccessOfUser($recipientUsrId, 'read', '', $portfolioId);
        }

        return (
            $this->sender->getPref('public_profile') === 'y' ||
            $this->sender->getPref('public_profile') === 'g'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilBuddySystemNotification::send

(

)

Definition at line 57 of file class.ilBuddySystemNotification.php.

References ilLanguageFactory\_getLanguage(), ilLink\_getStaticLink(), ANONYMOUS_USER_ID, ilUserUtil\getNamePresentation(), getRecipientIds(), ilMail\getSalutation(), and hasPublicProfile().

                          : void
    {
        foreach ($this->getRecipientIds() as $usr_id) {
            $user = new ilObjUser($usr_id);

            $recipientLanguage = ilLanguageFactory::_getLanguage($user->getLanguage());
            $recipientLanguage->loadLanguageModule('buddysystem');

            $notification = new ilNotificationConfig(ContactNotificationProvider::NOTIFICATION_TYPE);

            $personalProfileLink = $recipientLanguage->txt('buddy_noti_cr_profile_not_published');
            if ($this->hasPublicProfile($this->sender->getId())) {
                $personalProfileLink = ilLink::_getStaticLink($this->sender->getId(), 'usr', true);

                $links[] = new ilNotificationLink(
                    new ilNotificationParameter(
                        $this->sender->getFirstname() . ', ' .
                        $this->sender->getLastname() . ' ' .
                        $this->sender->getLogin()
                    ),
                    $personalProfileLink
                );
            }
            $links[] = new ilNotificationLink(
                new ilNotificationParameter('buddy_notification_contact_request_link_osd', [], 'buddysystem'),
                ilLink::_getStaticLink(
                    $this->sender->getId(),
                    'usr',
                    true,
                    '_contact_approved'
                )
            );
            $links[] = new ilNotificationLink(
                new ilNotificationParameter('buddy_notification_contact_request_ignore_osd', [], 'buddysystem'),
                ilLink::_getStaticLink(
                    $this->sender->getId(),
                    'usr',
                    true,
                    '_contact_ignored'
                )
            );

            $bodyParams = [
                'SALUTATION' => ilMail::getSalutation($user->getId(), $recipientLanguage),
                'BR' => "\n",
                'APPROVE_REQUEST' => ilLink::_getStaticLink($this->sender->getId(), 'usr', true, '_contact_approved'),
                'APPROVE_REQUEST_TXT' => $recipientLanguage->txt('buddy_notification_contact_request_link'),
                'IGNORE_REQUEST' => ilLink::_getStaticLink($this->sender->getId(), 'usr', true, '_contact_ignored'),
                'IGNORE_REQUEST_TXT' => $recipientLanguage->txt('buddy_notification_contact_request_ignore'),
                'REQUESTING_USER' => ilUserUtil::getNamePresentation($this->sender->getId()),
                'PERSONAL_PROFILE_LINK' => $personalProfileLink,
            ];
            $notification->setTitleVar('buddy_notification_contact_request', [], 'buddysystem');
            $notification->setShortDescriptionVar('buddy_notification_contact_request_short', $bodyParams, 'buddysystem');
            $notification->setLongDescriptionVar('buddy_notification_contact_request_long', $bodyParams, 'buddysystem');
            $notification->setLinks($links);
            $notification->setValidForSeconds(ilNotificationConfig::TTL_LONG);
            $notification->setVisibleForSeconds(ilNotificationConfig::DEFAULT_TTS);
            $notification->setIconPath('assets/images/standard/icon_usr.svg');
            $notification->setHandlerParam('mail.sender', (string) ANONYMOUS_USER_ID);
            $notification->setIdentification(new NotificationIdentification(
                ContactNotificationProvider::NOTIFICATION_TYPE,
                self::CONTACT_REQUEST_KEY . '_' . $this->sender->getId(),
            ));

            $notification->notifyByUsers([$user->getId()]);
        }
    }

Here is the call graph for this function:

setRecipientIds()

ilBuddySystemNotification::setRecipientIds

(

array

$recipientIds

)

Parameters

int[]

$recipientIds

Definition at line 52 of file class.ilBuddySystemNotification.php.

Referenced by ilContactAppEventListener\handleEvent().

                                                        : void
    {
        $this->recipientIds = array_map('intval', $recipientIds);
    }

Here is the caller graph for this function:

Field Documentation

$recipientIds

array ilBuddySystemNotification::$recipientIds = []

protected

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

Referenced by getRecipientIds().

CONTACT_REQUEST_KEY

const ilBuddySystemNotification::CONTACT_REQUEST_KEY = 'contact_requested_by'

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

---

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

• components/ILIAS/Contact/BuddySystem/classes/class.ilBuddySystemNotification.php