class.ilForumAuthorInformation.php

Go to the documentation of this file.

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

require_once 'Modules/Forum/classes/class.ilObjForumAccess.php';
require_once 'Modules/Forum/classes/class.ilForumAuthorInformationCache.php';

class ilForumAuthorInformation
{
        protected $authorEntity;

        protected $pseudonym;

        protected $importName;

        protected $publicProfileLinkAttributes = array();

        protected $authorName;

        protected $authorShortName;

        protected $linked_public_name;

        protected $linked_short_name;

        protected $is_pseudonym = false;

        protected $profilePicture;

        protected $author;

        protected $files = array();

        public function __construct($authorEntity, $pseudonym, $importName, array $publicProfileLinkAttributes = array())
        {
                $this->authorEntity                = $authorEntity;
                $this->pseudonym                   = $pseudonym;
                $this->importName                  = $importName;
                $this->publicProfileLinkAttributes = $publicProfileLinkAttributes;

                $this->init();
        }

        protected function initUserInstance()
        {
                if($this->authorEntity instanceof ilObjUser && $this->authorEntity->getId())
                {
                        $this->author = $this->authorEntity;
                }
                else if(is_numeric($this->authorEntity) && $this->authorEntity)
                {
                        // Try to read user instance from preloaded cache array
                        $this->author = ilForumAuthorInformationCache::getUserObjectById($this->authorEntity);

                        if(!$this->author)
                        {
                                // Get a user instance from forum module's cache method
                                $this->author = ilObjForumAccess::getCachedUserInstance($this->authorEntity);
                        }
                }

                if(!$this->author)
                {
                        $this->author = new ilObjUser();
                        $this->author->setId(0);
                        $this->author->setPref('public_profile', 'n');
                        $this->author->setGender('');
                }
        }

        protected function doesAuthorAccountExists()
        {
                return $this->getAuthor() instanceof ilObjUser && $this->getAuthor()->getId();
        }

        protected function isAuthorAnonymous()
        {
                return $this->doesAuthorAccountExists() && $this->getAuthor()->getId() == ANONYMOUS_USER_ID;
        }

        protected function isCurrentUserSessionLoggedIn()
        {
                global $ilUser;

                return $ilUser->getId() != ANONYMOUS_USER_ID;
        }

        protected function buildAuthorProfileLink($with_profile_link = false)
        {
                $link = '';

                if($with_profile_link && $this->publicProfileLinkAttributes)
                {
                        $link = '<a';

                        foreach($this->publicProfileLinkAttributes as $attr => $value)
                        {
                                $link .= ' ' . $attr . '="' . $value . '"';
                        }

                        $link .= '>';
                }

                $linked_login = $link . $this->authorShortName;
                $link .= $this->authorName;

                if($with_profile_link && $this->publicProfileLinkAttributes)
                {
                        $link .= '</a>';
                        $linked_login .= '</a>';
                }

                $this->linked_public_name = $link;
                $this->linked_short_name  = $linked_login;
        }

        protected function init()
        {
                global $lng;

                include_once 'Modules/Forum/classes/class.ilObjForumAccess.php';

                $this->initUserInstance();

                if($this->doesAuthorAccountExists())
                {
                        if(!$this->isAuthorAnonymous() &&
                                ($this->isCurrentUserSessionLoggedIn() && $this->getAuthor()->getPref('public_profile') == 'y' || $this->getAuthor()->getPref('public_profile') == 'g')
                        )
                        {
                                // Author is NOT anonymous and (the current user session is logged in and the profile is public (y) or the profile is globally public (g))
                                $this->authorName      = $this->getAuthor()->getPublicName();
                                $this->authorShortName = $this->getAuthor()->getLogin();

                                if($this->getAuthor()->getPref('public_upload') == 'y')
                                {
                                        $this->profilePicture = $this->getAuthor()->getPersonalPicturePath('xsmall');
                                }
                                else
                                {
                                        $this->profilePicture = ilUtil::getImagePath('no_photo_xsmall.jpg');
                                }

                                if($this->getAuthor()->getPref('public_gender') != 'y')
                                {
                                        $this->getAuthor()->setGender('');
                                }

                                $this->buildAuthorProfileLink(true);
                        }
                        else
                        {
                                $this->getAuthor()->setGender('');
                                $this->authorShortName = $this->authorName = $this->getAuthor()->getLogin();
                                $this->buildAuthorProfileLink(false);
                                $this->profilePicture = ilUtil::getImagePath('no_photo_xsmall.jpg');
                        }
                }
                else if(strlen($this->importName))
                {
                        // We have no user instance,so we check the import name
                        $this->authorShortName = $this->authorName = $this->importName ?
                                $this->importName . ' (' . $lng->txt('imported') . ')' :
                                $lng->txt('unknown');
                        $this->buildAuthorProfileLink(false);
                        $this->profilePicture = ilUtil::getImagePath('no_photo_xsmall.jpg');
                }
                else if(strlen($this->pseudonym))
                {
                        // We have no import name,so we check the pseudonym
                        $this->authorShortName = $this->authorName   = $this->pseudonym . ' (' . $lng->txt('frm_pseudonym') . ')';
                        $this->is_pseudonym = true;
                        $this->buildAuthorProfileLink(false);
                        $this->profilePicture = ilUtil::getImagePath('no_photo_xsmall.jpg');
                }
                else
                {
                        // If we did not find a pseudonym, the author could not be determined
                        $this->authorShortName = $this->authorName = $lng->txt('forums_anonymous');
                        $this->buildAuthorProfileLink(false);
                        $this->profilePicture = ilUtil::getImagePath('no_photo_xsmall.jpg');
                }
        }

        public function getProfilePicture()
        {
                return $this->profilePicture;
        }

        public function getAuthor()
        {
                return $this->author;
        }

        public function getAuthorName($without_short_name = false)
        {
                if(!$without_short_name)
                {
                        return $this->authorName;
                }
                else
                {
                        return trim(preg_replace('/\(?'.$this->getAuthorShortName().'\)?/', '', $this->authorName));
                }
        }

        public function getAuthorShortName()
        {
                return $this->authorShortName;
        }

        public function getLinkedAuthorName()
        {
                return $this->linked_public_name;
        }

        public function getLinkedAuthorShortName()
        {
                return $this->linked_short_name;
        }


        public function isPseudonymUsed()
        {
                return $this->is_pseudonym;
        }
}