Collaboration diagram for ilForumAuthorInformation:

Public Member Functions
	__construct ($author_id, $display_id, $alias, $import_name, array $public_profile_link_attributes=array(), \ilLanguage $lng=null)

	getProfilePicture ()

	getAuthor ()

	getAuthorName ($without_short_name=false)

	getAuthorShortName ()

	getLinkedAuthorName ()

	getLinkedAuthorShortName ()

	hasSuffix ()

	getSuffix ()

Protected Member Functions
	initUserInstance ()

	doesAuthorAccountExists ()

	isAuthorAnonymous ()

	isCurrentUserSessionLoggedIn ()

	buildAuthorProfileLink ($with_profile_link=false)

	init ()

	getUserImagePath (\ilObjUser $user)

	getAnonymousImagePath ()

Protected Attributes
	$display_id

	$alias

	$import_name

	$public_profile_link_attributes = array()

	$author_name

	$author_short_name

	$linked_public_name

	$linked_short_name

	$suffix = ''

	$profilePicture

	$author

	$files = array()

	$author_id

	$lng

	$globalLng

	$globalUser

Detailed Description

ilForumAuthorInformation

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilForumAuthorInformation::__construct	(		$author_id,
			$display_id,
			$alias,
			$import_name,
		array	$public_profile_link_attributes = `array()`,
		\ilLanguage	$lng = `null`
	)

Parameters

int	$author_id
int	$display_id
string	$alias
string	$import_name
array	$public_profile_link_attributes
\ilLanguage \| null	$lng

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

        {
                global $ilUser, $lng;
 
                $this->globalUser = $ilUser;
                $this->globalLng  = $lng;
 
                $this->author_id                      = $author_id;
                $this->display_id                     = $display_id;
                $this->alias                          = $alias;
                $this->import_name                    = $import_name;
                $this->public_profile_link_attributes = $public_profile_link_attributes;
                $this->lng                            = $lng;
 
                $this->init();
        }

References $alias, $author_id, $display_id, $ilUser, $import_name, $lng, $public_profile_link_attributes, and init().

Here is the call graph for this function:

Member Function Documentation

◆ buildAuthorProfileLink()

ilForumAuthorInformation::buildAuthorProfileLink ( $with_profile_link = false )

protected

Parameters

bool $with_profile_link

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

        {
                $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;
        }

References $author_name, and $author_short_name.

Referenced by init().

Here is the caller graph for this function:

◆ doesAuthorAccountExists()

ilForumAuthorInformation::doesAuthorAccountExists ( )

protected

Returns: bool

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

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

References getAuthor().

Referenced by init(), and isAuthorAnonymous().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAnonymousImagePath()

ilForumAuthorInformation::getAnonymousImagePath ( )

protected

Returns: string

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

        {
                if (!ilContext::hasHTML()) {
                        return'';
                }
 
                return ilUtil::getImagePath('no_photo_xsmall.jpg');
        }

References ilUtil\getImagePath(), and ilContext\hasHTML().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAuthor()

ilForumAuthorInformation::getAuthor ( )

Returns: ilObjUser

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

        {
                return $this->author;
        }

References $author.

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

Here is the caller graph for this function:

◆ getAuthorName()

ilForumAuthorInformation::getAuthorName ( $without_short_name = false )

Parameters

bool $without_short_name

Returns: string

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

        {
                if(!$without_short_name)
                {
                        return $this->author_name;
                }
                else
                {
                        return trim(preg_replace('/\‍(' . $this->getAuthorShortName() . '\‍)/', '', $this->author_name));
                }
        }

References $author_name, and getAuthorShortName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAuthorShortName()

ilForumAuthorInformation::getAuthorShortName ( )

Returns: string

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

        {
                return $this->author_short_name;
        }

References $author_short_name.

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

Here is the caller graph for this function:

◆ getLinkedAuthorName()

ilForumAuthorInformation::getLinkedAuthorName ( )

Returns: string

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

        {
                return $this->linked_public_name;
        }

References $linked_public_name.

◆ getLinkedAuthorShortName()

ilForumAuthorInformation::getLinkedAuthorShortName ( )

Returns: string

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

        {
                return $this->linked_short_name;
        }

References $linked_short_name.

◆ getProfilePicture()

ilForumAuthorInformation::getProfilePicture ( )

Returns: string

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

        {
                return $this->profilePicture;
        }

References $profilePicture.

◆ getSuffix()

ilForumAuthorInformation::getSuffix ( )

Returns: string

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

        {
                return $this->suffix;
        }

References $suffix.

◆ getUserImagePath()

ilForumAuthorInformation::getUserImagePath ( \ilObjUser $user )

protected

Parameters

ilObjUser $user

Returns: string

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

        {
                if (!ilContext::hasHTML()) {
                        return'';
                }
 
                return $user->getPersonalPicturePath('xsmall');
        }

References ilObjUser\getPersonalPicturePath(), and ilContext\hasHTML().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSuffix()

ilForumAuthorInformation::hasSuffix ( )

Returns: bool

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

        {
                return strlen($this->suffix);
        }

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

Here is the caller graph for this function:

◆ init()

ilForumAuthorInformation::init ( )

