GUI class for public user profile presentation. More...

Inheritance diagram for ILIAS\User\Profile\PublicProfileGUI:

Collaboration diagram for ILIAS\User\Profile\PublicProfileGUI:

Public Member Functions
	setUserId (int $a_userid)

	getUserId ()

	setAdditional (array $a_additional)
	Set Additonal Information. More...

	getAdditional ()

	setBackUrl (string $backurl)
	Set Back Link URL. More...

	getBackUrl ()

	setCustomPrefs (array $a_prefs)
	Set custom preferences for public profile fields. More...

	setEmbedded (bool $a_value, bool $a_offline=false)

	executeCommand ()

	view ()
	View. More...

	getHTML ()

	getEmbeddable (bool $a_add_goto=false)
	get public profile html code Used in Personal Profile (as preview) and Portfolio (as page block) More...

	deliverVCard ()
	Deliver vcard information. More...

	renderTitle ()

Protected Member Functions
	getPublicPref (\ilObjUser $a_user, string $a_id)
	Get user preference for public profile. More...

	isProfilePublic ()

	validateUser (int $usrId)
	Check if given user id is valid. More...

	getProfilePortfolio ()
	Check if current profile portfolio is accessible. More...

	doProfileAutoComplete ()

	approveContactRequest ()

	ignoreContactRequest ()

Private Attributes
bool	$offline = false

GUIRequest	$profile_request

int	$userid = 0

string	$backurl = ''

array	$additional = []

bool	$embedded = false

array	$custom_prefs = []

ilObjUser	$current_user

Profile	$profile

ilSetting	$setting

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilRbacSystem	$rbac_system

Language	$lng

PublicUserProfileBadgesRenderer	$badges_renderer

Detailed Description

GUI class for public user profile presentation.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ILIAS\User\Profile\PublicProfileGUI: ilObjPortfolioGUI

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

Member Function Documentation

◆ approveContactRequest()

ILIAS\User\Profile\PublicProfileGUI::approveContactRequest ( )

protected

Definition at line 772 of file class.PublicProfileGUI.php.

                                              : void
    {
        $osd_id = $this->profile_request->getOsdId();
        if ($osd_id) {
            $this->ctrl->setParameterByClass('ilBuddySystemGUI', 'osd_id', $osd_id);
        }
        $this->ctrl->setParameterByClass('ilBuddySystemGUI', 'user_id', $this->getUserId());
        $this->ctrl->redirectByClass([self::class, 'ilBuddySystemGUI'], 'link');
    }

References ILIAS\Repository\ctrl(), and ILIAS\User\Profile\PublicProfileGUI\getUserId().

Here is the call graph for this function:

◆ deliverVCard()

ILIAS\User\Profile\PublicProfileGUI::deliverVCard ( )

Deliver vcard information.

Definition at line 581 of file class.PublicProfileGUI.php.

                                  : void
    {
        // get user object
        if (!\ilObject::_exists($this->getUserId())) {
            return;
        }
        $user = new \ilObjUser($this->getUserId());
 
        $vcard = new VCard();
 
        // ilsharedresourceGUI: embedded in shared portfolio
        if ($user->getPref('public_profile') != 'y' &&
            $user->getPref('public_profile') != 'g' &&
            strtolower($this->profile_request->getBaseClass()) != 'ilsharedresourcegui' &&
            $this->current_user->getId() != $this->getUserId()
        ) {
            return;
        }
 
        $vcard->setName($user->getLastname(), $user->getFirstname(), '', $user->getUTitle());
        $vcard->setNickname($user->getLogin());
 
        list($image, $type) = (new \ilUserAvatarResolver($this->getUserId()))->getUserPictureForVCard();
        if ($image !== null) {
            $vcard->setPhoto($image, $type);
        }
 
        $val_arr = [
            'getOrgUnitsRepresentation' => 'org_units', 'getInstitution' => 'institution',
            'getDepartment' => 'department', 'getStreet' => 'street',
            'getZipcode' => 'zipcode', 'getCity' => 'city', 'getCountry' => 'country',
            'getPhoneOffice' => 'phone_office', 'getPhoneHome' => 'phone_home',
            'getPhoneMobile' => 'phone_mobile', 'getFax' => 'fax', 'getEmail' => 'email',
            'getHobby' => 'hobby', 'getMatriculation' => 'matriculation',
            'getClientIP' => 'client_ip', 'dummy' => 'location'
        ];
 
        $org = [];
        $adr = [];
        foreach ($val_arr as $key => $value) {
            // if value 'y' show information
            if ($user->getPref('public_' . $value) == 'y') {
                switch ($value) {
                    case 'institution':
                        $org[0] = $user->$key();
                        break;
                    case 'department':
                        $org[1] = $user->$key();
                        break;
                    case 'street':
                        $adr[2] = $user->$key();
                        break;
                    case 'zipcode':
                        $adr[5] = $user->$key();
                        break;
                    case 'city':
                        $adr[3] = $user->$key();
                        break;
                    case 'country':
                        $adr[6] = $user->$key();
                        break;
                    case 'phone_office':
                        $vcard->setPhone($user->$key(), VCard::TEL_TYPE_WORK);
                        break;
                    case 'phone_home':
                        $vcard->setPhone($user->$key(), VCard::TEL_TYPE_HOME);
                        break;
                    case 'phone_mobile':
                        $vcard->setPhone($user->$key(), VCard::TEL_TYPE_CELL);
                        break;
                    case 'fax':
                        $vcard->setPhone($user->$key(), VCard::TEL_TYPE_FAX);
                        break;
                    case 'email':
                        $vcard->setEmail($user->$key());
                        break;
                    case 'hobby':
                        $vcard->setNote($user->$key());
                        break;
                    case 'location':
                        $vcard->setPosition($user->getLatitude(), $user->getLongitude());
                        break;
                }
            }
        }
 
        if (count($org)) {
            $vcard->setOrganization(implode(';', $org));
        }
        if (count($adr)) {
            $vcard->setAddress(
                $adr[0] ?? '',
                $adr[1] ?? '',
                $adr[2] ?? '',
                $adr[3] ?? '',
                $adr[4] ?? '',
                $adr[5] ?? '',
                $adr[6] ?? ''
            );
        }
 
        \ilUtil::deliverData($vcard->buildVCard(), $vcard->getFilename(), $vcard->getMimetype());
    }

