ceLTIc\LTI\User\Collector Class Reference

Collects users from all providers. More...

Collaboration diagram for ceLTIc\LTI\User\Collector:

Public Member Functions
	__construct (int $user_id, int $ref_id, InternalDataService $data_service, InternalRepoService $repo_service, InternalDomainService $domain_service)
	collectUsers (bool $a_online_only=false)
	Collect users. More...
	collectUsersFromProvider (Provider $prov, ?array $online_users)

Static Public Member Functions
static	getOnlineUsers ()

Protected Member Functions
	removeUsersFromCollections (array $a_remove_users)
	Remove users from collection. More...

Protected Attributes
ilRbacReview	$rbacreview
Awareness AdminManager	$admin_manager
Awareness InternalDataService	$data_service
ProviderFactory	$provider_factory
Collection	$collection
array	$collections
int	$user_id
int	$ref_id
ilSetting	$settings
InternalRepoService	$repo_service

Static Protected Attributes
static array	$online_users = null
static array	$online_user_ids = array()

Detailed Description

Collects users from all providers.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\User\Collector::__construct	(	int	$user_id,
		int	$ref_id,
		InternalDataService	$data_service,
		InternalRepoService	$repo_service,
		InternalDomainService	$domain_service
	)

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

References ceLTIc\LTI\User\Collector\$data_service, ceLTIc\LTI\User\Collector\$repo_service, ceLTIc\LTI\User\Collector\$user_id, and ILIAS\Repository\settings().

      {
        $this->user_id = $user_id;
        $this->settings = $domain_service->settings();
        $this->provider_factory = $domain_service
            ->userProvider();
        $this->data_service = $data_service;
        $this->admin_manager = $domain_service
            ->admin($ref_id);
        $this->rbacreview = $domain_service->rbac()->review();
        $this->repo_service = $repo_service;
    }

Here is the call graph for this function:

Member Function Documentation

collectUsers()

ceLTIc\LTI\User\Collector::collectUsers

(

bool

$a_online_only = false

)

Collect users.

Definition at line 85 of file class.Collector.php.

References ceLTIc\LTI\User\Collector\$collection, ceLTIc\LTI\User\Collector\$collections, $DIC, ceLTIc\LTI\User\Collector\$rbacreview, ceLTIc\LTI\User\Collector\$user_id, ceLTIc\LTI\User\Collection\addUser(), ANONYMOUS_USER_ID, ceLTIc\LTI\User\Collector\collectUsersFromProvider(), ilLoggerFactory\getLogger(), ilObjUser\getUserSubsetByPreferenceValue(), ceLTIc\LTI\User\Collector\removeUsersFromCollections(), and ILIAS\Repository\settings().

                                                             : array
    {
        $rbacreview = $this->rbacreview;

        $this->collections = array();

        $awrn_logger = \ilLoggerFactory::getLogger('awrn');

        $awrn_logger->debug("Start, Online Only: " . $a_online_only . ", Current User: " . $this->user_id);

        self::getOnlineUsers();
        $all_users = array();
        foreach ($this->provider_factory->getAllProviders() as $prov) {
            $awrn_logger->debug("Provider: " . $prov->getProviderId() . ", Activation Mode: " . $this->admin_manager->getActivationMode($prov->getProviderId()) . ", Current User: " . $this->user_id);

            // overall collection of users
            $collection = $this->data_service->userCollection();

            $provider_active = $this->admin_manager->isProviderActivated($prov->getProviderId());
            $provider_includes_offline = $this->admin_manager->includesProviderOfflineUsers($prov->getProviderId());

            if ($provider_active) {
                $online_users = null;
                if (!$provider_includes_offline || $a_online_only) {
                    $awrn_logger->debug("Provider: " . $prov->getProviderId() . ", Online Filter Users: " . count(self::$online_user_ids) . ", Current User: " . $this->user_id);
                    $online_users = self::$online_user_ids;
                }

                $coll = $this->collectUsersFromProvider($prov, $online_users);
                $awrn_logger->debug("Provider: " . $prov->getProviderId() . ", Collected Users: " . count($coll) . ", Current User: " . $this->user_id);

                foreach ($coll->getUsers() as $user_id) {
                    // filter out the anonymous user
                    if ($user_id == ANONYMOUS_USER_ID) {
                        continue;
                    }
                    // filter out current user
                    if ($user_id == $this->user_id) {
                        continue;
                    }

                    $awrn_logger->debug("Current User: " . $this->user_id . ", " .
                        "Provider: " . $prov->getProviderId() . ", Collected User: " . $user_id);

                    // cross check online, filter out offline users (if necessary)
                    if ((!$a_online_only && $provider_includes_offline)
                        || in_array($user_id, self::$online_user_ids)) {
                        $collection->addUser($user_id);
                        if (!in_array($user_id, $all_users)) {
                            $all_users[] = $user_id;
                        }
                    }
                }
            }
            $this->collections[] = array(
                "uc_title" => $prov->getTitle(),
                "highlighted" => $prov->isHighlighted(),
                "collection" => $collection
            );
        }

        $remove_users = array();

        if ($this->settings->get("hide_own_online_status") === "n") {
            // remove all users with hide_own_online_status "y"
            foreach (\ilObjUser::getUserSubsetByPreferenceValue($all_users, "hide_own_online_status", "y") as $u) {
                $remove_users[] = $u;
            }
        } else {
            // remove all, except user with hide_own_online_status "n"
            $show_users = \ilObjUser::getUserSubsetByPreferenceValue($all_users, "hide_own_online_status", "n");
            $remove_users = array_filter($all_users, function ($i) use ($show_users) {
                return !in_array($i, $show_users);
            });
        }

        global $DIC;
        $remove_users = array_merge($remove_users, $DIC['legalDocuments']->usersWithHiddenOnlineStatus($all_users));

        $this->removeUsersFromCollections($remove_users);

        return $this->collections;
    }

