class.ilForumAuthorInformation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilForumAuthorInformation
{
    private string $author_name = '';
    private string $author_short_name = '';
    private string $linked_public_name = '';
    private string $linked_short_name = '';
    private string $suffix = '';
    private string $profilePicture;
    private ?ilObjUser $author = null;
    private ilLanguage $globalLng;
    private readonly ilObjUser $globalUser;
    private bool $is_deleted = false;

    public function __construct(
        private readonly int $author_id,
        private readonly int $display_id,
        private readonly string $alias,
        private readonly string $import_name,
        private readonly array $public_profile_link_attributes = [],
        private ?ilLanguage $lng = null
    ) {
        global $DIC;

        $this->globalUser = $DIC->user();
        $this->globalLng = $DIC->language();

        $this->init();
    }

    protected function initUserInstance(): void
    {
        if ($this->display_id > 0) {
            // Try to read user instance from preloaded cache array
            $this->author = ilForumAuthorInformationCache::getUserObjectById($this->display_id);
            if (!$this->author instanceof ilObjUser) {
                // Get a user instance from forum module's cache method
                $this->author = ilObjForumAccess::getCachedUserInstance($this->display_id);
            }
        }

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

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

    protected function isAuthorAnonymous(): bool
    {
        return $this->doesAuthorAccountExists() && $this->getAuthor()->isAnonymous();
    }

    protected function isCurrentUserSessionLoggedIn(): bool
    {
        return !$this->globalUser->isAnonymous();
    }

    protected function buildAuthorProfileLink(bool $with_profile_link): void
    {
        $link = '';

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

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

            $link .= '>';
        }

        $linked_login = $link . $this->author_short_name;
        $link .= $this->author_name;

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

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

    protected function init(): void
    {
        $translationLanguage = $this->globalLng;
        if ($this->lng instanceof ilLanguage) {
            $translationLanguage = $this->lng;
        }

        $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->author_name = $this->getAuthor()->getPublicName();
                $this->author_short_name = $this->getAuthor()->getLogin();

                if ($this->getAuthor()->getPref('public_upload') === 'y') {
                    $this->profilePicture = $this->getUserImagePath($this->getAuthor());
                } else {
                    $this->profilePicture = $this->getAvatarImageSource(
                        ilStr::subStr(
                            $this->getAuthor()->getFirstname(),
                            0,
                            1
                        ) . ilStr::subStr($this->getAuthor()->getLastname(), 0, 1),
                        $this->getAuthor()->getId()
                    );
                }

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

                $this->buildAuthorProfileLink(true);
            } else {
                $this->getAuthor()->setGender('');
                $this->author_short_name = $this->author_name = $this->getAuthor()->getLogin();
                $this->buildAuthorProfileLink(false);
                $this->profilePicture = $this->getAvatarImageSource(
                    $this->author_short_name,
                    $this->getAuthor()->getId()
                );
            }
        } elseif ($this->display_id > 0 && $this->alias !== '') {
            // The author did use a pseudonym and the account does not exist anymore (deleted, lost on import etc.)
            $this->author_short_name = $this->author_name = $translationLanguage->txt('deleted');
            $this->is_deleted = true;
            $this->suffix = $translationLanguage->txt('deleted');
            $this->buildAuthorProfileLink(false);
            $this->profilePicture = $this->getAvatarImageSource($this->author_short_name);
        } elseif ($this->import_name !== '') {
            // We have no user instance,so we check the import name
            $this->author_short_name = $this->author_name = $this->import_name . ' (' . $translationLanguage->txt('imported') . ')';
            $this->suffix = $translationLanguage->txt('imported');
            $this->buildAuthorProfileLink(false);
            $this->profilePicture = $this->getAvatarImageSource($this->author_short_name);
        } elseif ($this->alias !== '') {
            // We have no import name,so we check the pseudonym
            $this->author_short_name = $this->author_name = $this->alias . ' (' . $translationLanguage->txt('frm_pseudonym') . ')';
            $this->suffix = $translationLanguage->txt('frm_pseudonym');
            $this->buildAuthorProfileLink(false);
            $this->profilePicture = $this->getAvatarImageSource($this->author_short_name);
        } else {
            // If we did not find a pseudonym, the author could not be determined
            $this->author_short_name = $this->author_name = $translationLanguage->txt('forums_anonymous');
            $this->buildAuthorProfileLink(false);
            $this->profilePicture = $this->getAvatarImageSource($this->author_short_name);
        }
    }

    protected function getUserImagePath(ilObjUser $user): string
    {
        if (!ilContext::hasHTML()) {
            return '';
        }

        return $user->getPersonalPicturePath('xsmall');
    }

    protected function getAvatarImageSource(string $name, int $usrId = ANONYMOUS_USER_ID): string
    {
        global $DIC;

        if (!ilContext::hasHTML()) {
            return '';
        }

        $avatar = $DIC["user.avatar.factory"]->avatar('xsmall');
        $avatar->setUsrId($usrId);
        $avatar->setName(ilStr::subStr($name, 0, 2));

        return $avatar->getUrl();
    }

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

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

    public function getAuthorName(bool $without_short_name = false): string
    {
        if (!$without_short_name) {
            return $this->author_name;
        }

        return trim(preg_replace('/\(' . preg_quote($this->getAuthorShortName(), '/') . '\)/', '', $this->author_name));
    }

    public function getAuthorShortName(): string
    {
        return $this->author_short_name;
    }

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

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

    public function hasSuffix(): bool
    {
        return $this->suffix !== '';
    }

    public function getSuffix(): string
    {
        return $this->suffix;
    }

    public function isDeleted(): bool
    {
        return $this->is_deleted;
    }

    public function getAlias(): string
    {
        return $this->alias;
    }
}