ilForumAuthorInformation Class Reference

ilForumAuthorInformation More...

Collaboration diagram for ilForumAuthorInformation:

Public Member Functions
	__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 readonly ?ilLanguage $lng=null)
	getProfilePicture ()
	getAuthor ()
	getAuthorName (bool $without_short_name=false)
	getAuthorShortName ()
	getLinkedAuthorName ()
	getLinkedAuthorShortName ()
	hasSuffix ()
	getSuffix ()
	isDeleted ()
	getAlias ()

Protected Member Functions
	initUserInstance ()
	doesAuthorAccountExists ()
	isAuthorAnonymous ()
	isCurrentUserSessionLoggedIn ()
	buildAuthorProfileLink (bool $with_profile_link)
	init ()
	getUserImagePath (ilObjUser $user)

Private Attributes
string	$author_name = ''
string	$author_short_name = ''
string	$linked_public_name = ''
string	$linked_short_name = ''
string	$suffix = ''
string	$profilePicture
ilObjUser	$author = null
readonly ilLanguage	$globalLng
readonly ilObjUser	$globalUser
bool	$is_deleted = false

Detailed Description

ilForumAuthorInformation

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$ \

Definition at line 27 of file class.ilForumAuthorInformation.php.

Constructor & Destructor Documentation

__construct()

ilForumAuthorInformation::__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 readonly ?ilLanguage	$lng = null
	)

Definition at line 40 of file class.ilForumAuthorInformation.php.

References $DIC, and init().

      {
        global $DIC;

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

        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

buildAuthorProfileLink()

ilForumAuthorInformation::buildAuthorProfileLink ( bool  $with_profile_link )

protected

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

References $author_name, and $author_short_name.

Referenced by init().

                                                                      : 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;
    }

Here is the caller graph for this function:

doesAuthorAccountExists()

ilForumAuthorInformation::doesAuthorAccountExists ( )

protected

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

References getAuthor().

Referenced by init(), and isAuthorAnonymous().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAlias()

ilForumAuthorInformation::getAlias

(

)

Definition at line 263 of file class.ilForumAuthorInformation.php.

                              : string
    {
        return $this->alias;
    }

getAuthor()

ilForumAuthorInformation::getAuthor

(

)

Definition at line 219 of file class.ilForumAuthorInformation.php.

References $author.

Referenced by doesAuthorAccountExists(), init(), and isAuthorAnonymous().

                               : ilObjUser
    {
        return $this->author;
    }

Here is the caller graph for this function:

getAuthorName()

ilForumAuthorInformation::getAuthorName

(

bool

$without_short_name = false

)

Definition at line 224 of file class.ilForumAuthorInformation.php.

References $author_name, and getAuthorShortName().