References ilObject\_exists(), ilUtil\deliverData(), ILIAS\User\Profile\PublicProfileGUI\getUserId(), ILIAS\User\Profile\VCard\TEL_TYPE_CELL, ILIAS\User\Profile\VCard\TEL_TYPE_FAX, ILIAS\User\Profile\VCard\TEL_TYPE_HOME, and ILIAS\User\Profile\VCard\TEL_TYPE_WORK.

Here is the call graph for this function:

◆ doProfileAutoComplete()

ILIAS\User\Profile\PublicProfileGUI::doProfileAutoComplete ( )

protected

Definition at line 738 of file class.PublicProfileGUI.php.

                                              : void
    {
        $field_id = $this->profile_request->getFieldId();
        $term = $this->profile_request->getTerm();
 
        $result = [];
        $multi_fields = [
            'interests_general',
            'interests_help_offered',
            'interests_help_looking'
        ];
        if (in_array($field_id, $multi_fields) && $term) {
            // registration has no current user
            $user_id = null;
            if ($this->current_user->getId() !== 0 && $this->current_user->getId() !== ANONYMOUS_USER_ID) {
                $user_id = $this->current_user->getId();
            }
 
            $result = [];
            $cnt = 0;
 
            // term is searched in ALL interest fields, no distinction
            foreach (\ilObjUser::findInterests($term, $this->current_user->getId()) as $item) {
                $result[$cnt] = new stdClass();
                $result[$cnt]->value = $item;
                $result[$cnt]->label = $item;
                $cnt++;
            }
        }
 
        echo json_encode($result, JSON_THROW_ON_ERROR);
        exit();
    }

References $user_id, ANONYMOUS_USER_ID, exit, and ilObjUser\findInterests().

Here is the call graph for this function:

◆ executeCommand()

ILIAS\User\Profile\PublicProfileGUI::executeCommand ( )

Definition at line 159 of file class.PublicProfileGUI.php.

                                    : string
    {
        $ret = '';
        if (!$this->validateUser($this->getUserId())) {
            return '';
        }
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->tpl->loadStandardTemplate();
 
        switch ($next_class) {
            case strtolower(\ilBuddySystemGUI::class):
                $gui = new \ilBuddySystemGUI();
                $this->ctrl->setReturn($this, 'view');
                $this->ctrl->forwardCommand($gui);
                break;
            case strtolower(\ilObjPortfolioGUI::class):
                $portfolio_id = $this->getProfilePortfolio();
                if ($portfolio_id
                    && $cmd !== 'deliverVCard') {
                    $gui = new \ilObjPortfolioGUI($portfolio_id); // #11876
                    $gui->setAdditional($this->getAdditional());
                    $gui->setPermaLink($this->getUserId(), 'usr');
                    $this->ctrl->forwardCommand($gui);
                    break;
                }
                // no break
            default:
                $ret = $this->$cmd();
                $this->tpl->setContent($ret);
                break;
        }
 
        // only for direct links
        if (strtolower($this->profile_request->getBaseClass()) === strtolower(self::class)) {
            $this->tpl->printToStdout();
        }
        return (string) $ret;
    }

