Collaboration diagram for ilUserAvatarResolver:

Public Member Functions
	__construct (int $user_id)

	getAvatar (bool $name_as_set_as_text_closely=false)

	setForcePicture (bool $force_image)

	setSize (string $size)

Protected Attributes
ilObjUser	$user

ilLanguage	$lng

ilDBInterface	$db

Factory	$ui

bool	$letter_avatars_activated

Private Member Functions
	init ()

	useUploadedFile ()

Private Attributes
int	$user_id = 0

string	$login = ""

string	$firstname = ""

string	$lastname = ""

bool	$has_public_profile = false

bool	$has_public_upload = false

string	$uploaded_file = ""

string	$abbreviation = ""

bool	$force_image = false

string	$size = 'small'

Detailed Description

Class ilUserAvatarResolver.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 26 of file class.ilUserAvatarResolver.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserAvatarResolver::__construct ( int $user_id )

Definition at line 44 of file class.ilUserAvatarResolver.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->ui = $DIC->ui()->factory();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->user_id = $user_id;
        $this->letter_avatars_activated = (bool) $DIC->settings()->get('letter_avatars');
        $this->init();
    }

References $DIC, $user_id, init(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ getAvatar()

ilUserAvatarResolver::getAvatar ( bool $name_as_set_as_text_closely = false )

Parameters

bool $name_as_set_as_text_closely if the name is set as text close to the Avatar, the alternative text for screenreaders will be set differently, to reduce redundancy for screenreaders. See rules on the Avatar Symbol in the UI Components

Definition at line 111 of file class.ilUserAvatarResolver.php.

                                                                        : Avatar
    {
        if ($name_as_set_as_text_closely) {
            $alternative_text = $this->lng->txt("user_avatar");
        } elseif ($this->user_id == $this->user->getId() && !$this->user::_isAnonymous($this->user_id)) {
            $alternative_text = $this->lng->txt("current_user_avatar");
        } else {
            $alternative_text = $this->lng->txt("user_avatar_of") . " " . $this->login;
        }
 
        if ($this->useUploadedFile()) {
            $picture = ilWACSignedPath::signFile($this->uploaded_file);
            return $this->ui->symbol()->avatar()->picture($picture, $this->login)
                            ->withLabel($alternative_text);
        }
 
        if ($this->letter_avatars_activated === false) {
            return $this->ui->symbol()->avatar()->picture(
                \ilUtil::getImagePath('no_photo_xsmall.jpg'),
                ilObjUser::_lookupLogin($this->user_id)
            );
        }
 
        return $this->ui->symbol()->avatar()->letter($this->abbreviation)->withLabel($alternative_text);
    }

References $login, ilObjUser\_lookupLogin(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ILIAS\UI\examples\Symbol\Glyph\Login\login(), ilWACSignedPath\signFile(), ILIAS\Repository\ui(), ILIAS\Repository\user(), and useUploadedFile().

Here is the call graph for this function:

◆ init()

ilUserAvatarResolver::init ( )

private

Definition at line 57 of file class.ilUserAvatarResolver.php.

                           : void
    {
        $in = $this->db->in('usr_pref.keyword', array('public_upload', 'public_profile'), false, 'text');
        $res = $this->db->queryF(
            "
                        SELECT usr_pref.*, ud.login, ud.firstname, ud.lastname
                        FROM usr_data ud LEFT JOIN usr_pref ON usr_pref.usr_id = ud.usr_id AND $in
                        WHERE ud.usr_id = %s",
            array('integer'),
            array($this->user_id)
        );
 
        while ($row = $this->db->fetchAssoc($res)) { // MUST be loop
            $this->login = $row['login'] ?? '';
            $this->firstname = $row['firstname'] ?? '';
            $this->lastname = $row['lastname'] ?? '';
 
            switch ($row['keyword']) {
                case 'public_upload':
                    $this->has_public_upload = $row['value'] === 'y';
                    break;
                case 'public_profile':
                    $this->has_public_profile = ($row['value'] === 'y' || $row['value'] === 'g');
                    break;
            }
        }
 
        // Uploaded file
        $webspace_dir = '';
        if (defined('ILIAS_MODULE')) {
            $webspace_dir = ('.' . $webspace_dir);
        }
        $webspace_dir .= ('./' . ltrim(ilFileUtils::getWebspaceDir(), "./"));
 
        $image_dir = $webspace_dir . '/usr_images';
        $this->uploaded_file = $image_dir . '/usr_' . $this->user_id . '.jpg';
 
        if ($this->has_public_profile) {
            $this->abbreviation = ilStr::subStr($this->firstname, 0, 1) . ilStr::subStr($this->lastname, 0, 1);
        } else {
            $this->abbreviation = ilStr::subStr($this->login, 0, 2);
        }
    }

References $res, ilFileUtils\getWebspaceDir(), ILIAS\UI\examples\Symbol\Glyph\Login\login(), and ilStr\subStr().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setForcePicture()

ilUserAvatarResolver::setForcePicture ( bool $force_image )

Definition at line 152 of file class.ilUserAvatarResolver.php.

                                                      : void
    {
        $this->force_image = $force_image;
    }

References $force_image.

◆ setSize()

ilUserAvatarResolver::setSize ( string $size )

Definition at line 157 of file class.ilUserAvatarResolver.php.

                                         : void
    {
        if ($size === 'small' || $size === 'big') {
            $size = 'xsmall';
        }
 
        $this->size = $size;
    }

References $size.

◆ useUploadedFile()

ilUserAvatarResolver::useUploadedFile ( )

private

Definition at line 101 of file class.ilUserAvatarResolver.php.

                                      : bool
    {
        return (($this->has_public_upload && $this->has_public_profile) || $this->force_image) && is_file($this->uploaded_file);
    }

Referenced by getAvatar().

Here is the caller graph for this function: