ilMailMemberSearchDataProvider Class Reference

Class ilMailMemberSearchDataProvider. More...

Collaboration diagram for ilMailMemberSearchDataProvider:

Public Member Functions
	__construct ($objParticipants, $a_ref_id)
	getData ()

Protected Attributes
	$access
	$ref_id
	$type = 'crs'
	$data = []
	$objParticipants = null
	$dataCache
	$roleSortWeightMap
	$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 10 of file class.ilMailMemberSearchDataProvider.php.

Constructor & Destructor Documentation

__construct()

ilMailMemberSearchDataProvider::__construct	(		$objParticipants,
			$a_ref_id
	)

Parameters

ilParticipants	$objParticipants
int	$a_ref_id

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

    {
        global $DIC;
 
        $this->dataCache = $DIC['ilObjDataCache'];
        $this->access = $DIC->access();
        $this->objParticipants = $objParticipants;
        $this->type = $this->objParticipants->getType();
        $this->lng = $DIC['lng'];
 
        $this->ref_id = $a_ref_id;
 
        $this->collectTableData();
    }

References $DIC, $objParticipants, and collectTableData().

Here is the call graph for this function:

Member Function Documentation

buildRoleTitle()

ilMailMemberSearchDataProvider::buildRoleTitle ( string  $role )

private

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

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

References ilObjRole\_getTranslation().

Referenced by collectTableData().

Here is the call graph for this function:

Here is the caller graph for this function:

collectTableData()

ilMailMemberSearchDataProvider::collectTableData ( )

private

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

                                        : 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 || !($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($roleId);
                $roleTitles[] = $title;
            }
 
            $roleTitles = $this->sortRoles($roleTitles);
 
            $roleTitles = array_map(function (string $roleTitle) : string {
                return $this->buildRoleTitle($roleTitle);
            }, $roleTitles);
 
            $this->data[$user_id]['role'] = implode(', ', $roleTitles);
        }
    }

References $login, buildRoleTitle(), ilObjectFactory\getInstanceByObjId(), and sortRoles().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getData()

ilMailMemberSearchDataProvider::getData

(

)

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

                              : array
    {
        return $this->data;
    }

References $data.

sortRoles()

ilMailMemberSearchDataProvider::sortRoles ( array  $roleTitles )

private

Parameters

string[]

$roleTitles

Returns

string[]

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

                                                  : 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;
    }

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

Referenced by collectTableData().

Here is the caller graph for this function:

Field Documentation

$access

ilMailMemberSearchDataProvider::$access

protected

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

$data

ilMailMemberSearchDataProvider::$data = []

protected

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

Referenced by getData().

$dataCache

ilMailMemberSearchDataProvider::$dataCache

protected

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

$lng

ilMailMemberSearchDataProvider::$lng

protected

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

$objParticipants

ilMailMemberSearchDataProvider::$objParticipants = null

protected

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

Referenced by __construct().

$ref_id

ilMailMemberSearchDataProvider::$ref_id

protected

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

$roleSortWeightMap

ilMailMemberSearchDataProvider::$roleSortWeightMap

protected

Initial value:

= [
        'il_crs_a' => 10,
        'il_grp_a' => 10,
        'il_crs_t' => 9,
        'il_crs_m' => 8,
        'il_grp_m' => 8,
    ]

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

$type

ilMailMemberSearchDataProvider::$type = 'crs'

protected

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

---

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

• Services/Contact/classes/class.ilMailMemberSearchDataProvider.php