ilUserUtil Class Reference

Class ilUserUtil. More...

Collaboration diagram for ilUserUtil:

Static Public Member Functions
static	getNamePresentation ( $a_user_id, bool $a_user_image=false, bool $a_profile_link=false, string $a_profile_back_link='', bool $a_force_first_lastname=false, bool $a_omit_login=false, bool $a_sortable=true, bool $a_return_data_array=false, $a_ctrl_path=null)
	Default behaviour is: More...
static	hasPublicProfile (int $a_user_id)
static	getProfileLink (int $a_usr_id)
	Get link to personal profile Return empty string in case of not public profile. More...
static	getStartingPointAsUrl ()

Detailed Description

Class ilUserUtil.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

getNamePresentation()

static ilUserUtil::getNamePresentation (   $a_user_id, bool  $a_user_image = false, bool  $a_profile_link = false, string  $a_profile_back_link = '', bool  $a_force_first_lastname = false, bool  $a_omit_login = false, bool  $a_sortable = true, bool  $a_return_data_array = false,   $a_ctrl_path = null  )

static

Default behaviour is:

• lastname, firstname if public profile enabled
• [loginname] (always) modifications by jposselt at databay . de : if $a_user_id is an array of user ids the method returns an array of 'id' => 'NamePresentation' pairs.

  Parameters

  int | int[]	$a_user_id
  string | array	$a_ctrl_path

  Returns

  array|false|mixed

  Exceptions

  ilWACException

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

      {
        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilDB = $DIC['ilDB'];
 
        if ($a_ctrl_path === null) {
            $a_ctrl_path = strtolower(PublicProfileGUI::class);
        }
 
        if (!is_array($a_ctrl_path)) {
            $a_ctrl_path = [$a_ctrl_path];
        }
 
        if (!($return_as_array = is_array($a_user_id))) {
            $a_user_id = [$a_user_id];
        }
 
        $sql = 'SELECT
                                        a.usr_id,
                                        firstname,
                                        lastname,
                                        title,
                                        login,
                                        b.value public_profile,
                                        c.value public_title
                                FROM
                                        usr_data a
                                        LEFT JOIN
                                                usr_pref b ON
                                                        (a.usr_id = b.usr_id AND
                                                        b.keyword = %s)
                                        LEFT JOIN
                                                usr_pref c ON
                                                        (a.usr_id = c.usr_id AND
                                                        c.keyword = %s)
                                WHERE ' . $ilDB->in('a.usr_id', $a_user_id, false, 'integer');
 
        $userrow = $ilDB->queryF($sql, ['text', 'text'], ['public_profile', 'public_title']);
 
        $names = [];
 
        $data = [];
        while ($row = $ilDB->fetchObject($userrow)) {
            $pres = '';
            $d = [
                'id' => (int) $row->usr_id,
                'title' => '',
                'lastname' => '',
                'firstname' => '',
                'img' => '',
                'link' => ''
            ];
            $has_public_profile = in_array($row->public_profile, ['y', 'g']);
            if ($a_force_first_lastname || $has_public_profile) {
                $title = '';
                if ($row->public_title == 'y' && $row->title) {
                    $title = $row->title . ' ';
                }
                $d['title'] = $title;
                if ($a_sortable) {
                    $pres = $row->lastname;
                    if (strlen($row->firstname)) {
                        $pres .= (', ' . $row->firstname . ' ');
                    }
                } else {
                    $pres = $title;
                    if (strlen($row->firstname)) {
                        $pres .= $row->firstname . ' ';
                    }
                    $pres .= ($row->lastname . ' ');
                }
                $d['firstname'] = $row->firstname;
                $d['lastname'] = $row->lastname;
            }
            $d['login'] = $row->login;
            $d['public_profile'] = $has_public_profile;
 
 
            if (!$a_omit_login) {
                $pres .= '[' . $row->login . ']';
            }
 
            if ($a_profile_link && $has_public_profile) {
                $ilCtrl->setParameterByClass(end($a_ctrl_path), 'user_id', $row->usr_id);
                if ($a_profile_back_link != '') {
                    $ilCtrl->setParameterByClass(
                        end($a_ctrl_path),
                        'back_url',
                        rawurlencode($a_profile_back_link)
                    );
                }
                $link = $ilCtrl->getLinkTargetByClass($a_ctrl_path, 'getHTML');
                $pres = '<a href="' . $link . '">' . $pres . '</a>';
                $d['link'] = $link;
            }
 
            if ($a_user_image) {
                $img = ilObjUser::_getPersonalPicturePath($row->usr_id, 'xxsmall');
                $pres = '<img class="ilUserXXSmall" src="' . $img . '" alt="' . $lng->txt('icon') .
                    ' ' . $lng->txt('user_picture') . '" /> ' . $pres;
                $d['img'] = $img;
            }
 
            $names[$row->usr_id] = $pres;
            $data[$row->usr_id] = $d;
        }
 
        foreach ($a_user_id as $id) {
            if (!isset($names[$id])) {
                $names[$id] = $lng->txt('deleted_user');
            }
            if ($names[$id] === '') {
                $names[$id] = $lng->txt('usr_name_undisclosed');
            }
        }
 
        if ($a_return_data_array) {
            if ($return_as_array) {
                return $data;
            } else {
                return current($data);
            }
        }
        return $return_as_array ? $names : $names[$a_user_id[0]];
    }

