ilForumCronNotificationDataProvider Class Reference

Class ilForumCronNotificationDataProvider. More...

Inheritance diagram for ilForumCronNotificationDataProvider:

Collaboration diagram for ilForumCronNotificationDataProvider:

Public Member Functions
	__construct ($row, ilForumNotificationCache $notificationCache=null)
	addRecipient ($user_id)
	getCronRecipients ()
	getRefId ()
	getObjId ()
	getForumId ()
	closestContainer ()
	providesClosestContainer ()
	getForumTitle ()
	getThreadId ()
	getThreadTitle ()
	getPostId ()
	getPostTitle ()
	getPostMessage ()
	getPostDate ()
	getPostUpdate ()
	getPostCensored ()
	getPostCensoredDate ()
	getCensorshipComment ()
	getAttachments ()
	setNotificationType ($notification_type)
	getPosDisplayUserId ()
	getPosUserAlias ()
	getPostUpdateUserId ()
	setPostUpdateUserId ($post_update_user_id)
	setPosAuthorId ($pos_author_id)
	getPosAuthorId ()
	isAnonymized ()
	getDeletedBy ()
	getImportName ()
	getPostUserName (\ilLanguage $user_lang)
	Parameters \ilLanguage $user_lang Returns string More...
	getPostUpdateUserName (\ilLanguage $user_lang)
	Parameters \ilLanguage $user_lang Returns string More...
	getPublicUserInformation (ilForumAuthorInformation $authorinfo)

Data Fields
	$notification_type = null
	$post_update_user_id = 0
	$pos_author_id = 0
	$deleted_by = ''

Protected Member Functions
	read ()

Protected Attributes
	$ref_id = 0
	$obj_id = 0
	$forum_id = 0
	$forum_title = ''
	$thread_id = 0
	$thread_title = ''
	$post_id = 0
	$post_title = ''
	$post_message = ''
	$post_date = null
	$post_update = null
	$post_censored = false
	$post_censored_date = null
	$post_censored_comment = ''
	$pos_usr_alias = ''
	$pos_display_user_id = 0
	$is_anonymized = false
	$import_name = ''
	$attachments = array()
	$cron_recipients = array()

Static Protected Attributes
static	$authorInformationCache = array()

Private Member Functions
	readAttachments ()
	getAuthorInformation (\ilLanguage $lng, int $authorUsrId, int $displayUserId, string $usrAlias, string $importName)

Private Attributes
	$closest_container = null
	$post_user_name = null
	$update_user_name = null
	$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 9 of file class.ilForumCronNotificationDataProvider.php.

Constructor & Destructor Documentation

__construct()

ilForumCronNotificationDataProvider::__construct	(		$row,
		ilForumNotificationCache	$notificationCache = null
	)

Parameters

	$row
ilForumNotificationCache | null	$notificationCache

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

