Class ilForumCronNotificationDataProvider. More...

Inheritance diagram for ilForumCronNotificationDataProvider:

Collaboration diagram for ilForumCronNotificationDataProvider:

Public Member Functions

__construct ($row)

addRecipient ($user_id)

getCronRecipients ()

getRefId ()

getObjId ()

getForumId ()

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 ()

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

	$objPost = NULL

	$post_update_user_id = 0

	$pos_author_id = 0

Protected Member Functions
	read ()

Protected Attributes
	$ref_id = 0

	$obj_id = 0

	$post_user_name = null

	$update_user_name = null

	$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, $authorUsrId, $displayUserId, $usrAlias, $importName)

Detailed Description

Class ilForumCronNotificationDataProvider.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilForumCronNotificationDataProvider::__construct ( $row )

Parameters

$row

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

References $row, and read().

         {
                 $this->obj_id = $row['obj_id'];
                 $this->ref_id = $row['ref_id'];
 
                 $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'] : '';
 
                 $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 207 of file class.ilForumCronNotificationDataProvider.php.

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

◆ getAttachments()

ilForumCronNotificationDataProvider::getAttachments ( )

Returns: array file names

Implements ilForumNotificationMailData.

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

References $attachments.

         {
                 return $this->attachments;
         }

◆ getAuthorInformation()

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

private

Parameters

ilLanguage	$lng
	$authorUsrId
	$displayUserId
	$usrAlias
	$importName

Returns

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

References array, ilLanguage\getLangKey(), and string.

         {
                 $cacheKey = md5(implode('|', array(
                         $lng->getLangKey(),
                         (int)$authorUsrId,
                         (int)$displayUserId,
                         (string)$usrAlias,
                         (string)$importName
                 )));
 
                 if (!array_key_exists($cacheKey, self::$authorInformationCache)) {
                         $authorInformation = new ilForumAuthorInformation(
                                 $authorUsrId,
                                 $displayUserId,
                                 $usrAlias,
                                 $importName,
                                 array(),
                                 $lng
                         );
 
                         self::$authorInformationCache[$cacheKey] = $authorInformation;
                 }
 
                 return self::$authorInformationCache[$cacheKey];
         }

Here is the call graph for this function:

◆ getCensorshipComment()

ilForumCronNotificationDataProvider::getCensorshipComment ( )

Returns: string

Implements ilForumNotificationMailData.

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

References $post_censored_comment.

         {
                 return $this->post_censored_comment;
         }

◆ getCronRecipients()

ilForumCronNotificationDataProvider::getCronRecipients ( )

Returns: array

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

References $cron_recipients.

         {
                 return $this->cron_recipients;
         }

◆ getForumId()

ilForumCronNotificationDataProvider::getForumId ( )

Returns: int frm_data.top_pk

Implements ilForumNotificationMailData.

Definition at line 239 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 247 of file class.ilForumCronNotificationDataProvider.php.

References $forum_title.

         {
                 return $this->forum_title;
         }

◆ getImportName()

ilForumCronNotificationDataProvider::getImportName ( )

Returns: string

Definition at line 401 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 231 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 385 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 351 of file class.ilForumCronNotificationDataProvider.php.

References $pos_display_user_id.

Referenced by 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 311 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 319 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 295 of file class.ilForumCronNotificationDataProvider.php.

References $post_date.

         {
                 return $this->post_date;
         }

◆ getPostId()

ilForumCronNotificationDataProvider::getPostId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 271 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 287 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 279 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 303 of file class.ilForumCronNotificationDataProvider.php.

References $post_update.

         {
                 return $this->post_update;
         }

◆ getPostUpdateUserId()

ilForumCronNotificationDataProvider::getPostUpdateUserId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 368 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 461 of file class.ilForumCronNotificationDataProvider.php.

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

         {
                 if ($this->update_user_name === null) {
                         $this->update_user_name = $this->getPublicUserInformation(self::getAuthorInformation(
                                 $user_lang,
                                 $this->getPosAuthorId(),
                                 $this->getPostUpdateUserId(),
                                 $this->getPosUserAlias(),
                                 $this->getImportName()
                         ));
                 }
 
                 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 443 of file class.ilForumCronNotificationDataProvider.php.

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

         {
                 if (null === $this->post_user_name) {
                         $this->post_user_name = $this->getPublicUserInformation(self::getAuthorInformation(
                                 $user_lang,
                                 $this->getPosAuthorId(),
                                 $this->getPosDisplayUserId(),
                                 $this->getPosUserAlias(),
                                 $this->getImportName()
                         ));
                 }
 
                 return (string)$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 360 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 480 of file class.ilForumCronNotificationDataProvider.php.

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

Referenced by getPostUpdateUserName(), and getPostUserName().

         {
                 if($authorinfo->hasSuffix())
                 {
                         $public_name = $authorinfo->getAuthorName();
                 }
                 else
                 {
                         $public_name = $authorinfo->getAuthorShortName();
                         
                         if($authorinfo->getAuthorName() && !$this->isAnonymized())
                         {
                                 $public_name = $authorinfo->getAuthorName();
                         }
                 }
                 
                 return $public_name;
         }

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 223 of file class.ilForumCronNotificationDataProvider.php.

References $ref_id.

         {
                 return $this->ref_id;
         }

◆ getThreadId()

ilForumCronNotificationDataProvider::getThreadId ( )

Returns: int

Implements ilForumNotificationMailData.

Definition at line 255 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 263 of file class.ilForumCronNotificationDataProvider.php.

References $thread_title.

         {
                 return $this->thread_title;
         }

◆ isAnonymized()

ilForumCronNotificationDataProvider::isAnonymized ( )

Returns: bool

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

References $is_anonymized.

Referenced by getPublicUserInformation().

         {
                 return $this->is_anonymized;
         }

Here is the caller graph for this function:

◆ read()

ilForumCronNotificationDataProvider::read ( )

protected

Definition at line 180 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 188 of file class.ilForumCronNotificationDataProvider.php.

References getObjId(), and getPostId().

Referenced by read().

         {
                 if(ilForumProperties::isSendAttachmentsByMailEnabled())
                 {
                         // get attachments
                         include_once "./Modules/Forum/classes/class.ilFileDataForum.php";
                         $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 343 of file class.ilForumCronNotificationDataProvider.php.

References $notification_type.

         {
                 $this->notification_type = $notification_type;
         }

◆ setPosAuthorId()

ilForumCronNotificationDataProvider::setPosAuthorId ( $pos_author_id )

Definition at line 381 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 376 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 116 of file class.ilForumCronNotificationDataProvider.php.

Referenced by getAttachments().

◆ $authorInformationCache

ilForumCronNotificationDataProvider::$authorInformationCache = array()

staticprotected

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

◆ $cron_recipients

ilForumCronNotificationDataProvider::$cron_recipients = array()

protected

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

Referenced by getCronRecipients().

◆ $forum_id

ilForumCronNotificationDataProvider::$forum_id = 0

protected

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

Referenced by getForumId().

◆ $forum_title

string ilForumCronNotificationDataProvider::$forum_title = ''

protected

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

Referenced by getForumTitle().

◆ $import_name

ilForumCronNotificationDataProvider::$import_name = ''

protected

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

Referenced by getImportName().

◆ $is_anonymized

ilForumCronNotificationDataProvider::$is_anonymized = false

protected

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

Referenced by isAnonymized().

◆ $notification_type

ilForumCronNotificationDataProvider::$notification_type = NULL

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

Referenced by setNotificationType().

◆ $obj_id

int ilForumCronNotificationDataProvider::$obj_id = 0

protected

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

Referenced by getObjId().

◆ $objPost

ilForumCronNotificationDataProvider::$objPost = NULL

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

◆ $pos_author_id

ilForumCronNotificationDataProvider::$pos_author_id = 0

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

Referenced by getPosAuthorId(), and setPosAuthorId().

◆ $pos_display_user_id

ilForumCronNotificationDataProvider::$pos_display_user_id = 0

protected

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

Referenced by getPosDisplayUserId().

◆ $pos_usr_alias

ilForumCronNotificationDataProvider::$pos_usr_alias = ''

protected

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

Referenced by getPosUserAlias().

◆ $post_censored

ilForumCronNotificationDataProvider::$post_censored = false

protected

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

Referenced by getPostCensored().

◆ $post_censored_comment

ilForumCronNotificationDataProvider::$post_censored_comment = ''

protected

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

Referenced by getCensorshipComment().

◆ $post_censored_date

ilForumCronNotificationDataProvider::$post_censored_date = NULL

protected

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

Referenced by getPostCensoredDate().

◆ $post_date

ilForumCronNotificationDataProvider::$post_date = NULL

protected

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

Referenced by getPostDate().

◆ $post_id

ilForumCronNotificationDataProvider::$post_id = 0

protected

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

Referenced by getPostId().

◆ $post_message

ilForumCronNotificationDataProvider::$post_message = ''

protected

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

Referenced by getPostMessage().

◆ $post_title

ilForumCronNotificationDataProvider::$post_title = ''

protected

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

Referenced by getPostTitle().

◆ $post_update

ilForumCronNotificationDataProvider::$post_update = NULL

protected

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

Referenced by getPostUpdate().

◆ $post_update_user_id

ilForumCronNotificationDataProvider::$post_update_user_id = 0

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

Referenced by getPostUpdateUserId(), and setPostUpdateUserId().

◆ $post_user_name

string null ilForumCronNotificationDataProvider::$post_user_name = null

protected

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

Referenced by getPostUserName().

◆ $ref_id

int ilForumCronNotificationDataProvider::$ref_id = 0

protected

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

Referenced by getRefId().

◆ $thread_id

ilForumCronNotificationDataProvider::$thread_id = 0

protected

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

Referenced by getThreadId().

◆ $thread_title

string ilForumCronNotificationDataProvider::$thread_title = ''

protected

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

Referenced by getThreadTitle().

◆ $update_user_name

string null ilForumCronNotificationDataProvider::$update_user_name = null

protected

Definition at line 38 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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addRecipient()

◆ getAttachments()

◆ getAuthorInformation()

◆ getCensorshipComment()

◆ getCronRecipients()

◆ getForumId()

◆ getForumTitle()

◆ getImportName()

◆ getObjId()

◆ getPosAuthorId()

◆ getPosDisplayUserId()

◆ getPostCensored()

◆ getPostCensoredDate()

◆ getPostDate()

◆ getPostId()

◆ getPostMessage()

◆ getPostTitle()

◆ getPostUpdate()

◆ getPostUpdateUserId()

◆ getPostUpdateUserName()

◆ getPostUserName()

◆ getPosUserAlias()

◆ getPublicUserInformation()

◆ getRefId()

◆ getThreadId()

◆ getThreadTitle()

◆ isAnonymized()

◆ read()

◆ readAttachments()

◆ setNotificationType()

◆ setPosAuthorId()

◆ setPostUpdateUserId()

Field Documentation

◆ $attachments

◆ $authorInformationCache

◆ $cron_recipients

◆ $forum_id

◆ $forum_title

◆ $import_name

◆ $is_anonymized

◆ $notification_type

◆ $obj_id

◆ $objPost

◆ $pos_author_id

◆ $pos_display_user_id

◆ $pos_usr_alias

◆ $post_censored

◆ $post_censored_comment

◆ $post_censored_date

◆ $post_date

◆ $post_id

◆ $post_message

◆ $post_title

◆ $post_update

◆ $post_update_user_id

◆ $post_user_name

◆ $ref_id

◆ $thread_id

◆ $thread_title

◆ $update_user_name