Class ilForumCronNotificationDataProvider. More...

Inheritance diagram for ilForumCronNotificationDataProvider:

Collaboration diagram for ilForumCronNotificationDataProvider:

Public Member Functions
	__construct (array $row, private readonly int $notification_type, ?ilForumNotificationCache $notificationCache=null)

	addRecipient (int $user_id)

	getCronRecipients ()

	getRefId ()

	getObjId ()

	getForumId ()

	closestContainer ()

	providesClosestContainer ()

	getForumTitle ()

	getThreadId ()

	getThreadTitle ()

	getPostId ()

	getPostTitle ()

	getPostMessage ()

	getPostDate ()

	getPostUpdate ()

	isPostCensored ()

	getPostCensoredDate ()

	getCensorshipComment ()

	getAttachments ()

	getPosDisplayUserId ()

	getPosUserAlias ()

	getPostUpdateUserId ()

	getPosAuthorId ()

	isAnonymized ()

	getDeletedBy ()

	getImportName ()

	getPostUserName (ilLanguage $user_lang)

	getPostUpdateUserName (ilLanguage $user_lang)

	getPublicUserInformation (ilForumAuthorInformation $authorinfo)

	getRefId ()

	getObjId ()

	getForumId ()

	closestContainer ()

	providesClosestContainer ()

	getForumTitle ()

	getThreadId ()

	getThreadTitle ()

	getPostId ()

	getPostTitle ()

	getPostMessage ()

	getPosAuthorId ()

	getPostUpdateUserId ()

	getPosDisplayUserId ()

	getPosUserAlias ()

	getPostUserName (ilLanguage $user_lang)

	getPostDate ()

	getPostUpdate ()

	getPostUpdateUserName (ilLanguage $user_lang)

	isPostCensored ()

	getPostCensoredDate ()

	getCensorshipComment ()

	getAttachments ()

	getDeletedBy ()

Protected Member Functions
	read ()

Private Member Functions
	readAttachments ()

	getAuthorInformation (ilLanguage $lng, int $authorUsrId, int $displayUserId, string $usrAlias, string $importName)

Private Attributes
readonly int	$ref_id

readonly int	$obj_id

readonly int	$forum_id

readonly string	$forum_title

ilObject	$closest_container = null

readonly int	$thread_id

readonly string	$thread_title

readonly int	$post_id

readonly string	$post_title

readonly string	$post_message

string	$post_date = null

string	$post_update = null

readonly bool	$post_censored

string	$post_censored_date = null

readonly string	$post_censored_comment

readonly string	$pos_usr_alias

readonly int	$pos_display_user_id

bool	$is_anonymized = false

readonly string	$import_name

array	$attachments = []

array	$cron_recipients = []

readonly int	$post_update_user_id

readonly int	$pos_author_id

string	$deleted_by = ''

string	$post_user_name = null

string	$update_user_name = null

readonly ilForumNotificationCache	$notificationCache

Detailed Description

Class ilForumCronNotificationDataProvider.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 25 of file class.ilForumCronNotificationDataProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumCronNotificationDataProvider::__construct	(	array	$row,
		private readonly int	$notification_type,
		?ilForumNotificationCache	$notificationCache = `null`
	)

Definition at line 58 of file class.ilForumCronNotificationDataProvider.php.

      {
        $this->closest_container = $row['closest_container'];
        $this->obj_id = (int) $row['obj_id'];
        $this->ref_id = (int) ($row['ref_id'] ?? 0);
        $this->thread_id = (int) ($row['thread_id'] ?? 0);
        $this->thread_title = $row['thr_subject'];
        $this->forum_id = (int) ($row['pos_top_fk'] ?? 0);
        $this->forum_title = $row['top_name'];
        $this->post_id = (int) ($row['pos_pk'] ?? 0);
        $this->post_title = $row['pos_subject'];
        $this->post_message = $row['pos_message'];
        $this->post_date = $row['pos_date'];
        $this->post_update = $row['pos_update'] ?? null;
        $this->post_update_user_id = (int) ($row['update_user'] ?? 0);
        $this->post_censored = (bool) ($row['pos_cens'] ?? false);
        $this->post_censored_date = $row['pos_cens_date'] ?? null;
        $this->post_censored_comment = $row['pos_cens_com'] ?? null;
        $this->pos_usr_alias = $row['pos_usr_alias'] ?? '';
        $this->pos_display_user_id = (int) ($row['pos_display_user_id'] ?? 0);
        $this->pos_author_id = (int) ($row['pos_author_id'] ?? 0);
        $this->import_name = $row['import_name'] ?? '';
 
        if ($notificationCache === null) {
            $notificationCache = new ilForumNotificationCache();
        }
        $this->notificationCache = $notificationCache;
 
        if (isset($row['deleted_by'])) {
            //cron context
            $this->deleted_by = $row['deleted_by'];
        } else {
            //  fallback
            global $DIC;
            $this->deleted_by = $DIC->user()->getLogin();
        }
 
        $this->read();
    }