Here is the call graph for this function:

collectUsersFromProvider()

ceLTIc\LTI\User\Collector::collectUsersFromProvider	(	Provider	$prov,
		?array	$online_users
	)

Definition at line 169 of file class.Collector.php.

References ceLTIc\LTI\User\Collector\$user_id, ceLTIc\LTI\User\Collection\addUser(), and ceLTIc\LTI\User\Provider\getInitialUserSet().

Referenced by ceLTIc\LTI\User\Collector\collectUsers().

                                                                                  : Collection
    {
        $coll = $this->data_service->userCollection();
        foreach ($prov->getInitialUserSet($online_users) as $user_id) {
            if ((is_null($online_users) || in_array($user_id, $online_users))) {
                $coll->addUser($user_id);
            }
        }
        return $coll;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOnlineUsers()

static ceLTIc\LTI\User\Collector::getOnlineUsers ( )

static

Definition at line 64 of file class.Collector.php.

References ilObjUser\_getUsersOnline(), and ilContext\directCall().

                                           : array
    {
        if (self::$online_users === null) {
            self::$online_user_ids = array();
            self::$online_users = array();
            foreach (\ilObjUser::_getUsersOnline() as $u) {
                // ask context $u["context"] if it supports pushMessages
                if ($u["context"] &&
                    \ilContext::directCall($u["context"], "supportsPushMessages")) {
                    self::$online_users[$u["user_id"]] = $u;
                    self::$online_user_ids[] = $u["user_id"];
                }
            }
        }
        return self::$online_users;
    }

Here is the call graph for this function:

removeUsersFromCollections()

ceLTIc\LTI\User\Collector::removeUsersFromCollections ( array  $a_remove_users )

protected

Remove users from collection.

Parameters

int[]

$a_remove_users array of user IDs

Definition at line 184 of file class.Collector.php.

References $c.

Referenced by ceLTIc\LTI\User\Collector\collectUsers().

                                                                        : void
    {
        foreach ($this->collections as $c) {
            reset($a_remove_users);
            foreach ($a_remove_users as $u) {
                $c["collection"]->removeUser($u);
            }
        }
    }

Here is the caller graph for this function:

Field Documentation

$admin_manager

Awareness AdminManager ceLTIc::LTI\User\Collector::$admin_manager

protected

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

$collection

Collection ceLTIc::LTI\User\Collector::$collection

protected

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

Referenced by ceLTIc\LTI\User\Collector\collectUsers().

$collections

array ceLTIc::LTI\User\Collector::$collections

protected

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

Referenced by ceLTIc\LTI\User\Collector\collectUsers().

$data_service

Awareness InternalDataService ceLTIc::LTI\User\Collector::$data_service

protected

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

Referenced by ceLTIc\LTI\User\Collector\__construct().

$online_user_ids

array ceLTIc::LTI\User\Collector::$online_user_ids = array()

staticprotected

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

$online_users

array ceLTIc::LTI\User\Collector::$online_users = null

staticprotected

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

$provider_factory

ProviderFactory ceLTIc::LTI\User\Collector::$provider_factory

protected

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

$rbacreview

ilRbacReview ceLTIc::LTI\User\Collector::$rbacreview

protected

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

Referenced by ceLTIc\LTI\User\Collector\collectUsers().

$ref_id

int ceLTIc::LTI\User\Collector::$ref_id

protected

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

$repo_service

InternalRepoService ceLTIc::LTI\User\Collector::$repo_service

protected

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

Referenced by ceLTIc\LTI\User\Collector\__construct().

$settings

ilSetting ceLTIc::LTI\User\Collector::$settings

protected

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

$user_id

int ceLTIc::LTI\User\Collector::$user_id

protected

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

Referenced by ceLTIc\LTI\User\Collector\__construct(), ceLTIc\LTI\User\Collector\collectUsers(), and ceLTIc\LTI\User\Collector\collectUsersFromProvider().

---

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

• components/ILIAS/Awareness/User/class.Collector.php