References ILIAS\Repository\ctrl(), ILIAS\User\Profile\PublicProfileGUI\getAdditional(), ILIAS\User\Profile\PublicProfileGUI\getProfilePortfolio(), ILIAS\User\Profile\PublicProfileGUI\getUserId(), and ILIAS\User\Profile\PublicProfileGUI\validateUser().

Here is the call graph for this function:

◆ getAdditional()

ILIAS\User\Profile\PublicProfileGUI::getAdditional ( )

Definition at line 108 of file class.PublicProfileGUI.php.

                                   : array
    {
        return $this->additional;
    }

References ILIAS\User\Profile\PublicProfileGUI\$additional.

Referenced by ILIAS\User\Profile\PublicProfileGUI\executeCommand(), and ILIAS\User\Profile\PublicProfileGUI\getEmbeddable().

Here is the caller graph for this function:

◆ getBackUrl()

ILIAS\User\Profile\PublicProfileGUI::getBackUrl ( )

Definition at line 128 of file class.PublicProfileGUI.php.

                                : string
    {
        return $this->backurl;
    }

References ILIAS\User\Profile\PublicProfileGUI\$backurl.

Referenced by ILIAS\User\Profile\PublicProfileGUI\getEmbeddable().

Here is the caller graph for this function:

◆ getEmbeddable()

ILIAS\User\Profile\PublicProfileGUI::getEmbeddable ( bool $a_add_goto = false )

get public profile html code Used in Personal Profile (as preview) and Portfolio (as page block)