References $DIC, $notificationCache, and read().

    {
        $this->obj_id = $row['obj_id'];
        $this->ref_id = $row['ref_id'];

        $this->closest_container = $row['closest_container'];

        $this->thread_id = $row['thread_id'];
        $this->thread_title = $row['thr_subject'];

        $this->forum_id = $row['pos_top_fk'];
        $this->forum_title = $row['top_name'];

        $this->post_id = $row['pos_pk'];
        $this->post_title = $row['pos_subject'];
        $this->post_message = $row['pos_message'];
        $this->post_date = $row['pos_date'];
        $this->post_update = $row['pos_update'];
        $this->post_update_user_id = $row['update_user'];

        $this->post_censored = $row['pos_cens'];
        $this->post_censored_date = $row['pos_cens_date'];
        $this->post_censored_comment = $row['pos_cens_com'];

        $this->pos_usr_alias = $row['pos_usr_alias'];
        $this->pos_display_user_id = $row['pos_display_user_id'];
        $this->pos_author_id = $row['pos_author_id'];

        $this->import_name = strlen($row['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();
    }

Here is the call graph for this function:

Member Function Documentation

addRecipient()

ilForumCronNotificationDataProvider::addRecipient

(

$user_id

)

Parameters

int

$user_id

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

    {
        $this->cron_recipients[] = (int) $user_id;
    }

closestContainer()

ilForumCronNotificationDataProvider::closestContainer

(

)

Returns

ilObjCourse|ilObjGroup|null

Implements ilForumNotificationMailData.

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

References $closest_container.

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

getAttachments()

ilForumCronNotificationDataProvider::getAttachments

(

)

Returns

array file names

Implements ilForumNotificationMailData.

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

References $attachments.

    {
        return $this->attachments;
    }

getAuthorInformation()

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

private

Parameters

ilLanguage	$lng
	$authorUsrId
	$displayUserId
	$usrAlias
	$importName

Returns

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

References ilLanguage\getLangKey().

      {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            $lng->getLangKey(),
            (int) $authorUsrId,
            (int) $displayUserId,
            (string) $usrAlias,
            (string) $importName
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $authorInformation = new ilForumAuthorInformation(
                $authorUsrId,
                $displayUserId,
                $usrAlias,
                $importName,
                array(),
                $lng
            );

            $this->notificationCache->store($cacheKey, $authorInformation);
        }

        return $this->notificationCache->fetch($cacheKey);
    }

Here is the call graph for this function:

getCensorshipComment()

ilForumCronNotificationDataProvider::getCensorshipComment

(

)

Returns

string

Implements ilForumNotificationMailData.

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

References $post_censored_comment.

    {
        return $this->post_censored_comment;
    }

getCronRecipients()

ilForumCronNotificationDataProvider::getCronRecipients

(

)

Returns

int[]

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

References $cron_recipients.

    {
        return $this->cron_recipients;
    }

getDeletedBy()

ilForumCronNotificationDataProvider::getDeletedBy

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $deleted_by.

    {
        return $this->deleted_by;
    }

getForumId()

ilForumCronNotificationDataProvider::getForumId

(

)

Returns

int frm_data.top_pk

Implements ilForumNotificationMailData.

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

References $forum_id.

    {
        return $this->forum_id;
    }

getForumTitle()

ilForumCronNotificationDataProvider::getForumTitle

(

)

Returns

string frm_data.top_name

Implements ilForumNotificationMailData.

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

References $forum_title.

    {
        return $this->forum_title;
    }

getImportName()

ilForumCronNotificationDataProvider::getImportName

(

)

Returns

string

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

References $import_name.

Referenced by getPostUpdateUserName(), and getPostUserName().

    {
        return $this->import_name;
    }

Here is the caller graph for this function:

getObjId()

ilForumCronNotificationDataProvider::getObjId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $obj_id.

Referenced by readAttachments().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getPosAuthorId()

ilForumCronNotificationDataProvider::getPosAuthorId

(

)

Returns

string frm_posts.pos_author_id

Implements ilForumNotificationMailData.

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

References $pos_author_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

    {
        return $this->pos_author_id;
    }

Here is the caller graph for this function:

getPosDisplayUserId()

ilForumCronNotificationDataProvider::getPosDisplayUserId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $pos_display_user_id.

Referenced by getPostUpdateUserName(), and getPostUserName().

    {
        return $this->pos_display_user_id;
    }

Here is the caller graph for this function:

getPostCensored()

ilForumCronNotificationDataProvider::getPostCensored

(

)

Returns

string frm_posts.pos_cens

Implements ilForumNotificationMailData.

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

References $post_censored.

    {
        return $this->post_censored;
    }

getPostCensoredDate()

ilForumCronNotificationDataProvider::getPostCensoredDate

(

)

Returns

string frm_posts.pos_cens_date

Implements ilForumNotificationMailData.

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

References $post_censored_date.

    {
        return $this->post_censored_date;
    }

getPostDate()

ilForumCronNotificationDataProvider::getPostDate

(

)

Returns

string frm_posts.pos_date

Implements ilForumNotificationMailData.

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

References $post_date.

    {
        return $this->post_date;
    }

getPostId()

ilForumCronNotificationDataProvider::getPostId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $post_id.

Referenced by readAttachments().

    {
        return $this->post_id;
    }

Here is the caller graph for this function:

getPostMessage()

ilForumCronNotificationDataProvider::getPostMessage

(

)

Returns

string frm_posts.pos_message

Implements ilForumNotificationMailData.

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

References $post_message.

    {
        return $this->post_message;
    }

getPostTitle()

ilForumCronNotificationDataProvider::getPostTitle

(

)

Returns

string frm_posts.pos_subject

Implements ilForumNotificationMailData.

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

References $post_title.

    {
        return $this->post_title;
    }

getPostUpdate()

ilForumCronNotificationDataProvider::getPostUpdate

(

)

Returns

string frm_posts.pos_update

Implements ilForumNotificationMailData.

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

References $post_update.

    {
        return $this->post_update;
    }

getPostUpdateUserId()

ilForumCronNotificationDataProvider::getPostUpdateUserId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $post_update_user_id.

Referenced by getPostUpdateUserName().

    {
        return $this->post_update_user_id;
    }

Here is the caller graph for this function:

getPostUpdateUserName()

ilForumCronNotificationDataProvider::getPostUpdateUserName

(

\ilLanguage

$user_lang

)

Parameters

\ilLanguage

$user_lang

Returns

string

Implements ilForumNotificationMailData.

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

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

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

Here is the call graph for this function:

getPostUserName()

ilForumCronNotificationDataProvider::getPostUserName

(

\ilLanguage

$user_lang

)

Parameters

\ilLanguage

$user_lang

Returns

string

Implements ilForumNotificationMailData.

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

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

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

        return $this->post_user_name;
    }