Referenced by ilForumNotificationDataProvider\getPublicUserInformation(), and ilForumCronNotificationDataProvider\getPublicUserInformation().

                                                                   : string
    {
        if (!$without_short_name) {
            return $this->author_name;
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthorShortName()

ilForumAuthorInformation::getAuthorShortName

(

)

Definition at line 233 of file class.ilForumAuthorInformation.php.

References $author_short_name.

Referenced by getAuthorName(), ilForumNotificationDataProvider\getPublicUserInformation(), and ilForumCronNotificationDataProvider\getPublicUserInformation().

                                        : string
    {
        return $this->author_short_name;
    }

Here is the caller graph for this function:

getLinkedAuthorName()

ilForumAuthorInformation::getLinkedAuthorName

(

)

Definition at line 238 of file class.ilForumAuthorInformation.php.

References $linked_public_name.

                                         : string
    {
        return $this->linked_public_name;
    }

getLinkedAuthorShortName()

ilForumAuthorInformation::getLinkedAuthorShortName

(

)

Definition at line 243 of file class.ilForumAuthorInformation.php.

References $linked_short_name.

                                              : string
    {
        return $this->linked_short_name;
    }

getProfilePicture()

ilForumAuthorInformation::getProfilePicture

(

)

Definition at line 214 of file class.ilForumAuthorInformation.php.

References $profilePicture.

                                       : string
    {
        return $this->profilePicture;
    }

getSuffix()

ilForumAuthorInformation::getSuffix

(

)

Definition at line 253 of file class.ilForumAuthorInformation.php.

References $suffix.

                               : string
    {
        return $this->suffix;
    }

getUserImagePath()

ilForumAuthorInformation::getUserImagePath ( ilObjUser  $user )

protected

Definition at line 189 of file class.ilForumAuthorInformation.php.

References $DIC, ANONYMOUS_USER_ID, ilObjUser\getPersonalPicturePath(), ilContext\hasHTML(), and ilStr\subStr().

Referenced by init().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasSuffix()

ilForumAuthorInformation::hasSuffix

(

)

Definition at line 248 of file class.ilForumAuthorInformation.php.

Referenced by ilForumNotificationDataProvider\getPublicUserInformation(), and ilForumCronNotificationDataProvider\getPublicUserInformation().

                               : bool
    {
        return $this->suffix !== '';
    }

Here is the caller graph for this function:

init()

ilForumAuthorInformation::init ( )

protected

Definition at line 116 of file class.ilForumAuthorInformation.php.

References $globalLng, $lng, buildAuthorProfileLink(), doesAuthorAccountExists(), getAuthor(), ILIAS\Survey\Mode\getId(), getUserImagePath(), initUserInstance(), isAuthorAnonymous(), isCurrentUserSessionLoggedIn(), ILIAS\Repository\lng(), and ilStr\subStr().

Referenced by __construct().

                             : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUserInstance()

ilForumAuthorInformation::initUserInstance ( )

protected

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

References ilObjForumAccess\getCachedUserInstance(), and ilForumAuthorInformationCache\getUserObjectById().

Referenced by init().

                                         : 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');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAuthorAnonymous()

ilForumAuthorInformation::isAuthorAnonymous ( )

protected

Definition at line 80 of file class.ilForumAuthorInformation.php.

References doesAuthorAccountExists(), and getAuthor().

Referenced by init().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isCurrentUserSessionLoggedIn()

ilForumAuthorInformation::isCurrentUserSessionLoggedIn ( )

protected

Definition at line 85 of file class.ilForumAuthorInformation.php.

Referenced by init().

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

Here is the caller graph for this function:

isDeleted()

ilForumAuthorInformation::isDeleted

(

)

Definition at line 258 of file class.ilForumAuthorInformation.php.

References $is_deleted.

                               : bool
    {
        return $this->is_deleted;
    }

Field Documentation

$author

ilObjUser ilForumAuthorInformation::$author = null

private

Definition at line 35 of file class.ilForumAuthorInformation.php.

Referenced by getAuthor().

$author_name

string ilForumAuthorInformation::$author_name = ''

private

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

Referenced by buildAuthorProfileLink(), and getAuthorName().

$author_short_name

string ilForumAuthorInformation::$author_short_name = ''

private

Definition at line 30 of file class.ilForumAuthorInformation.php.

Referenced by buildAuthorProfileLink(), and getAuthorShortName().

$globalLng

readonly ilLanguage ilForumAuthorInformation::$globalLng

private

Definition at line 36 of file class.ilForumAuthorInformation.php.

Referenced by init().

$globalUser

readonly ilObjUser ilForumAuthorInformation::$globalUser

private

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

$is_deleted

bool ilForumAuthorInformation::$is_deleted = false

private

Definition at line 38 of file class.ilForumAuthorInformation.php.

Referenced by isDeleted().

$linked_public_name

string ilForumAuthorInformation::$linked_public_name = ''

private

Definition at line 31 of file class.ilForumAuthorInformation.php.

Referenced by getLinkedAuthorName().

$linked_short_name

string ilForumAuthorInformation::$linked_short_name = ''

private

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

Referenced by getLinkedAuthorShortName().

$profilePicture

string ilForumAuthorInformation::$profilePicture

private

Definition at line 34 of file class.ilForumAuthorInformation.php.

Referenced by getProfilePicture().

$suffix

string ilForumAuthorInformation::$suffix = ''

private

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

Referenced by getSuffix().

---

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

• components/ILIAS/Forum/classes/class.ilForumAuthorInformation.php