Definition at line 260 of file class.PublicProfileGUI.php.

                                                           : string
    {
        $h = $v = '';
 
        // get user object
        if (!\ilObject::_exists($this->getUserId())) {
            return '';
        }
        $user = new \ilObjUser($this->getUserId());
 
        $tpl = new \ilTemplate(
            'tpl.usr_public_profile.html',
            true,
            true,
            'components/ILIAS/User'
        );
 
 
        $tpl->setVariable('ROWCOL1', 'tblrow1');
        $tpl->setVariable('ROWCOL2', 'tblrow2');
 
        if (!$this->offline && $this->current_user->getId() !== ANONYMOUS_USER_ID) {
            $ref_url = str_replace('&amp;', '&', $this->getBackUrl());
            if ($ref_url === '') {
                $ref_url = basename($_SERVER['REQUEST_URI']);
            }
 
            $mail_url = '';
            if ($this->rbac_system->checkAccess('internal_mail', \ilMailGlobalServices::getMailObjectRefId())) {
                $mail_url = \ilMailFormCall::getLinkTarget(
                    $ref_url,
                    '',
                    [],
                    [
                        'type' => 'new',
                        'rcp_to' => $user->getLogin()
                    ]
                );
            } elseif ($user->getPref('public_profile') === 'g'
                || !$this->current_user->isAnonymous()
                    && $user->getPref('public_profile') === 'y'
                    && $user->getPref('public_email')
                    && $user->getEmail() !== '') {
                $mail_url = 'mailto:' . $user->getEmail();
            }
 
            if ($mail_url !== '') {
                $tpl->setCurrentBlock('mail');
                $tpl->setVariable('TXT_MAIL', $this->lng->txt('send_mail'));
                $tpl->setVariable('HREF_MAIL', $mail_url);
                $tpl->parseCurrentBlock();
            }
        }
 
        if (!$this->isProfilePublic()) {
            $tpl->setVariable('TXT_NAME', $this->lng->txt('name'));
            $tpl->setVariable('FIRSTNAME', \ilUserUtil::getNamePresentation($user->getId()));
            return $tpl->get();
        }
 
        $first_name = '';
        if ($this->getPublicPref($user, 'public_title') === 'y') {
            $first_name .= $user->getUTitle() . ' ';
        }
        $first_name .= $user->getFirstname();
 
        if ($this->getPublicPref($user, 'public_gender') === 'y' && in_array($user->getGender(), ['m', 'f'])) {
            $tpl->setVariable(
                'SALUTATION',
                "{$this->lng->txt("salutation_{$user->getGender()}")} "
            );
        }
 
        $tpl->setVariable('TXT_NAME', $this->lng->txt('name'));
        $tpl->setVariable('FIRSTNAME', $first_name);
        $tpl->setVariable('LASTNAME', $user->getLastname());
 
        if ($user->getBirthday()
            && $this->getPublicPref($user, 'public_birthday') == 'y') {
            $tpl->setCurrentBlock('bday_bl');
            $tpl->setVariable('TXT_BIRTHDAY', $this->lng->txt('birthday'));
            $tpl->setVariable('VAL_BIRTHDAY', \ilDatePresentation::formatDate(new \ilDate($user->getBirthday(), IL_CAL_DATE)));
            $tpl->parseCurrentBlock();
        }
 
        if (!$this->offline) {
            $tpl->setCurrentBlock('vcard');
            $tpl->setVariable('TXT_VCARD', $this->lng->txt('vcard'));
            $tpl->setVariable('TXT_DOWNLOAD_VCARD', $this->lng->txt('vcard_download'));
            $this->ctrl->setParameter($this, 'user_id', $this->getUserId());
            $tpl->setVariable('HREF_VCARD', $this->ctrl->getLinkTarget($this, 'deliverVCard'));
        }
 
        $imagefile = \ilObjUser::_getPersonalPicturePath($user->getId(), 'big', false, true);
        if ($this->getPublicPref($user, 'public_upload') === 'y' && $imagefile !== ''
            && ($this->current_user->getId() !== ANONYMOUS_USER_ID || $user->getPref('public_profile') === 'g')) {
 
            $tpl->setCurrentBlock('image');
            $tpl->setVariable('TXT_IMAGE', $this->lng->txt('image'));
            $tpl->setVariable('IMAGE_PATH', $imagefile);
            $tpl->setVariable('IMAGE_ALT', $this->lng->txt('personal_picture'));
            $tpl->parseCurrentBlock();
        }
 
        // address
        if ($this->getPublicPref($user, 'public_street') == 'y' ||
            $this->getPublicPref($user, 'public_zipcode') == 'y' ||
            $this->getPublicPref($user, 'public_city') == 'y' ||
            $this->getPublicPref($user, 'public_country') == 'y') {
            $address = [];
            $val_arr = [
                'getStreet' => 'street',
                'getZipcode' => 'zipcode',
                'getCity' => 'city',
                'getCountry' => 'country',
                'getSelectedCountry' => 'sel_country'
            ];
            foreach ($val_arr as $key => $value) {
                // if value 'y' show information
                if ($this->getPublicPref($user, 'public_' . $value) == 'y') {
                    $address_value = $user->$key();
 
                    // only if set
                    if (trim($address_value) != '') {
                        switch ($value) {
                            case 'street':
                                $address[0] = $address_value;
                                break;
 
                            case 'zipcode':
                            case 'city':
                                $address[1] = isset($address[1])
                                    ? "{$address[1]} {$address_value}"
                                    : $address_value;
                                break;
 
                            case 'sel_country':
                                $this->lng->loadLanguageModule('meta');
                                $address[2] = $this->lng->txt('meta_c_' . $address_value);
                                break;
 
                            case 'country':
                                $address[2] = $address_value;
                                break;
                        }
                    }
                }
            }
            if ($address !== []) {
                $tpl->setCurrentBlock('address_line');
                foreach ($address as $line) {
                    if (trim($line)) {
                        $tpl->setVariable('TXT_ADDRESS_LINE', trim($line));
                        $tpl->parseCurrentBlock();
                    }
                }
                $tpl->setCurrentBlock('address');
                $tpl->setVariable('TXT_ADDRESS', $this->lng->txt('address'));
                $tpl->parseCurrentBlock();
            }
        }
 
        // if value 'y' show information
        if ($this->getPublicPref($user, 'public_org_units') === 'y') {
            $tpl->setCurrentBlock('org_units');
            $tpl->setVariable('TXT_ORG_UNITS', $this->lng->txt('objs_orgu'));
            $tpl->setVariable('ORG_UNITS', $user->getOrgUnitsRepresentation());
            $tpl->parseCurrentBlock();
        }
 
        if ($this->getPublicPref($user, 'public_institution') === 'y'
            || $this->getPublicPref($user, 'public_department') === 'y') {
            $tpl->setCurrentBlock('inst_dep');
            $sep = '';
            if ($this->getPublicPref($user, 'public_institution') === 'y') {
                $h = $this->lng->txt('institution');
                $v = $user->getInstitution();
                $sep = ' / ';
            }
            if ($this->getPublicPref($user, 'public_department') === 'y') {
                $h .= $sep . $this->lng->txt('department');
                $v .= $sep . $user->getDepartment();
            }
            $tpl->setVariable('TXT_INST_DEP', $h);
            $tpl->setVariable('INST_DEP', $v);
            $tpl->parseCurrentBlock();
        }
 
        // contact
        $val_arr = [
            'getPhoneOffice' => 'phone_office', 'getPhoneHome' => 'phone_home',
            'getPhoneMobile' => 'phone_mobile', 'getFax' => 'fax', 'getEmail' => 'email', 'getSecondEmail' => 'second_email'
        ];
        $v = $sep = '';
        foreach ($val_arr as $key => $value) {
            // if value 'y' show information
            if ($this->getPublicPref($user, 'public_' . $value) == 'y') {
                $v .= $sep . $this->lng->txt($value) . ': ' . $user->$key();
                $sep = '<br />';
            }
        }
        if ($v != '') {
            $tpl->parseCurrentBlock('contact');
            $tpl->setVariable('TXT_CONTACT', $this->lng->txt('contact'));
            $tpl->setVariable('CONTACT', $v);
            $tpl->parseCurrentBlock();
        }
 
 
        $val_arr = [
            'getHobby' => 'hobby',
            'getGeneralInterestsAsText' => 'interests_general',
            'getOfferingHelpAsText' => 'interests_help_offered',
            'getLookingForHelpAsText' => 'interests_help_looking',
            'getMatriculation' => 'matriculation',
            'getClientIP' => 'client_ip'
        ];
 
        foreach ($val_arr as $key => $value) {
            // if value 'y' show information
            if ($this->getPublicPref($user, 'public_' . $value) == 'y') {
                $tpl->setCurrentBlock('profile_data');
                $tpl->setVariable('TXT_DATA', $this->lng->txt($value));
                $tpl->setVariable('DATA', $user->$key());
                $tpl->parseCurrentBlock();
            }
        }
 
        // portfolios
        $back = ($this->getBackUrl() != '')
            ? $this->getBackUrl()
            : \ilLink::_getStaticLink($this->getUserId(), 'usr', true);
        $port = \ilObjPortfolio::getAvailablePortfolioLinksForUserIds(
            [$this->getUserId()],
            $back
        );
        $cnt = 0;
        if ($port !== []) {
            foreach ($port as $u) {
                $tpl->setCurrentBlock('portfolio');
                foreach ($u as $link => $title) {
                    $cnt++;
                    $tpl->setVariable('HREF_PORTFOLIO', $link);
                    $tpl->setVariable('TITLE_PORTFOLIO', $title);
                    $tpl->parseCurrentBlock();
                }
            }
            $tpl->setCurrentBlock('portfolios');
            if ($cnt > 1) {
                $this->lng->loadLanguageModule('prtf');
                $tpl->setVariable('TXT_PORTFOLIO', $this->lng->txt('prtf_portfolios'));
            } else {
                $tpl->setVariable('TXT_PORTFOLIO', $this->lng->txt('portfolio'));
            }
            $tpl->parseCurrentBlock();
        }
 
        // map
        if (\ilMapUtil::isActivated()
            && $this->getPublicPref($user, 'public_location') === 'y'
            && $user->getLatitude() != '') {
            $tpl->setVariable('TXT_LOCATION', $this->lng->txt('location'));
 
            $map_gui = \ilMapUtil::getMapGUI();
            $map_gui->setMapId('user_map_' . md5($user->login))
                    ->setWidth('350px')
                    ->setHeight('230px')
                    ->setLatitude($user->getLatitude())
                    ->setLongitude($user->getLongitude())
                    ->setZoom($user->getLocationZoom())
                    ->setEnableNavigationControl(true)
                    ->addUserMarker($user->getId());
 
            $tpl->setVariable('MAP_CONTENT', $map_gui->getHtml());
        }
 
        foreach ($this->profile->getVisibleUserDefinedFields(Context::User) as $field) {
            // public setting
            if ($this->getPublicPref($user, 'public_udf_' . $field->getIdentifier()) === 'y'
                && !empty(($value = $field->retrieveValueFromUser($user)))) {
                $tpl->setCurrentBlock('udf_data');
                $tpl->setVariable('TXT_UDF_DATA', $field->getLabel($this->lng));
                $tpl->setVariable('UDF_DATA', $value);
                $tpl->parseCurrentBlock();
            }
        }
 
        foreach ($this->getAdditional() as $key => $val) {
            $tpl->setCurrentBlock('profile_data');
            $tpl->setVariable('TXT_DATA', $key);
            $tpl->setVariable('DATA', $val);
            $tpl->parseCurrentBlock();
        }
 
        if ($this->getUserId() !== $this->current_user->getId()
            && !$this->current_user->isAnonymous()
            && !\ilObjUser::_isAnonymous($this->getUserId())) {
            $button = \ilBuddySystemLinkButton::getInstanceByUserId($user->getId());
            $tpl->setVariable('BUDDY_HTML', $button->getHtml());
        }
 
        //badge
        $tpl->setVariable('USER_BADGES', $this->badges_renderer->render($user->getId()));
 
        $goto = '';
        if ($a_add_goto) {
            $mtpl = $this->tpl;
 
            $mtpl->setPermanentLink(
                'usr',
                $user->getId(),
                '',
                '_top'
            );
        }
        return $tpl->get() . $goto;
    }