protected

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

        {
                include_once 'Modules/Forum/classes/class.ilObjForumAccess.php';
 
                $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->getAnonymousImagePath();
                                }
 
                                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->getAnonymousImagePath();
                        }
                }
                else if($this->display_id > 0 && !$this->doesAuthorAccountExists() && strlen($this->alias))
                {
                        // The author does not use a pseudonym, but the id does not exist anymore (deleted, lost on import etc.)
                        // We have no import name,so we check the pseudonym  
                        $this->author_short_name = $this->author_name = $this->alias . ' (' . $translationLanguage->txt('deleted') . ')';
                        $this->suffix            = $translationLanguage->txt('deleted');
                        $this->buildAuthorProfileLink(false);
                        $this->profilePicture = $this->getAnonymousImagePath();
                }
                else if(strlen($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->getAnonymousImagePath();
                }
                else if(strlen($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->getAnonymousImagePath();
                }
                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->getAnonymousImagePath();
                }
        }

References $globalLng, $lng, buildAuthorProfileLink(), doesAuthorAccountExists(), getAnonymousImagePath(), getAuthor(), getUserImagePath(), initUserInstance(), isAuthorAnonymous(), and isCurrentUserSessionLoggedIn().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserInstance()

ilForumAuthorInformation::initUserInstance ( )

protected

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

        {
                if(is_numeric($this->display_id) && $this->display_id > 0)
                {
                        // Try to read user instance from preloaded cache array
                        $this->author = ilForumAuthorInformationCache::getUserObjectById($this->display_id);
                        if(!$this->author)
                        {
                                // Get a user instance from forum module's cache method
                                $this->author = ilObjForumAccess::getCachedUserInstance($this->display_id);
                        }
                }
 
                if(!$this->author)
                {
                        $this->author = new ilObjUser();
                        $this->author->setId(0);
                        $this->author->setPref('public_profile', 'n');
                        $this->author->setGender('');
                }
        }

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

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAuthorAnonymous()

ilForumAuthorInformation::isAuthorAnonymous ( )

protected

Returns: bool

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

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

References doesAuthorAccountExists(), and getAuthor().

Referenced by init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCurrentUserSessionLoggedIn()

ilForumAuthorInformation::isCurrentUserSessionLoggedIn ( )

protected

Returns: bool

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

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

Referenced by init().

Here is the caller graph for this function:

Field Documentation

◆ $alias

ilForumAuthorInformation::$alias

protected

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

Referenced by __construct().

◆ $author

ilForumAuthorInformation::$author

protected

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

Referenced by getAuthor().

◆ $author_id

ilForumAuthorInformation::$author_id

protected

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

Referenced by __construct().

◆ $author_name

ilForumAuthorInformation::$author_name

protected

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

Referenced by buildAuthorProfileLink(), and getAuthorName().

◆ $author_short_name

ilForumAuthorInformation::$author_short_name

protected

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

Referenced by buildAuthorProfileLink(), and getAuthorShortName().

◆ $display_id

ilForumAuthorInformation::$display_id

protected

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

Referenced by __construct().

◆ $files

ilForumAuthorInformation::$files = array()

protected

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

◆ $globalLng

ilForumAuthorInformation::$globalLng

protected

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

Referenced by init().

◆ $globalUser

ilForumAuthorInformation::$globalUser

protected

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

◆ $import_name

ilForumAuthorInformation::$import_name

protected

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

Referenced by __construct().

◆ $linked_public_name

ilForumAuthorInformation::$linked_public_name

protected

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

Referenced by getLinkedAuthorName().

◆ $linked_short_name

ilForumAuthorInformation::$linked_short_name

protected

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

Referenced by getLinkedAuthorShortName().

◆ $lng

ilForumAuthorInformation::$lng

protected

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

Referenced by __construct(), and init().

◆ $profilePicture

ilForumAuthorInformation::$profilePicture

protected

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

Referenced by getProfilePicture().

◆ $public_profile_link_attributes

ilForumAuthorInformation::$public_profile_link_attributes = array()

protected

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

Referenced by __construct().

◆ $suffix

ilForumAuthorInformation::$suffix = ''

protected

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

Referenced by getSuffix().

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

Modules/Forum/classes/class.ilForumAuthorInformation.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildAuthorProfileLink()

◆ doesAuthorAccountExists()

◆ getAnonymousImagePath()

◆ getAuthor()

◆ getAuthorName()

◆ getAuthorShortName()

◆ getLinkedAuthorName()

◆ getLinkedAuthorShortName()

◆ getProfilePicture()

◆ getSuffix()

◆ getUserImagePath()

◆ hasSuffix()

◆ init()

◆ initUserInstance()

◆ isAuthorAnonymous()

◆ isCurrentUserSessionLoggedIn()

Field Documentation

◆ $alias

◆ $author

◆ $author_id

◆ $author_name

◆ $author_short_name

◆ $display_id

◆ $files

◆ $globalLng

◆ $globalUser

◆ $import_name

◆ $linked_public_name

◆ $linked_short_name

◆ $lng

◆ $profilePicture

◆ $public_profile_link_attributes

◆ $suffix