ilBuddySystemNotification Class Reference

Class ilBuddyList. More...

Collaboration diagram for ilBuddySystemNotification:

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

Protected Member Functions
	hasPublicProfile (int $recipientUsrId)

Protected Attributes
	$sender
	$settings
	$recipientIds = []

Detailed Description

Class ilBuddyList.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBuddySystemNotification::__construct	(	ilObjUser	$user,
		ilSetting	$settings
	)

Parameters

ilObjUser	$user
ilSetting	$settings

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

    {
        $this->sender = $user;
        $this->settings = $settings;
    }

References $settings, and settings().

Here is the call graph for this function:

Member Function Documentation

getRecipientIds()

ilBuddySystemNotification::getRecipientIds

(

)

Returns

int[]

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

                                      : array
    {
        return $this->recipientIds;
    }

References $recipientIds.

Referenced by send().

Here is the caller graph for this function:

hasPublicProfile()

ilBuddySystemNotification::hasPublicProfile ( int  $recipientUsrId )

protected

Parameters

int

$recipientUsrId

Returns

bool

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

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

References ilObjPortfolio\getDefaultPortfolio().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilBuddySystemNotification::send

(

)

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

                           : void
    {
        foreach ($this->getRecipientIds() as $usr_id) {
            $user = new ilObjUser((int) $usr_id);
 
            $recipientLanguage = ilLanguageFactory::_getLanguage($user->getLanguage());
            $recipientLanguage->loadLanguageModule('buddysystem');
 
            $notification = new ilNotificationConfig('buddysystem_request');
            $notification->setTitleVar('buddy_notification_contact_request', [], 'buddysystem');
 
            $personalProfileLink = $recipientLanguage->txt('buddy_noti_cr_profile_not_published');
            if ($this->hasPublicProfile((int) $user->getId())) {
                $personalProfileLink = ilLink::_getStaticLink($this->sender->getId(), 'usr', true);
            }
 
            $bodyParams = [
                'SALUTATION' => ilMail::getSalutation($user->getId(), $recipientLanguage),
                'BR' => nl2br("\n"),
                'APPROVE_REQUEST' => '<a href="' . ilLink::_getStaticLink(
                    $this->sender->getId(),
                    'usr',
                    true,
                    '_contact_approved'
                ) . '">' . $recipientLanguage->txt('buddy_notification_contact_request_link_osd') . '</a>',
                'IGNORE_REQUEST' => '<a href="' . ilLink::_getStaticLink(
                    $this->sender->getId(),
                    'usr',
                    true,
                    '_contact_ignored'
                ) . '">' . $recipientLanguage->txt('buddy_notification_contact_request_ignore_osd') . '</a>',
                'REQUESTING_USER' => ilUserUtil::getNamePresentation($this->sender->getId())
            ];
            $notification->setShortDescriptionVar(
                'buddy_notification_contact_request_short',
                $bodyParams,
                'buddysystem'
            );
 
            $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->setLongDescriptionVar('buddy_notification_contact_request_long', $bodyParams, 'buddysystem');
 
            $notification->setAutoDisable(false);
            $notification->setValidForSeconds(ilNotificationConfig::TTL_LONG);
            $notification->setVisibleForSeconds(ilNotificationConfig::DEFAULT_TTS);
            $notification->setIconPath('templates/default/images/icon_usr.svg');
            $notification->setHandlerParam('mail.sender', ANONYMOUS_USER_ID);
            $notification->notifyByUsers([$user->getId()]);
        }
    }

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

Here is the call graph for this function:

setRecipientIds()

ilBuddySystemNotification::setRecipientIds

(

array

$recipientIds

)

Parameters

int[]

$recipientIds

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

    {
        $this->recipientIds = $recipientIds;
    }

References $recipientIds.

Field Documentation

$recipientIds

ilBuddySystemNotification::$recipientIds = []

protected

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

Referenced by getRecipientIds(), and setRecipientIds().

$sender

ilBuddySystemNotification::$sender

protected

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

$settings

ilBuddySystemNotification::$settings

protected

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

Referenced by __construct().

---

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

• Services/Contact/BuddySystem/classes/class.ilBuddySystemNotification.php