ILIAS\User\Badges\ProfileBadge Class Reference

Inheritance diagram for ILIAS\User\Badges\ProfileBadge:

Collaboration diagram for ILIAS\User\Badges\ProfileBadge:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilSetting $setting, private readonly RequestInterface $request, private readonly Profile $profile)
	getId ()
	Get typ id (unique for component) More...
	getCaption ()
	isSingleton ()
	Can only be created once? More...
	getValidObjectTypes ()
	Get valid (repository) "parent" object types. More...
	getConfigGUIInstance ()
	Get GUI config instance. More...
	evaluate (int $user_id, array $params, ?array $config)
	Evaluate if given user has earned badge. More...
	getId ()
	Get typ id (unique for component) More...
	getCaption ()
	isSingleton ()
	Can only be created once? More...
	getValidObjectTypes ()
	Get valid (repository) "parent" object types. More...
	getConfigGUIInstance ()
	Get GUI config instance. More...
	evaluate (int $a_user_id, array $a_params, ?array $a_config)
	Evaluate if given user has earned badge. More...

Detailed Description

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 30 of file ProfileBadge.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Badges\ProfileBadge::__construct	(	private readonly Language	$lng,
		private readonly \ilSetting	$setting,
		private readonly RequestInterface	$request,
		private readonly Profile	$profile
	)

Definition at line 32 of file ProfileBadge.php.

      {
    }

Member Function Documentation

evaluate()

ILIAS\User\Badges\ProfileBadge::evaluate	(	int	$a_user_id,
		array	$a_params,
		?array	$a_config
	)

Evaluate if given user has earned badge.

Implements ilBadgeAuto.

Definition at line 68 of file ProfileBadge.php.

                                                                         : bool
    {
        $user = new \ilObjUser($user_id);
 
        if ($this->setting->get('user_portfolios') !== '1'
            || array_filter(
                \ilObjPortfolio::getPortfoliosOfUser($user_id),
                static fn(array $v): bool => $v['is_default'] === 1
            ) !== []) {
            // is profile public?
            if (!in_array($user->getPref('public_profile'), ['y', 'g'])) {
                return false;
            }
        }
 
        if ($config === null || !isset($config['profile'])) {
            return true;
        }
 
        foreach ($config['profile'] as $long_field_id) {
            $field_id = substr($long_field_id, 4);
            if (substr($field_id, 0, 4) === 'udf_') {
                $field_id = substr($field_id, 4);
            }
 
            $field = $this->profile->getFieldByIdentifier($field_id);
            if ($field === null) {
                continue;
            }
            if (!$field->isPublishedByUser($user)
                || empty($field->retrieveValueFromUser($user))) {
                return false;
            }
        }
 
        return true;
    }

References $user_id, ilObjPortfolio\getPortfoliosOfUser(), and ILIAS\Repository\profile().

Here is the call graph for this function:

getCaption()

ILIAS\User\Badges\ProfileBadge::getCaption

(

)

Implements ilBadgeType.

Definition at line 45 of file ProfileBadge.php.

                                : string
    {
        return $this->lng->txt('badge_user_profile');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getConfigGUIInstance()

ILIAS\User\Badges\ProfileBadge::getConfigGUIInstance

(

)

Get GUI config instance.

Implements ilBadgeType.

Definition at line 60 of file ProfileBadge.php.

                                          : ?\ilBadgeTypeGUI
    {
        return new ProfileBadgeGUI(
            $this->lng,
            $this->request
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getId()

ILIAS\User\Badges\ProfileBadge::getId

(

)

Get typ id (unique for component)

Implements ilBadgeType.

Definition at line 40 of file ProfileBadge.php.

                           : string
    {
        return 'profile';
    }

getValidObjectTypes()

ILIAS\User\Badges\ProfileBadge::getValidObjectTypes

(

)

Get valid (repository) "parent" object types.

Returns

string[]

Implements ilBadgeType.

Definition at line 55 of file ProfileBadge.php.

                                         : array // Missing array type.
    {
        return ['bdga'];
    }

isSingleton()

ILIAS\User\Badges\ProfileBadge::isSingleton

(

)

Can only be created once?

Implements ilBadgeType.

Definition at line 50 of file ProfileBadge.php.

                                 : bool
    {
        return false;
    }

---

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

• components/ILIAS/User/src/Badges/ProfileBadge.php