References $DIC, $notificationCache, ILIAS\Repository\int(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ addRecipient()

ilForumCronNotificationDataProvider::addRecipient ( int $user_id )

Definition at line 118 of file class.ilForumCronNotificationDataProvider.php.

                                              : void
    {
        $this->cron_recipients[] = $user_id;
    }

References $user_id.

◆ closestContainer()

ilForumCronNotificationDataProvider::closestContainer ( )

Returns: ilObjCourse|ilObjGroup|null

Implements ilForumNotificationMailData.

Definition at line 146 of file class.ilForumCronNotificationDataProvider.php.

                                      : ?ilObject
    {
        return $this->closest_container;
    }

References $closest_container.

◆ getAttachments()

ilForumCronNotificationDataProvider::getAttachments ( )

Returns: list<string>

Implements ilForumNotificationMailData.

Definition at line 214 of file class.ilForumCronNotificationDataProvider.php.

                                    : array
    {
        return $this->attachments;
    }

References $attachments.

◆ getAuthorInformation()

ilForumCronNotificationDataProvider::getAuthorInformation	(	ilLanguage	$lng,
		int	$authorUsrId,
		int	$displayUserId,
		string	$usrAlias,
		string	$importName
	)

private

Definition at line 305 of file class.ilForumCronNotificationDataProvider.php.

     : ilForumAuthorInformation {
        $cacheKey = $this->notificationCache->createKeyByValues([
            $this->notification_type,
            $lng->getLangKey(),
            $authorUsrId,
            $displayUserId,
            $usrAlias,
            $importName
        ]);
 
        if (!$this->notificationCache->exists($cacheKey)) {
            $authorInformation = new ilForumAuthorInformation(
                $authorUsrId,
                $displayUserId,
                $usrAlias,
                $importName,
                [],
                $lng
            );
 
            $this->notificationCache->store($cacheKey, $authorInformation);
        }
 
        return $this->notificationCache->fetch($cacheKey);
    }

References $lng.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

◆ getCensorshipComment()

ilForumCronNotificationDataProvider::getCensorshipComment ( )

Implements ilForumNotificationMailData.

Definition at line 206 of file class.ilForumCronNotificationDataProvider.php.

                                          : string
    {
        return $this->post_censored_comment;
    }

References $post_censored_comment.

◆ getCronRecipients()

ilForumCronNotificationDataProvider::getCronRecipients ( )

Returns: int[]

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

                                       : array
    {
        return $this->cron_recipients;
    }

References $cron_recipients.

◆ getDeletedBy()

ilForumCronNotificationDataProvider::getDeletedBy ( )

Implements ilForumNotificationMailData.

Definition at line 244 of file class.ilForumCronNotificationDataProvider.php.

                                  : string
    {
        return $this->deleted_by;
    }

References $deleted_by.

◆ getForumId()

ilForumCronNotificationDataProvider::getForumId ( )

Implements ilForumNotificationMailData.

Definition at line 141 of file class.ilForumCronNotificationDataProvider.php.

                                : int
    {
        return $this->forum_id;
    }

References $forum_id.

◆ getForumTitle()

ilForumCronNotificationDataProvider::getForumTitle ( )

Implements ilForumNotificationMailData.

Definition at line 156 of file class.ilForumCronNotificationDataProvider.php.

                                   : string
    {
        return $this->forum_title;
    }

References $forum_title.

◆ getImportName()

ilForumCronNotificationDataProvider::getImportName ( )

Definition at line 249 of file class.ilForumCronNotificationDataProvider.php.

                                   : string
    {
        return $this->import_name;
    }

References $import_name.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

◆ getObjId()

ilForumCronNotificationDataProvider::getObjId ( )

Implements ilForumNotificationMailData.

Definition at line 136 of file class.ilForumCronNotificationDataProvider.php.

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by readAttachments().

Here is the caller graph for this function:

◆ getPosAuthorId()

ilForumCronNotificationDataProvider::getPosAuthorId ( )

Implements ilForumNotificationMailData.

Definition at line 234 of file class.ilForumCronNotificationDataProvider.php.

                                    : int
    {
        return $this->pos_author_id;
    }

References $pos_author_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

◆ getPosDisplayUserId()

ilForumCronNotificationDataProvider::getPosDisplayUserId ( )

Implements ilForumNotificationMailData.

Definition at line 219 of file class.ilForumCronNotificationDataProvider.php.

                                         : int
    {
        return $this->pos_display_user_id;
    }

References $pos_display_user_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

◆ getPostCensoredDate()

ilForumCronNotificationDataProvider::getPostCensoredDate ( )

Implements ilForumNotificationMailData.

Definition at line 201 of file class.ilForumCronNotificationDataProvider.php.

                                         : string
    {
        return $this->post_censored_date ?? '';
    }

◆ getPostDate()

ilForumCronNotificationDataProvider::getPostDate ( )

Implements ilForumNotificationMailData.

Definition at line 186 of file class.ilForumCronNotificationDataProvider.php.

                                 : string
    {
        return $this->post_date;
    }

References $post_date.

◆ getPostId()

ilForumCronNotificationDataProvider::getPostId ( )

Implements ilForumNotificationMailData.

Definition at line 171 of file class.ilForumCronNotificationDataProvider.php.

                               : int
    {
        return $this->post_id;
    }

References $post_id.

Referenced by readAttachments().

Here is the caller graph for this function:

◆ getPostMessage()

ilForumCronNotificationDataProvider::getPostMessage ( )

Implements ilForumNotificationMailData.

Definition at line 181 of file class.ilForumCronNotificationDataProvider.php.

                                    : string
    {
        return $this->post_message;
    }

References $post_message.

◆ getPostTitle()

ilForumCronNotificationDataProvider::getPostTitle ( )

Implements ilForumNotificationMailData.

Definition at line 176 of file class.ilForumCronNotificationDataProvider.php.

                                  : string
    {
        return $this->post_title;
    }

References $post_title.

◆ getPostUpdate()

ilForumCronNotificationDataProvider::getPostUpdate ( )

Implements ilForumNotificationMailData.

Definition at line 191 of file class.ilForumCronNotificationDataProvider.php.

                                   : string
    {
        return $this->post_update ?? '';
    }

◆ getPostUpdateUserId()

ilForumCronNotificationDataProvider::getPostUpdateUserId ( )

Implements ilForumNotificationMailData.

Definition at line 229 of file class.ilForumCronNotificationDataProvider.php.

                                         : int
    {
        return $this->post_update_user_id;
    }

References $post_update_user_id.

Referenced by getPostUpdateUserName().

Here is the caller graph for this function:

◆ getPostUpdateUserName()

ilForumCronNotificationDataProvider::getPostUpdateUserName ( ilLanguage $user_lang )

Implements ilForumNotificationMailData.

Definition at line 269 of file class.ilForumCronNotificationDataProvider.php.

                                                                : string
    {
        if ($this->update_user_name === null) {
            $this->update_user_name = $this->getPublicUserInformation($this->getAuthorInformation(
                $user_lang,
                $this->getPosAuthorId(),
                $this->getPostUpdateUserId(),
                $this->getPosUserAlias(),
                $this->getImportName()
            ));
        }
 
        // Fix for #25432
        if (
            $this->getPosUserAlias() && $this->getPosDisplayUserId() === 0 &&
            $this->getPosAuthorId() === $this->getPostUpdateUserId()
        ) {
            return $this->getPosUserAlias();
        }
 
        return $this->update_user_name;
    }

References $update_user_name, getAuthorInformation(), getImportName(), getPosAuthorId(), getPosDisplayUserId(), getPostUpdateUserId(), getPosUserAlias(), and getPublicUserInformation().

Here is the call graph for this function:

◆ getPostUserName()

ilForumCronNotificationDataProvider::getPostUserName ( ilLanguage $user_lang )

Implements ilForumNotificationMailData.

Definition at line 254 of file class.ilForumCronNotificationDataProvider.php.

                                                          : string
    {
        if ($this->post_user_name === null) {
            $this->post_user_name = $this->getPublicUserInformation($this->getAuthorInformation(
                $user_lang,
                $this->getPosAuthorId(),
                $this->getPosDisplayUserId(),
                $this->getPosUserAlias(),
                $this->getImportName()
            ));
        }
 
        return $this->post_user_name;
    }

References $post_user_name, getAuthorInformation(), getImportName(), getPosAuthorId(), getPosDisplayUserId(), getPosUserAlias(), and getPublicUserInformation().

Here is the call graph for this function:

◆ getPosUserAlias()

ilForumCronNotificationDataProvider::getPosUserAlias ( )

Implements ilForumNotificationMailData.

Definition at line 224 of file class.ilForumCronNotificationDataProvider.php.

                                     : string
    {
        return $this->pos_usr_alias;
    }

References $pos_usr_alias.

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the caller graph for this function:

◆ getPublicUserInformation()

ilForumCronNotificationDataProvider::getPublicUserInformation ( ilForumAuthorInformation $authorinfo )

Definition at line 292 of file class.ilForumCronNotificationDataProvider.php.

                                                                                  : string
    {
        $publicName = $authorinfo->getAuthorShortName();
 
        if ($authorinfo->hasSuffix()) {
            $publicName = $authorinfo->getAuthorName();
        } elseif ($authorinfo->getAuthorName() && !$this->isAnonymized()) {
            $publicName = $authorinfo->getAuthorName();
        }
 
        return $publicName;
    }

References ilForumAuthorInformation\getAuthorName(), ilForumAuthorInformation\getAuthorShortName(), and ilForumAuthorInformation\hasSuffix().

Referenced by getPostUpdateUserName(), and getPostUserName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilForumCronNotificationDataProvider::getRefId ( )

Implements ilForumNotificationMailData.

Definition at line 131 of file class.ilForumCronNotificationDataProvider.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

◆ getThreadId()

ilForumCronNotificationDataProvider::getThreadId ( )

Implements ilForumNotificationMailData.

Definition at line 161 of file class.ilForumCronNotificationDataProvider.php.

                                 : int
    {
        return $this->thread_id;
    }

References $thread_id.

◆ getThreadTitle()

ilForumCronNotificationDataProvider::getThreadTitle ( )

Implements ilForumNotificationMailData.

Definition at line 166 of file class.ilForumCronNotificationDataProvider.php.

                                    : string
    {
        return $this->thread_title;
    }

References $thread_title.

◆ isAnonymized()

ilForumCronNotificationDataProvider::isAnonymized ( )

Definition at line 239 of file class.ilForumCronNotificationDataProvider.php.

                                  : bool
    {
        return $this->is_anonymized;
    }

References $is_anonymized.

◆ isPostCensored()

ilForumCronNotificationDataProvider::isPostCensored ( )

Implements ilForumNotificationMailData.

Definition at line 196 of file class.ilForumCronNotificationDataProvider.php.

                                    : bool
    {
        return $this->post_censored;
    }

References $post_censored.

◆ providesClosestContainer()

ilForumCronNotificationDataProvider::providesClosestContainer ( )

Implements ilForumNotificationMailData.

Definition at line 151 of file class.ilForumCronNotificationDataProvider.php.

                                              : bool
    {
        return $this->closest_container !== null;
    }

◆ read()

ilForumCronNotificationDataProvider::read ( )

protected

Definition at line 101 of file class.ilForumCronNotificationDataProvider.php.

                             : void
    {
        $this->readAttachments();
    }

References readAttachments().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAttachments()

ilForumCronNotificationDataProvider::readAttachments ( )

private

Definition at line 106 of file class.ilForumCronNotificationDataProvider.php.

                                      : void
    {
        if (ilForumProperties::isSendAttachmentsByMailEnabled()) {
            $fileDataForum = new ilFileDataForum($this->getObjId(), $this->getPostId());
            $filesOfPost = $fileDataForum->getFilesOfPost();
 
            foreach ($filesOfPost as $attachment) {
                $this->attachments[] = $attachment['name'];
            }
        }
    }