ilUserProfileBadge Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUserProfileBadge:

Collaboration diagram for ilUserProfileBadge:

Public Member Functions
	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...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUserProfileBadge

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 25 of file class.ilUserProfileBadge.php.

Member Function Documentation

evaluate()

ilUserProfileBadge::evaluate	(	int	$a_user_id,
		array	$a_params,
		?array	$a_config
	)

Evaluate if given user has earned badge.

Implements ilBadgeAuto.

Definition at line 55 of file class.ilUserProfileBadge.php.

References $DIC, $ilSetting, and ilObjPortfolio\getDefaultPortfolio().

                                                                         : bool // Missing array type.
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];

        $user = new ilObjUser($user_id);

        // active profile portfolio?
        $has_prtf = false;
        if ($ilSetting->get('user_portfolios')) {
            $has_prtf = ilObjPortfolio::getDefaultPortfolio($user_id);
        }

        if (!$has_prtf) {
            // is profile public?
            if (!in_array($user->getPref('public_profile'), ['y', 'g'])) {
                return false;
            }
        }

        // use getter mapping from user profile
        $up = new ilUserProfile();
        $pfields = $up->getStandardFields();

        // check for value AND publication status

        if ($config !== null && isset($config['profile'])) {
            foreach ($config['profile'] as $field) {
                $field = substr($field, 4);

                if (substr($field, 0, 4) === 'udf_') {
                    $udf_field_id = substr($field, 4);
                    if ($user->getPref('public_udf_' . $udf_field_id) !== 'y') {
                        return false;
                    }
                    $udf = $user->getUserDefinedData();
                    if ($udf['f_' . $udf_field_id] == '') {
                        return false;
                    }
                } else {
                    if ($user->getPref('public_' . $field) !== 'y') {
                        return false;
                    }

                    if ($field === 'upload') {
                        if (!$user->hasProfilePicture()) {
                            return false;
                        }
                    } elseif (isset($pfields[$field]['method'])) {
                        // use profile mapping if possible
                        $m = $pfields[$field]['method'];
                        if (!$user->{$m}()) {
                            return false;
                        }
                    }
                }
            }
        }

        return true;
    }

Here is the call graph for this function:

getCaption()

ilUserProfileBadge::getCaption

(

)

Implements ilBadgeType.

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

References $DIC, and $lng.

                                : string
    {
        global $DIC;

        $lng = $DIC['lng'];
        return $lng->txt('badge_user_profile');
    }

getConfigGUIInstance()

ilUserProfileBadge::getConfigGUIInstance

(

)

Get GUI config instance.

Implements ilBadgeType.

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

                                          : ?ilBadgeTypeGUI
    {
        return new ilUserProfileBadgeGUI();
    }

getId()

ilUserProfileBadge::getId

(

)

Get typ id (unique for component)

Implements ilBadgeType.

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

                           : string
    {
        return 'profile';
    }

getValidObjectTypes()

ilUserProfileBadge::getValidObjectTypes

(

)

Get valid (repository) "parent" object types.

Returns

string[]

Implements ilBadgeType.

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

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

isSingleton()

ilUserProfileBadge::isSingleton

(

)

Can only be created once?

Implements ilBadgeType.

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

                                 : bool
    {
        return false;
    }

---

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

• components/ILIAS/User/classes/Badges/class.ilUserProfileBadge.php