ilUserAvatarResolver Class Reference

Class ilUserAvatarResolver. More...

Collaboration diagram for ilUserAvatarResolver:

Public Member Functions
	__construct (private int $user_id)
	hasProfilePicture ()
	getAvatar (bool $name_as_set_as_text_closely=false)
	getUserPictureForVCard ()
	getLegacyPictureURL ()
	This method returns the URL to the Profile Picture of a User. More...
	setForcePicture (bool $force_image)
	There are places where we want wo show the Profile Picture of a User, even if the user doesn't want to show it. More...
	setSize (string $size)
	There are the Sizes 'big', 'small', 'xsmall', 'xxsmall',. More...

Private Member Functions
	readUserSettings ()
	resolveProfilePicturePath ()

Private Attributes
ilDBInterface	$db
ILIAS ResourceStorage Services	$irss
Factory	$ui
Language	$lng
bool	$letter_avatars_activated
ilUserProfilePictureDefinition	$flavour_definition
string	$size
bool	$is_current_user
ilObjUser	$for_user
bool	$has_public_upload = false
bool	$has_public_profile = false
ilUserAvatarFactory	$avatar_factory
string	$abbreviation = ''
string	$rid = null
bool	$force_image = false

Detailed Description

Class ilUserAvatarResolver.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilUserAvatarResolver::__construct

(

private int

$user_id

)

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

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

      {
        global $DIC;
        $this->is_current_user = $DIC->user()->getId() === $this->user_id;
        $this->for_user = $this->is_current_user ? $DIC->user() : new ilObjUser($this->user_id);

        $this->db = $DIC->database();
        $this->irss = $DIC->resourceStorage();
        $this->ui = $DIC->ui()->factory();
        $this->lng = $DIC->language();
        $this->avatar_factory = $DIC["user.avatar.factory"];

        $this->letter_avatars_activated = (bool) $DIC->settings()->get('letter_avatars');
        $this->flavour_definition = new ilUserProfilePictureDefinition();
        $this->size = 'small';
        $this->readUserSettings();
    }

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 134 of file class.ilUserAvatarResolver.php.

