ilMailMemberSearchDataProvider Class Reference

Class ilMailMemberSearchDataProvider. More...

Collaboration diagram for ilMailMemberSearchDataProvider:

Public Member Functions
	__construct (protected ilParticipants $objParticipants, protected int $ref_id)
	getData ()

Protected Attributes
ilAccessHandler	$access
string	$type = 'crs'
array	$data = []
ilObjectDataCache	$dataCache
array	$roleSortWeightMap
array ilLanguage	$lng

Private Member Functions
	collectTableData ()
	sortRoles (array $roleTitles)
	buildRoleTitle (string $role)

Detailed Description

Class ilMailMemberSearchDataProvider.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 25 of file class.ilMailMemberSearchDataProvider.php.

Constructor & Destructor Documentation

__construct()

ilMailMemberSearchDataProvider::__construct	(	protected ilParticipants	$objParticipants,
		protected int	$ref_id
	)

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

References $DIC, ILIAS\Repository\access(), collectTableData(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->dataCache = $DIC['ilObjDataCache'];
        $this->access = $DIC->access();
        $this->type = $this->objParticipants->getType();
        $this->lng = $DIC['lng'];

        $this->collectTableData();
    }

Here is the call graph for this function:

Member Function Documentation

buildRoleTitle()

ilMailMemberSearchDataProvider::buildRoleTitle ( string  $role )

private

Definition at line 139 of file class.ilMailMemberSearchDataProvider.php.

References ilObjRole\_getTranslation().

Referenced by collectTableData().

                                                 : string
    {
        return ilObjRole::_getTranslation($role);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

collectTableData()

ilMailMemberSearchDataProvider::collectTableData ( )

private

Definition at line 56 of file class.ilMailMemberSearchDataProvider.php.

References $user_id, ILIAS\Repository\access(), buildRoleTitle(), ilObjectFactory\getInstanceByObjId(), and sortRoles().

Referenced by __construct().

                                       : void
    {
        $participants = $this->objParticipants->getParticipants();
        if ($this->type === 'crs' || $this->type === 'grp') {
            $participants = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                'read',
                'manage_members',
                $this->ref_id,
                $participants
            );
        }

        $preloadedRoleIds = [];
        foreach ($participants as $user_id) {
            $user = ilObjectFactory::getInstanceByObjId($user_id, false);
            if (!($user instanceof ilObjUser)) {
                continue;
            }

            if (!$user->getActive()) {
                continue;
            }

            $login = $user->getLogin();

            $publicName = '';
            if (in_array($user->getPref('public_profile'), ['g', 'y'])) {
                $publicName = $user->getLastname() . ', ' . $user->getFirstname();
            }

            $this->data[$user_id]['user_id'] = $user_id;
            $this->data[$user_id]['login'] = $login;
            $this->data[$user_id]['name'] = $publicName;

            $assignedRoles = $this->objParticipants->getAssignedRoles($user_id);
            $rolesToPreload = array_diff($assignedRoles, $preloadedRoleIds);
            $this->dataCache->preloadObjectCache($rolesToPreload);

            $roleTitles = [];
            foreach ($assignedRoles as $roleId) {
                $preloadedRoleIds[$roleId] = $roleId;
                $title = $this->dataCache->lookupTitle((int) $roleId);
                $roleTitles[] = $title;
            }

            $roleTitles = $this->sortRoles($roleTitles);

            $roleTitles = array_map(
                fn(string $roleTitle): string => $this->buildRoleTitle($roleTitle),
                $roleTitles
            );

            $this->data[$user_id]['role'] = implode(', ', $roleTitles);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getData()

ilMailMemberSearchDataProvider::getData

(

)

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

References $data.

                             : array
    {
        return $this->data;
    }

sortRoles()

ilMailMemberSearchDataProvider::sortRoles ( array  $roleTitles )

private

Parameters

string[]

$roleTitles

Returns

string[]

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

References Vendor\Package\$a, and Vendor\Package\$b.

Referenced by collectTableData().

                                                 : array
    {
        usort($roleTitles, function (string $a, string $b): int {
            $leftPrefixTitle = substr($a, 0, 8);
            $rightPrefixTitle = substr($b, 0, 8);

            $leftRating = $this->roleSortWeightMap[$leftPrefixTitle] ?? 0;
            $rightRating = $this->roleSortWeightMap[$rightPrefixTitle] ?? 0;

            if ($leftRating > 0 || $rightRating > 0) {
                if ($leftRating !== $rightRating) {
                    return $rightRating - $leftRating > 0 ? 1 : -1;
                }

                return 0;
            }

            return strcmp($a, $b);
        });

        return $roleTitles;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilMailMemberSearchDataProvider::$access

protected

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

$data

array ilMailMemberSearchDataProvider::$data = []

protected

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

Referenced by getData().

$dataCache

ilObjectDataCache ilMailMemberSearchDataProvider::$dataCache

protected

Definition at line 30 of file class.ilMailMemberSearchDataProvider.php.

$lng

array ilLanguage ilMailMemberSearchDataProvider::$lng

protected

Initial value:

=> 10,
        'il_crs_t' => 9,
        'il_crs_m' => 8,
        'il_grp_m' => 8,
    ]

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

$roleSortWeightMap

array ilMailMemberSearchDataProvider::$roleSortWeightMap

protected

Initial value:

= [
        'il_crs_a' => 10

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

$type

string ilMailMemberSearchDataProvider::$type = 'crs'

protected

Definition at line 28 of file class.ilMailMemberSearchDataProvider.php.

---

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

• components/ILIAS/Contact/classes/class.ilMailMemberSearchDataProvider.php