References Vendor\Package\$d, $data, $DIC, $id, $ilDB, $lng, ilObjUser\_getPersonalPicturePath(), and ILIAS\Repository\int().

Referenced by ilSurveyAppraiseesTableGUI\__construct(), ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ILIAS\Mail\Placeholder\MailSignatureUserFullnamePlaceholder\addPlaceholder(), ILIAS\Portfolio\Notification\SharedNotification\appendObjectInformation(), ILIAS\Test\Logging\AdditionalInformationGenerator\buildListOfUsers(), ilExSubmissionTeamGUI\buildSubmissionPropertiesAndActions(), ILIAS\Blog\Contributor\ContributorRetrieval\collectData(), ilMDCopyrightUsageTableGUI\collectData(), ilGroupAddToGroupActionGUI\confirmAddUser(), ilSurveyParticipantsGUI\confirmAdminAppraiseesCloseObject(), ilGroupAddToGroupActionGUI\confirmCreateGroupAndAddUser(), ilBadgeManagementGUI\confirmDeassignBadge(), ilExerciseManagementGUI\confirmDeassignMembersObject(), ilSurveyParticipantsGUI\confirmDeleteAppraiseesObject(), ilMailingListsGUI\confirmDeleteMembers(), ilSurveyParticipantsGUI\confirmDeleteRatersObject(), ilConsultationHoursGUI\confirmRejectBooking(), ilExerciseManagementGUI\createTeamsFromGroupsObject(), ilContSkillAdminGUI\deassignCompetencesConfirm(), ILIAS\Survey\Execution\LaunchGUI\determineMainLink(), ilSharedResourceGUI\executeCommand(), ilBookingReservationsTableGUI\fillRow(), ilPageHistoryTableGUI\fillRow(), ilExAssignmentListTextTableGUI\fillRow(), ilHistoryTableGUI\fillRow(), ilWorkspaceShareTableGUI\fillRow(), ilUserForTagTableGUI\fillRow(), ilWikiPagesTableGUI\fillRow(), ilWikiRecentChangesTableGUI\fillRow(), ILIAS\Cron\Job\Manager\UI\JobTable\formatResultInfo(), ILIAS\Cron\Job\Manager\UI\JobTable\formatStatusInfo(), ilExSubmissionTeamGUI\getAdoptForm(), ILIAS\Skill\Table\ProfileUserAssignmentTable\getAssignmentTitle(), ILIAS\OnScreenChat\Repository\Subscriber\getDataByUserIds(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ilExAssignmentTeamTableGUI\getItems(), ilMessageGUI\getItemTitle(), ilNoteGUI\getItemTitle(), ilLMPageObjectGUI\getLinkXML(), ilPageLinker\getLinkXML(), ILIAS\Awareness\WidgetManager\getListData(), ilLearningModuleNotification\getMailBody(), ILIAS\Repository\Profile\ProfileGUI\getNamePresentation(), ilWikiPagesTableGUI\getPages(), ilExPeerReviewGUI\getPeerReviewReceiverPanel(), ilAbstractUsersGalleryCollectionProvider\getPopulatedGroup(), ilExPeerReviewGUI\getReceivedFeedbackPanel(), ilDclBaseRecordModel\getStandardFieldHTML(), ILIAS\Notifications\Provider\AwarenessToastProvider\getToasts(), ilAppointmentPresentationGUI\getUserName(), ilMailUserHelper\getUsernameMapForIds(), ilInternalLinkGUI\getUserSearchResult(), ILIAS\Blog\News\NewsManager\handle(), ilWorkspaceAccessTableGUI\importData(), ilCalendarCategoryGUI\initFormCategory(), ilExerciseManagementGUI\initGroupForm(), ILIAS\Contact\MailingLists\MailingListsMembersTable\initRecords(), ilBookingPreferencesGUI\listBookingResults(), ilExAssignmentListTextTableGUI\parse(), ilConsultationHourBookingTableGUI\parse(), ilWikiPageGUI\preview(), ilContSkillAdminGUI\publishAssignments(), ilNewsTimelineItemGUI\render(), ilLikeGUI\renderModal(), ILIAS\User\Profile\PublicProfileGUI\renderTitle(), ilBuddySystemNotification\send(), ilDataCollectionMailNotification\send(), ilLMMailNotification\send(), ilMStShowUserGUI\setTitleAndIcon(), ilChatroomBanGUI\show(), ilPageObjectGUI\showEditLockInfo(), ilPageObjectGUI\showPage(), ilExAssignmentPeerReviewOverviewTableGUI\translateUserIds(), and ilPageObject\update().

Here is the call graph for this function:

Here is the caller graph for this function:

getProfileLink()

static ilUserUtil::getProfileLink ( int  $a_usr_id )

static

Get link to personal profile Return empty string in case of not public profile.

Definition at line 198 of file class.ilUserUtil.php.

                                                        : string
    {
        global $DIC;
        $ctrl = $DIC['ilCtrl'];
 
        $public_profile = ilObjUser::_lookupPref($a_usr_id, 'public_profile');
        if ($public_profile != 'y' and $public_profile != 'g') {
            return '';
        }
 
        $ctrl->setParameterByClass(PublicProfileGUI::class, 'user', $a_usr_id);
        return $ctrl->getLinkTargetByClass(PublicProfileGUI::class, 'getHTML');
    }

References $DIC, and ilObjUser\_lookupPref().

Referenced by ilMDCopyrightUsageTableGUI\collectData(), ilRepositoryUserResultTableGUI\fillRow(), and ILIAS\Calendar\ConsultationHours\BookingDataProvider\read().

Here is the call graph for this function:

Here is the caller graph for this function:

getStartingPointAsUrl()

static ilUserUtil::getStartingPointAsUrl ( )

static

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

                                                  : string
    {
        return LocalDIC::dic()[StartingPointRepository::class]->getValidAndAccessibleStartingPointAsUrl();
    }

Referenced by ilAdministrationGUI\executeCommand(), ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\StandardPagePartProvider\getStartingPointAsUrl(), ILIAS\StaticURL\Handler\LegacyGotoHandler\handle(), ilInitialisation\redirectToStartingPage(), and ilStartUpGUI\showLogout().

Here is the caller graph for this function:

hasPublicProfile()

static ilUserUtil::hasPublicProfile ( int  $a_user_id )

static

Definition at line 178 of file class.ilUserUtil.php.

                                                           : bool
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $set = $ilDB->query(
            'SELECT value FROM usr_pref ' .
            ' WHERE usr_id = ' . $ilDB->quote($a_user_id, 'integer') .
            ' and keyword = ' . $ilDB->quote('public_profile', 'text')
        );
        $rec = $ilDB->fetchAssoc($set);
 
        return in_array($rec['value'] ?? '', ['y', 'g']);
    }

References $DIC, and $ilDB.

Referenced by ilLMPageObjectGUI\getLinkXML(), and ilPageLinker\getLinkXML().

Here is the caller graph for this function:

---

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

• components/ILIAS/User/classes/class.ilUserUtil.php