References $_SERVER, ILIAS\User\Profile\PublicProfileGUI\$tpl, ilObject\_exists(), ilObjUser\_getPersonalPicturePath(), ilLink\_getStaticLink(), ilObjUser\_isAnonymous(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ILIAS\UICore\GlobalTemplate\get(), ILIAS\User\Profile\PublicProfileGUI\getAdditional(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ILIAS\User\Profile\PublicProfileGUI\getBackUrl(), ilBuddySystemLinkButton\getInstanceByUserId(), ilMailFormCall\getLinkTarget(), ilMailGlobalServices\getMailObjectRefId(), ilMapUtil\getMapGUI(), ilUserUtil\getNamePresentation(), ILIAS\User\Profile\PublicProfileGUI\getPublicPref(), ILIAS\User\Profile\PublicProfileGUI\getUserId(), IL_CAL_DATE, ilMapUtil\isActivated(), ILIAS\User\Profile\PublicProfileGUI\isProfilePublic(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\Repository\profile(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setPermanentLink(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by ILIAS\User\Profile\PublicProfileGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ILIAS\User\Profile\PublicProfileGUI::getHTML ( )

Definition at line 218 of file class.PublicProfileGUI.php.

                             : string
    {
        if ($this->embedded) {
            return $this->getEmbeddable();
        }
 
        // #15438 - (currently) inactive user?
        $is_active = true;
        $user = new \ilObjUser($this->getUserId());
        if (!$user->getActive() ||
            !$user->checkTimeLimit()) {
            $is_active = false;
        }
 
        if ($is_active && $this->getProfilePortfolio()) {
            $this->ctrl->redirectByClass('ilobjportfoliogui', 'preview');
        }
 
        if (!$is_active) {
            \ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
        }
 
        $profile_public = $user->getPref('public_profile');
        if ($user->getPref('public_profile') === 'g' && !$this->setting->get('enable_global_profiles')) {
            $profile_public = 'y';
        }
 
        if ($profile_public !== 'y'
            && ($profile_public !== 'g' || !$this->setting->get('enable_global_profiles'))
            && !$this->custom_prefs) {
            \ilUtil::redirect('ilias.php?baseClass=ilDashboardGUI');
        }
 
        $this->renderTitle();
        return $this->getEmbeddable(true);
    }

References ILIAS\Repository\ctrl(), ILIAS\User\Profile\PublicProfileGUI\getEmbeddable(), ILIAS\User\Profile\PublicProfileGUI\getProfilePortfolio(), ILIAS\User\Profile\PublicProfileGUI\getUserId(), ilUtil\redirect(), and ILIAS\User\Profile\PublicProfileGUI\renderTitle().

Referenced by ILIAS\User\Profile\PublicProfileGUI\view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProfilePortfolio()

ILIAS\User\Profile\PublicProfileGUI::getProfilePortfolio ( )

protected

Check if current profile portfolio is accessible.

Definition at line 726 of file class.PublicProfileGUI.php.

                                            : ?int
    {
        $portfolio_id = \ilObjPortfolio::getDefaultPortfolio($this->getUserId());
        if ($portfolio_id) {
            $access_handler = new \ilPortfolioAccessHandler();
            if ($access_handler->checkAccess('read', '', $portfolio_id)) {
                return $portfolio_id;
            }
        }
        return null;
    }

References ilObjPortfolio\getDefaultPortfolio(), and ILIAS\User\Profile\PublicProfileGUI\getUserId().

Referenced by ILIAS\User\Profile\PublicProfileGUI\executeCommand(), and ILIAS\User\Profile\PublicProfileGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPublicPref()

ILIAS\User\Profile\PublicProfileGUI::getPublicPref	(	\ilObjUser	$a_user,
		string	$a_id
	)

protected

Get user preference for public profile.

Definition at line 144 of file class.PublicProfileGUI.php.

                                                                      : string
    {
        if (!$this->custom_prefs) {
            return (string) $a_user->getPref($a_id);
        } else {
            return (string) ($this->custom_prefs[$a_id] ?? '');
        }
    }

References ilObjUser\getPref().

Referenced by ILIAS\User\Profile\PublicProfileGUI\getEmbeddable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserId()

ILIAS\User\Profile\PublicProfileGUI::getUserId ( )

Definition at line 95 of file class.PublicProfileGUI.php.

                               : int
    {
        return $this->userid;
    }

References ILIAS\User\Profile\PublicProfileGUI\$userid.

Here is the caller graph for this function:

◆ ignoreContactRequest()

ILIAS\User\Profile\PublicProfileGUI::ignoreContactRequest ( )

protected

Definition at line 782 of file class.PublicProfileGUI.php.

                                             : void
    {
        $osd_id = $this->profile_request->getOsdId();
        if ($osd_id > 0) {
            $this->ctrl->setParameterByClass('ilBuddySystemGUI', 'osd_id', $osd_id);
        }
 
        $this->ctrl->setParameterByClass('ilBuddySystemGUI', 'user_id', $this->getUserId());
        $this->ctrl->redirectByClass([self::class, 'ilBuddySystemGUI'], 'ignore');
    }

References ILIAS\Repository\ctrl(), and ILIAS\User\Profile\PublicProfileGUI\getUserId().

Here is the call graph for this function:

◆ isProfilePublic()

ILIAS\User\Profile\PublicProfileGUI::isProfilePublic ( )

protected

Definition at line 208 of file class.PublicProfileGUI.php.

                                        : bool
    {
        $user = new \ilObjUser($this->getUserId());
        $current = $user->getPref('public_profile');
        if ($user->getPref('public_profile') === 'g' && !$this->setting->get('enable_global_profiles')) {
            $current = 'y';
        }
        return in_array($current, ['g', 'y']);
    }

References ILIAS\User\Profile\PublicProfileGUI\getUserId().

Referenced by ILIAS\User\Profile\PublicProfileGUI\getEmbeddable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderTitle()

ILIAS\User\Profile\PublicProfileGUI::renderTitle ( )

Definition at line 716 of file class.PublicProfileGUI.php.

                                 : void
    {
        $this->tpl->resetHeaderBlock();
        $this->tpl->setTitle(\ilUserUtil::getNamePresentation($this->getUserId()));
        $this->tpl->setTitleIcon(\ilObjUser::_getPersonalPicturePath($this->getUserId(), 'xsmall'));
    }

References ilObjUser\_getPersonalPicturePath(), ilUserUtil\getNamePresentation(), and ILIAS\User\Profile\PublicProfileGUI\getUserId().

Referenced by ILIAS\User\Profile\PublicProfileGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdditional()

ILIAS\User\Profile\PublicProfileGUI::setAdditional ( array $a_additional )

Set Additonal Information.

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

                                                      : void
    {
        $this->additional = $a_additional;
    }

◆ setBackUrl()

ILIAS\User\Profile\PublicProfileGUI::setBackUrl ( string $backurl )

Set Back Link URL.

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

                                               : void
    {
        // we only allow relative links
        $parts = parse_url($backurl);
        $host = $parts['host'] ?? '';
        if ($host !== '') {
            $backurl = '#';
        }
        $this->backurl = $backurl;
        $this->ctrl->setParameter($this, 'back_url', rawurlencode($backurl));
    }

References ILIAS\User\Profile\PublicProfileGUI\$backurl, $parts, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ setCustomPrefs()

ILIAS\User\Profile\PublicProfileGUI::setCustomPrefs ( array $a_prefs )

Set custom preferences for public profile fields.

Definition at line 136 of file class.PublicProfileGUI.php.

                                                  : void // Missing array type.
    {
        $this->custom_prefs = $a_prefs;
    }

◆ setEmbedded()

ILIAS\User\Profile\PublicProfileGUI::setEmbedded	(	bool	$a_value,
		bool	$a_offline = `false`
	)

Definition at line 153 of file class.PublicProfileGUI.php.

                                                                       : void
    {
        $this->embedded = $a_value;
        $this->offline = $a_offline;
    }

◆ setUserId()

ILIAS\User\Profile\PublicProfileGUI::setUserId ( int $a_userid )

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

                                            : void
    {
        $this->userid = $a_userid;
    }

◆ validateUser()

ILIAS\User\Profile\PublicProfileGUI::validateUser ( int $usrId )

protected

Check if given user id is valid.

Definition at line 688 of file class.PublicProfileGUI.php.

                                               : bool
    {
        if (\ilObject::_lookupType($usrId) != 'usr') {
            return false;
        }
 
        $user = new \ilObjUser($usrId);
 
        if ($this->current_user->isAnonymous()) {
            if (strtolower($this->ctrl->getCmd()) == strtolower('approveContactRequest')) {
                $this->ctrl->redirectToURL('login.php?cmd=force_login&target=usr_' . $usrId . '_contact_approved');
            } elseif (strtolower($this->ctrl->getCmd()) == strtolower('ignoreContactRequest')) {
                $this->ctrl->redirectToURL('login.php?cmd=force_login&target=usr_' . $usrId . '_contact_ignored');
            }
 
            if ($user->getPref('public_profile') != 'g') {
                // #12151
                if ($user->getPref('public_profile') == 'y') {
                    $this->ctrl->redirectToURL('login.php?cmd=force_login&target=usr_' . $usrId);
                }
 
                return false;
            }
        }
 
        return true;
    }

References ilObject\_lookupType(), and ILIAS\Repository\ctrl().

Referenced by ILIAS\User\Profile\PublicProfileGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ILIAS\User\Profile\PublicProfileGUI::view ( )

View.

This one is called e.g. through the goto script

Definition at line 203 of file class.PublicProfileGUI.php.

                          : string
    {
        return $this->getHTML();
    }

References ILIAS\User\Profile\PublicProfileGUI\getHTML().

Here is the call graph for this function:

Field Documentation

◆ $additional

array ILIAS\User\Profile\PublicProfileGUI::$additional = []

private

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

Referenced by ILIAS\User\Profile\PublicProfileGUI\getAdditional().

◆ $backurl

string ILIAS\User\Profile\PublicProfileGUI::$backurl = ''

private

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

Referenced by ILIAS\User\Profile\PublicProfileGUI\getBackUrl(), and ILIAS\User\Profile\PublicProfileGUI\setBackUrl().

◆ $badges_renderer

PublicUserProfileBadgesRenderer ILIAS\User\Profile\PublicProfileGUI::$badges_renderer

private

Definition at line 50 of file class.PublicProfileGUI.php.

◆ $ctrl

ilCtrl ILIAS\User\Profile\PublicProfileGUI::$ctrl

private

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

◆ $current_user

ilObjUser ILIAS\User\Profile\PublicProfileGUI::$current_user

private

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

◆ $custom_prefs

array ILIAS\User\Profile\PublicProfileGUI::$custom_prefs = []

private

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

◆ $embedded

bool ILIAS\User\Profile\PublicProfileGUI::$embedded = false

private

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

◆ $lng

Language ILIAS\User\Profile\PublicProfileGUI::$lng

private

Definition at line 49 of file class.PublicProfileGUI.php.

◆ $offline

bool ILIAS\User\Profile\PublicProfileGUI::$offline = false

private

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

◆ $profile

Profile ILIAS\User\Profile\PublicProfileGUI::$profile

private

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

◆ $profile_request

GUIRequest ILIAS\User\Profile\PublicProfileGUI::$profile_request

private

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

◆ $rbac_system

ilRbacSystem ILIAS\User\Profile\PublicProfileGUI::$rbac_system

private

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

◆ $setting

ilSetting ILIAS\User\Profile\PublicProfileGUI::$setting

private

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

◆ $tabs

ilTabsGUI ILIAS\User\Profile\PublicProfileGUI::$tabs

private

Definition at line 46 of file class.PublicProfileGUI.php.

◆ $tpl

ilGlobalTemplateInterface ILIAS\User\Profile\PublicProfileGUI::$tpl

private

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

Referenced by ILIAS\User\Profile\PublicProfileGUI\getEmbeddable().

◆ $userid

int ILIAS\User\Profile\PublicProfileGUI::$userid = 0

private

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

Referenced by ILIAS\User\Profile\PublicProfileGUI\getUserId().

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

components/ILIAS/User/src/Profile/class.PublicProfileGUI.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ approveContactRequest()

◆ deliverVCard()

◆ doProfileAutoComplete()

◆ executeCommand()

◆ getAdditional()

◆ getBackUrl()

◆ getEmbeddable()

◆ getHTML()

◆ getProfilePortfolio()

◆ getPublicPref()

◆ getUserId()

◆ ignoreContactRequest()

◆ isProfilePublic()

◆ renderTitle()

◆ setAdditional()

◆ setBackUrl()

◆ setCustomPrefs()

◆ setEmbedded()

◆ setUserId()

◆ validateUser()

◆ view()

Field Documentation

◆ $additional

◆ $backurl

◆ $badges_renderer

◆ $ctrl

◆ $current_user

◆ $custom_prefs

◆ $embedded

◆ $lng

◆ $offline

◆ $profile

◆ $profile_request

◆ $rbac_system

◆ $setting

◆ $tabs

◆ $tpl

◆ $userid