ilAwarenessUserCollector Class Reference

Collects users from all providers. More...

Collaboration diagram for ilAwarenessUserCollector:

Public Member Functions
	setRefId ($a_val)
	Set ref id. More...
	getRefId ()
	Get ref id. More...
	collectUsers ($a_online_only=false)
	Collect users. More...

Static Public Member Functions
static	getInstance ($a_user_id)
	Get instance (for a user) More...
static	getOnlineUsers ()
	Get online users. More...

Protected Member Functions
	__construct ($a_user_id)
	Constructor. More...
	removeUsersFromCollections ($a_remove_users)
	Remove users from collection. More...

Protected Attributes
	$collection
	$collections
	$user_id
	$ref_id
	$settings

Static Protected Attributes
static	$instances = array()
static	$online_users = false
static	$online_user_ids = array()

Detailed Description

Collects users from all providers.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilAwarenessUserCollector.php.

Constructor & Destructor Documentation

__construct()

ilAwarenessUserCollector::__construct (   $a_user_id )

protected

Constructor.

Parameters

int

$a_user_id

user id

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

    {
        global $DIC;
 
        $this->user_id = $a_user_id;
        $this->settings = $DIC->settings();
    }

References $DIC, and settings().

Here is the call graph for this function:

Member Function Documentation

collectUsers()

ilAwarenessUserCollector::collectUsers

(

$a_online_only = false

)

Collect users.

Returns

ilAwarenessUserCollection user collection

Definition at line 109 of file class.ilAwarenessUserCollector.php.

    {
        global $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();
        include_once("./Services/Awareness/classes/class.ilAwarenessUserProviderFactory.php");
        $all_users = array();
        foreach (ilAwarenessUserProviderFactory::getAllProviders() as $prov) {
            $awrn_logger->debug("Provider: " . $prov->getProviderId() . ", Activation Mode: " . $prov->getActivationMode() . ", Current User: " . $this->user_id);
 
            // overall collection of users
            include_once("./Services/Awareness/classes/class.ilAwarenessUserCollection.php");
            $collection = ilAwarenessUserCollection::getInstance();
 
            if ($prov->getActivationMode() != ilAwarenessUserProvider::MODE_INACTIVE) {
                $prov->setUserId($this->user_id);
                $prov->setRefId($this->ref_id);
                $prov->setOnlineUserFilter(false);
                if ($prov->getActivationMode() == ilAwarenessUserProvider::MODE_ONLINE_ONLY || $a_online_only) {
                    $awrn_logger->debug("Provider: " . $prov->getProviderId() . ", Online Filter Users: " . count(self::$online_user_ids) . ", Current User: " . $this->user_id);
                    $prov->setOnlineUserFilter(self::$online_user_ids);
                }
 
                $coll = $prov->collectUsers();
                $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;
                    }
 
                    $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 && $prov->getActivationMode() == ilAwarenessUserProvider::MODE_INCL_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);
            });
        }
 
        // remove all users that have not accepted the terms of service yet
        require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceHelper.php';
        if (ilTermsOfServiceHelper::isEnabled()) {
            foreach (ilObjUser::getUsersAgreed(false, $all_users) as $u) {
                if ($u != SYSTEM_USER_ID && !$rbacreview->isAssigned($u, SYSTEM_ROLE_ID)) {
                    //if ($u != SYSTEM_USER_ID)
                    $remove_users[] = $u;
                }
            }
        }
 
        $this->removeUsersFromCollections($remove_users);
 
        return $this->collections;
    }

References $collection, $collections, $i, $user_id, ANONYMOUS_USER_ID, ilAwarenessUserProviderFactory\getAllProviders(), ilAwarenessUserCollection\getInstance(), ilLoggerFactory\getLogger(), getOnlineUsers(), ilObjUser\getUsersAgreed(), ilObjUser\getUserSubsetByPreferenceValue(), ilTermsOfServiceHelper\isEnabled(), ilAwarenessUserProvider\MODE_INACTIVE, ilAwarenessUserProvider\MODE_INCL_OFFLINE, ilAwarenessUserProvider\MODE_ONLINE_ONLY, removeUsersFromCollections(), settings(), SYSTEM_ROLE_ID, and SYSTEM_USER_ID.

Here is the call graph for this function:

getInstance()

static ilAwarenessUserCollector::getInstance (   $a_user_id )

static

Get instance (for a user)

Parameters

int

$a_user_id

user id

Returns

ilAwarenessAct actor class

Definition at line 70 of file class.ilAwarenessUserCollector.php.

    {
        if (!isset(self::$instances[$a_user_id])) {
            self::$instances[$a_user_id] = new ilAwarenessUserCollector($a_user_id);
        }
 
        return self::$instances[$a_user_id];
    }

Referenced by ilAwarenessData\__construct().

Here is the caller graph for this function:

getOnlineUsers()

static ilAwarenessUserCollector::getOnlineUsers ( )

static

Get online users.

Parameters

return

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

    {
        if (self::$online_users === false) {
            self::$online_user_ids = array();
            self::$online_users = array();
            include_once("./Services/User/classes/class.ilObjUser.php");
            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;
    }

References $online_users, and ilContext\directCall().

Referenced by collectUsers(), ilAwarenessData\getData(), and ilAwarenessData\getOnlineUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilAwarenessUserCollector::getRefId

(

)

Get ref id.

Returns

int ref id

Definition at line 59 of file class.ilAwarenessUserCollector.php.

    {
        return $this->ref_id;
    }

References $ref_id.

removeUsersFromCollections()

ilAwarenessUserCollector::removeUsersFromCollections (   $a_remove_users )

protected

Remove users from collection.

Parameters

array

$a_remove_users

array of user IDs

Definition at line 203 of file class.ilAwarenessUserCollector.php.

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

References $c.

Referenced by collectUsers().

Here is the caller graph for this function:

setRefId()

ilAwarenessUserCollector::setRefId

(

$a_val

)

Set ref id.

Parameters

int

$a_val

ref id

Definition at line 49 of file class.ilAwarenessUserCollector.php.

    {
        $this->ref_id = $a_val;
    }

Field Documentation

$collection

ilAwarenessUserCollector::$collection

protected

Definition at line 21 of file class.ilAwarenessUserCollector.php.

Referenced by collectUsers().

$collections

ilAwarenessUserCollector::$collections

protected

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

Referenced by collectUsers().

$instances

ilAwarenessUserCollector::$instances = array()

staticprotected

Definition at line 14 of file class.ilAwarenessUserCollector.php.

$online_user_ids

ilAwarenessUserCollector::$online_user_ids = array()

staticprotected

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

$online_users

ilAwarenessUserCollector::$online_users = false

staticprotected

Definition at line 15 of file class.ilAwarenessUserCollector.php.

Referenced by getOnlineUsers().

$ref_id

ilAwarenessUserCollector::$ref_id

protected

Definition at line 24 of file class.ilAwarenessUserCollector.php.

Referenced by getRefId().

$settings

ilAwarenessUserCollector::$settings

protected

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

$user_id

ilAwarenessUserCollector::$user_id

protected

Definition at line 23 of file class.ilAwarenessUserCollector.php.

Referenced by collectUsers().

---

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

• Services/Awareness/classes/class.ilAwarenessUserCollector.php