References ilUtil\getImagePath(), getLegacyPictureURL(), hasProfilePicture(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

                                                                        : Avatar
    {
        if ($name_as_set_as_text_closely) {
            $alternative_text = $this->lng->txt("user_avatar");
        } elseif ($this->is_current_user && !$this->for_user->isAnonymous()) {
            $alternative_text = $this->lng->txt("current_user_avatar");
        } else {
            $alternative_text = $this->lng->txt("user_avatar_of") . " " . $this->for_user->getLogin();
        }

        if ($this->hasProfilePicture()) {
            $picture = $this->getLegacyPictureURL();
            return $this->ui->symbol()->avatar()->picture(
                $picture,
                $this->for_user->getLogin()
            )->withLabel($alternative_text);
        }

        // Fallback Image
        if ($this->letter_avatars_activated === false) {
            return $this->ui->symbol()->avatar()->picture(
                \ilUtil::getImagePath('placeholder/no_photo_xsmall.jpg'),
                $this->for_user->getLogin()
            );
        }

        return $this->ui->symbol()->avatar()->letter($this->abbreviation)->withLabel($alternative_text);
    }

Here is the call graph for this function:

getLegacyPictureURL()

ilUserAvatarResolver::getLegacyPictureURL

(

)

This method returns the URL to the Profile Picture of a User.

Depending on Settings and the Availability of a Prodile Picture, there's a Fallback to the Letter Avatar as well (as data-URL).

Deprecated:

use getAvatar() instead

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

References hasProfilePicture(), null, and resolveProfilePicturePath().

Referenced by getAvatar().

                                         : string
    {
        if ($this->hasProfilePicture()
            && $this->rid !== null && $this->rid !== '-') {
            return $this->resolveProfilePicturePath();
        }

        // LETTER AVATAR
        $avatar = $this->avatar_factory->avatar($this->size);
        $avatar->setName($this->abbreviation);
        $avatar->setUsrId($this->user_id);

        return $avatar->getUrl();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserPictureForVCard()

ilUserAvatarResolver::getUserPictureForVCard

(

)

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

References $size, hasProfilePicture(), and null.

                                            : array
    {
        if (!$this->hasProfilePicture()) {
            return [null, null];
        }

        if ($this->rid !== null
            && $this->rid !== '-'
            && ($identification = $this->irss->manage()->find($this->rid)) !== null) {
            $flavour_streams = $this->irss->flavours()
                ->get($identification, $this->flavour_definition)
                ->getStreamResolvers();
            $available_sizes = array_flip(array_keys($this->flavour_definition->getSizes()));
            $size_index = $available_sizes[$this->size];
            if (!isset($flavour_streams[$size_index])) {
                return [null, null];
            }
            return [$flavour_streams[$size_index]->getStream()->__toString(), 'image/jpeg'];
        }

        return [null, null];
    }

Here is the call graph for this function:

hasProfilePicture()

ilUserAvatarResolver::hasProfilePicture

(

)

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

References null.

Referenced by getAvatar(), getLegacyPictureURL(), and getUserPictureForVCard().

                                       : bool
    {
        if (!$this->force_image) {
            if (!$this->has_public_profile || !$this->has_public_upload) {
                return false;
            }
        }

        if ($this->rid !== null && $this->irss->manage()->find($this->rid) !== null) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

readUserSettings()

ilUserAvatarResolver::readUserSettings ( )

private

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

References $res, null, and ilStr\subStr().

Referenced by __construct().

                                       : void
    {
        $in = $this->db->in('usr_pref.keyword', ['public_upload', 'public_profile'], false, 'text');
        $res = $this->db->queryF(
            "
                        SELECT usr_data.rid, usr_pref.*
                        FROM usr_data LEFT JOIN usr_pref ON usr_pref.usr_id = usr_data.usr_id AND $in
                        WHERE usr_data.usr_id = %s",
            ['integer'],
            [$this->user_id]
        );

        while ($row = $this->db->fetchAssoc($res)) { // MUST be loop
            $this->rid = $row['rid'] ?? null;
            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;
            }
        }

        if ($this->has_public_profile) {
            $sub_str_firstname = ilStr::subStr($this->for_user->getFirstname(), 0, 1);
            $sub_str_lastname = ilStr::subStr($this->for_user->getLastname(), 0, 1);
            $this->abbreviation = $sub_str_firstname . $sub_str_lastname;
        } else {
            $this->abbreviation = ilStr::subStr($this->for_user->getLogin(), 0, 2);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resolveProfilePicturePath()

ilUserAvatarResolver::resolveProfilePicturePath ( )

private

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

References $size, and null.

Referenced by getLegacyPictureURL().

                                                : string
    {
        $rid = $this->irss->manage()->find($this->rid);
        if ($rid === null) {
            return '';
        }
        $flavour = $this->irss->flavours()->get($rid, $this->flavour_definition);
        $urls = $this->irss->consume()->flavourUrls($flavour)->getURLsAsArray(false);

        $available_sizes = array_flip(array_keys($this->flavour_definition->getSizes()));
        $size_index = $available_sizes[$this->size];

        return $urls[$size_index] ?? '';
    }

Here is the caller graph for this function:

setForcePicture()

ilUserAvatarResolver::setForcePicture

(

bool

$force_image

)

There are places where we want wo show the Profile Picture of a User, even if the user doesn't want to show it.

(e.g. in Administration)

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

References $force_image.

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

setSize()

ilUserAvatarResolver::setSize

(

string

$size

)

There are the Sizes 'big', 'small', 'xsmall', 'xxsmall',.

See also

ilUserProfilePictureDefinition

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

References $size.

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

Field Documentation

$abbreviation

string ilUserAvatarResolver::$abbreviation = ''

private

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

$avatar_factory

ilUserAvatarFactory ilUserAvatarResolver::$avatar_factory

private

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

$db

ilDBInterface ilUserAvatarResolver::$db

private

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

$flavour_definition

ilUserProfilePictureDefinition ilUserAvatarResolver::$flavour_definition

private

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

$for_user

ilObjUser ilUserAvatarResolver::$for_user

private

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

$force_image

bool ilUserAvatarResolver::$force_image = false

private

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

Referenced by setForcePicture().

$has_public_profile

bool ilUserAvatarResolver::$has_public_profile = false

private

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

$has_public_upload

bool ilUserAvatarResolver::$has_public_upload = false

private

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

$irss

ILIAS ResourceStorage Services ilUserAvatarResolver::$irss

private

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

$is_current_user

bool ilUserAvatarResolver::$is_current_user

private

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

$letter_avatars_activated

bool ilUserAvatarResolver::$letter_avatars_activated

private

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

$lng

Language ilUserAvatarResolver::$lng

private

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

$rid

string ilUserAvatarResolver::$rid = null

private

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

$size

string ilUserAvatarResolver::$size

private

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

Referenced by getUserPictureForVCard(), resolveProfilePicturePath(), and setSize().

$ui

Factory ilUserAvatarResolver::$ui

private

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

---

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

• components/ILIAS/User/classes/Avatar/class.ilUserAvatarResolver.php