class.ilForumCronNotificationDataProvider.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once './Modules/Forum/interfaces/interface.ilForumNotificationMailData.php';
include_once './Modules/Forum/classes/class.ilForumProperties.php';
require_once 'Modules/Forum/classes/class.ilForumAuthorInformation.php';

class ilForumCronNotificationDataProvider implements ilForumNotificationMailData
{
        public $notification_type = NULL;

        protected $ref_id = 0;

        protected $obj_id = 0;

        protected $post_user_name = null;

        protected $update_user_name = null;

        protected $forum_id = 0;

        protected $forum_title = '';

        protected $thread_id = 0;

        protected $thread_title = '';

        protected $post_id = 0;
        protected $post_title = '';
        protected $post_message = '';
        protected $post_date = NULL;
        protected $post_update = NULL;

        protected $post_censored = false;
        protected $post_censored_date = NULL;
        protected $post_censored_comment = '';

        protected $pos_usr_alias = '';
        protected $pos_display_user_id = 0;
        
        protected $is_anonymized = false;
        
        protected $import_name = '';
        
        protected $attachments = array();

        protected $cron_recipients = array();

        public $objPost = NULL;

        public $post_update_user_id = 0;
        
        public $pos_author_id = 0;

        protected static $authorInformationCache = array();

        public function __construct($row)
        {
                $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();
        }

        protected function read()
        {
                $this->readAttachments();
        }

        private function readAttachments()
        {
                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'];
                        }
                }
        }

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

        public function getCronRecipients()
        {
                return $this->cron_recipients;
        }

        public function getRefId()
        {
                return $this->ref_id;
        }

        public function getObjId()
        {
                return $this->obj_id;
        }

        public function getForumId()
        {
                return $this->forum_id;
        }

        public function getForumTitle()
        {
                return $this->forum_title;
        }

        public function getThreadId()
        {
                return $this->thread_id;
        }

        public function getThreadTitle()
        {
                return $this->thread_title;
        }

        public function getPostId()
        {
                return $this->post_id;
        }

        public function getPostTitle()
        {
                return $this->post_title;
        }

        public function getPostMessage()
        {
                return $this->post_message;
        }

        public function getPostDate()
        {
                return $this->post_date;
        }

        public function getPostUpdate()
        {
                return $this->post_update;
        }

        public function getPostCensored()
        {
                return $this->post_censored;
        }

        public function getPostCensoredDate()
        {
                return $this->post_censored_date;
        }

        public function getCensorshipComment()
        {
                return $this->post_censored_comment;
        }

        public function getAttachments()
        {
                return $this->attachments;
        }

        public function setNotificationType($notification_type)
        {
                $this->notification_type = $notification_type;
        }

        public function getPosDisplayUserId()
        {
                return $this->pos_display_user_id;
        }


        public function getPosUserAlias()
        {
                return $this->pos_usr_alias;
        }

        public function getPostUpdateUserId()
        {
                return $this->post_update_user_id;
        }

        public function setPostUpdateUserId($post_update_user_id)
        {
                $this->post_update_user_id = $post_update_user_id;
        }
        
        public function setPosAuthorId($pos_author_id)
        {
                $this->pos_author_id = $pos_author_id;
        }
        public function getPosAuthorId()
        {
                return $this->pos_author_id;
        }
        
        public function isAnonymized()
        {
                return $this->is_anonymized;
        }
        
        public function getImportName()
        {
                return $this->import_name;
        }

        private function getAuthorInformation(\ilLanguage $lng, $authorUsrId, $displayUserId, $usrAlias, $importName)
        {
                $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];
        }

        public function getPostUserName(\ilLanguage $user_lang)
        {
                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;
        }
        
        public function getPostUpdateUserName(\ilLanguage $user_lang)
        {
                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;
        }
        
        public function getPublicUserInformation(ilForumAuthorInformation $authorinfo)
        {
                if($authorinfo->hasSuffix())
                {
                        $public_name = $authorinfo->getAuthorName();
                }
                else
                {
                        $public_name = $authorinfo->getAuthorShortName();
                        
                        if($authorinfo->getAuthorName() && !$this->isAnonymized())
                        {
                                $public_name = $authorinfo->getAuthorName();
                        }
                }
                
                return $public_name;
        }
}