Here is the call graph for this function:

getPosUserAlias()

ilForumCronNotificationDataProvider::getPosUserAlias

(

)

Returns

string frm_posts.pos_usr_alias

Implements ilForumNotificationMailData.

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

References $pos_usr_alias.

Referenced by getPostUpdateUserName(), and getPostUserName().

    {
        return $this->pos_usr_alias;
    }

Here is the caller graph for this function:

getPublicUserInformation()

ilForumCronNotificationDataProvider::getPublicUserInformation

(

ilForumAuthorInformation

$authorinfo

)

Parameters

ilForumAuthorInformation

$authorinfo

Returns

string

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

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

Referenced by getPostUpdateUserName(), and getPostUserName().

    {
        $publicName = $authorinfo->getAuthorShortName();

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

        return $publicName;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilForumCronNotificationDataProvider::getRefId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $ref_id.

    {
        return $this->ref_id;
    }

getThreadId()

ilForumCronNotificationDataProvider::getThreadId

(

)

Returns

int

Implements ilForumNotificationMailData.

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

References $thread_id.

    {
        return $this->thread_id;
    }

getThreadTitle()

ilForumCronNotificationDataProvider::getThreadTitle

(

)

Returns

string frm_threads.thr_subject

Implements ilForumNotificationMailData.

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

References $thread_title.

    {
        return $this->thread_title;
    }

isAnonymized()

ilForumCronNotificationDataProvider::isAnonymized

(

)

Returns

bool

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

References $is_anonymized.

Referenced by getPublicUserInformation().

    {
        return $this->is_anonymized;
    }

Here is the caller graph for this function:

providesClosestContainer()

ilForumCronNotificationDataProvider::providesClosestContainer

(

)

Implements ilForumNotificationMailData.

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

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

read()

ilForumCronNotificationDataProvider::read ( )

protected

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

References readAttachments().

Referenced by __construct().

    {
        $this->readAttachments();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readAttachments()

ilForumCronNotificationDataProvider::readAttachments ( )

private

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

References getObjId(), getPostId(), and ilForumProperties\isSendAttachmentsByMailEnabled().

Referenced by read().

    {
        if (ilForumProperties::isSendAttachmentsByMailEnabled()) {
            // get attachments
            $fileDataForum = new ilFileDataForum($this->getObjId(), $this->getPostId());
            $filesOfPost = $fileDataForum->getFilesOfPost();

            foreach ($filesOfPost as $attachment) {
                $this->attachments[] = $attachment['name'];
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setNotificationType()

ilForumCronNotificationDataProvider::setNotificationType

(

$notification_type

)

Parameters

null

$notification_type

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

References $notification_type.

    {
        $this->notification_type = $notification_type;
    }

setPosAuthorId()

ilForumCronNotificationDataProvider::setPosAuthorId

(

$pos_author_id

)

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

References $pos_author_id.

    {
        $this->pos_author_id = $pos_author_id;
    }

setPostUpdateUserId()

ilForumCronNotificationDataProvider::setPostUpdateUserId

(

$post_update_user_id

)

Parameters

int

$post_update_user_id

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

References $post_update_user_id.

    {
        $this->post_update_user_id = $post_update_user_id;
    }

Field Documentation

$attachments

array ilForumCronNotificationDataProvider::$attachments = array()

protected

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

Referenced by getAttachments().

$authorInformationCache

ilForumCronNotificationDataProvider::$authorInformationCache = array()

staticprotected

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

$closest_container

ilForumCronNotificationDataProvider::$closest_container = null

private

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

Referenced by closestContainer().

$cron_recipients

ilForumCronNotificationDataProvider::$cron_recipients = array()

protected

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

Referenced by getCronRecipients().

$deleted_by

ilForumCronNotificationDataProvider::$deleted_by = ''

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

Referenced by getDeletedBy().

$forum_id

ilForumCronNotificationDataProvider::$forum_id = 0

protected

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

Referenced by getForumId().

$forum_title

string ilForumCronNotificationDataProvider::$forum_title = ''

protected

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

Referenced by getForumTitle().

$import_name

ilForumCronNotificationDataProvider::$import_name = ''

protected

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

Referenced by getImportName().

$is_anonymized

ilForumCronNotificationDataProvider::$is_anonymized = false

protected

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

Referenced by isAnonymized().

$notification_type

ilForumCronNotificationDataProvider::$notification_type = null

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

Referenced by setNotificationType().

$notificationCache

ilForumCronNotificationDataProvider::$notificationCache

private

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

Referenced by __construct().

$obj_id

int ilForumCronNotificationDataProvider::$obj_id = 0

protected

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

Referenced by getObjId().

$pos_author_id

ilForumCronNotificationDataProvider::$pos_author_id = 0

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

Referenced by getPosAuthorId(), and setPosAuthorId().

$pos_display_user_id

ilForumCronNotificationDataProvider::$pos_display_user_id = 0

protected

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

Referenced by getPosDisplayUserId().

$pos_usr_alias

ilForumCronNotificationDataProvider::$pos_usr_alias = ''

protected

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

Referenced by getPosUserAlias().

$post_censored

ilForumCronNotificationDataProvider::$post_censored = false

protected

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

Referenced by getPostCensored().

$post_censored_comment

ilForumCronNotificationDataProvider::$post_censored_comment = ''

protected

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

Referenced by getCensorshipComment().

$post_censored_date

ilForumCronNotificationDataProvider::$post_censored_date = null

protected

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

Referenced by getPostCensoredDate().

$post_date

ilForumCronNotificationDataProvider::$post_date = null

protected

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

Referenced by getPostDate().

$post_id

ilForumCronNotificationDataProvider::$post_id = 0

protected

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

Referenced by getPostId().

$post_message

ilForumCronNotificationDataProvider::$post_message = ''

protected

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

Referenced by getPostMessage().

$post_title

ilForumCronNotificationDataProvider::$post_title = ''

protected

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

Referenced by getPostTitle().

$post_update

ilForumCronNotificationDataProvider::$post_update = null

protected

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

Referenced by getPostUpdate().

$post_update_user_id

ilForumCronNotificationDataProvider::$post_update_user_id = 0

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

Referenced by getPostUpdateUserId(), and setPostUpdateUserId().

$post_user_name

ilForumCronNotificationDataProvider::$post_user_name = null

private

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

Referenced by getPostUserName().

$ref_id

int ilForumCronNotificationDataProvider::$ref_id = 0

protected

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

Referenced by getRefId().

$thread_id

ilForumCronNotificationDataProvider::$thread_id = 0

protected

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

Referenced by getThreadId().

$thread_title

string ilForumCronNotificationDataProvider::$thread_title = ''

protected

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

Referenced by getThreadTitle().

$update_user_name

ilForumCronNotificationDataProvider::$update_user_name = null

private

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

Referenced by getPostUpdateUserName().

---

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

• Modules/Forum/classes/class.ilForumCronNotificationDataProvider.php