ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilAwarenessUserProviderAllUsers Class Reference

Test provider, adds all users. More...

+ Inheritance diagram for ilAwarenessUserProviderAllUsers:
+ Collaboration diagram for ilAwarenessUserProviderAllUsers:

Public Member Functions

 getProviderId ()
 Get provider id. More...
 
 getTitle ()
 Provider title (used in awareness overlay and in administration settings) More...
 
 getInfo ()
 Provider info (used in administration settings) More...
 
 getInitialUserSet ()
 Get initial set of users. More...
 
- Public Member Functions inherited from ilAwarenessUserProvider
 __construct ()
 Constructor. More...
 
 setActivationMode ($a_val)
 Activate provider. More...
 
 getActivationMode ()
 Get Activate provider. More...
 
 setUserId ($a_val)
 Set user id. More...
 
 getUserId ()
 Get user id. More...
 
 setRefId ($a_val)
 Set ref id. More...
 
 getRefId ()
 Get ref id. More...
 
 setOnlineUserFilter ($a_val)
 Set online user filter. More...
 
 getOnlineUserFilter ()
 Get online user filter. More...
 
 getProviderId ()
 This should return a unique id for the provider The ID should start with the service/module id, separated by "_" and a second part that is unique within the module/service, e.g. More...
 
 getTitle ()
 Provider title (used in awareness overlay and in administration settings) More...
 
 getInfo ()
 Provider info (used in administration settings) More...
 
 getInitialUserSet ()
 Get initial set of users. More...
 
 collectUsers ()
 Collect all users. More...
 
 isHighlighted ()
 Is highlighted. More...
 

Additional Inherited Members

- Data Fields inherited from ilAwarenessUserProvider
const MODE_INACTIVE = 0
 
const MODE_ONLINE_ONLY = 1
 
const MODE_INCL_OFFLINE = 2
 
- Protected Member Functions inherited from ilAwarenessUserProvider
 addUserToCollection ($a_user_id, ilAwarenessUserCollection $a_collection)
 Add user to collection. More...
 
- Protected Attributes inherited from ilAwarenessUserProvider
 $user_id
 
 $ref_id
 
 $lng
 
 $db
 
 $online_user_filter = false
 

Detailed Description

Test provider, adds all users.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Member Function Documentation

◆ getInfo()

ilAwarenessUserProviderAllUsers::getInfo ( )

Provider info (used in administration settings)

Returns
string provider info text

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

43  {
44  $this->lng->loadLanguageModule("user");
45  return $this->lng->txt("user_awrn_all_users_info");
46  }

◆ getInitialUserSet()

ilAwarenessUserProviderAllUsers::getInitialUserSet ( )

Get initial set of users.

Returns
array array of user IDs

Definition at line 53 of file class.ilAwarenessUserProviderAllUsers.php.

References $ilDB, and ilAwarenessUserProvider\getOnlineUserFilter().

54  {
55  global $ilDB;
56 
57  $ub = array();
58  // all online users
59  if ($this->getOnlineUserFilter() !== false)
60  {
61  foreach ($this->getOnlineUserFilter() as $u)
62  {
63  $ub[] = $u;
64  }
65  }
66  else // all users
67  {
68  $set = $ilDB->query("SELECT usr_id FROM usr_data ");
69  while ($rec = $ilDB->fetchAssoc($set))
70  {
71  $ub[] = $rec["usr_id"];
72  }
73  }
74  return $ub;
75  }
global $ilDB
getOnlineUserFilter()
Get online user filter.
+ Here is the call graph for this function:

◆ getProviderId()

ilAwarenessUserProviderAllUsers::getProviderId ( )

Get provider id.

Returns
string provider id

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

22  {
23  return "user_all";
24  }

◆ getTitle()

ilAwarenessUserProviderAllUsers::getTitle ( )

Provider title (used in awareness overlay and in administration settings)

Returns
string provider title

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

32  {
33  $this->lng->loadLanguageModule("user");
34  return $this->lng->txt("user_awrn_all_users");
35  }

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