This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUserQuery:

Public Member Functions
	__construct ()

	setUdfFilter (array $a_val)
	Set udf filter. More...

	getUdfFilter ()
	Get udf filter. More...

	setOrderField (string $a_order)
	Set order field (column in usr_data) Default order is 'login'. More...

	setOrderDirection (string $a_dir)
	Set order direction 'asc' or 'desc' Default is 'asc'. More...

	setOffset (int $a_offset)

	setLimit (int $a_limit)

	setTextFilter (string $a_filter)
	Text (like) filter in login, firstname, lastname or email. More...

	setActionFilter (string $a_activation)
	Set activation filter 'active' or 'inactive' or empty. More...

	setLastLogin (ilDateTime $dt=null)
	Set last login filter. More...

	setLimitedAccessFilter (bool $a_status)
	Enable limited access filter. More...

	setNoCourseFilter (bool $a_no_course)

	setNoGroupFilter (bool $a_no_group)

	setCourseGroupFilter (int $a_cg_id)
	Set course / group filter object_id of course or group. More...

	setRoleFilter (int $a_role_id)
	Set role filter obj_id of role. More...

	setUserFolder (?array $a_fold_id)
	Set user folder filter reference id of user folder or category (local user administration) More...

	setAdditionalFields (array $a_add)
	Set additional fields (columns in usr_data or 'online_time') More...

	setUserFilter (array $a_filter)
	Array with user ids to query against. More...

	setFirstLetterLastname (string $a_fll)
	set first letter lastname filter More...

	setAccessFilter (bool $a_access)
	set filter for user that are limited but has access More...

	setAuthenticationFilter (string $a_authentication)
	Set authentication filter. More...

	query ()
	Query usr_data. More...

Static Public Member Functions
static	getUserListData (string $a_order_field, string $a_order_dir, int $a_offset, int $a_limit, string $a_string_filter="", string $a_activation_filter="", ?ilDateTime $a_last_login_filter=null, bool $a_limited_access_filter=false, bool $a_no_courses_filter=false, int $a_course_group_filter=0, int $a_role_filter=0, array $a_user_folder_filter=null, array $a_additional_fields=null, array $a_user_filter=null, string $a_first_letter="", string $a_authentication_filter="")
	Get data for user administration list. More...

Data Fields
const	DEFAULT_ORDER_FIELD = 'login'

Protected Attributes
array	$udf_filter = array()

Private Attributes
string	$order_field = self::DEFAULT_ORDER_FIELD

string	$order_dir = 'asc'

int	$offset = 0

int	$limit = 50

string	$text_filter = ''

string	$activation = ''

ilDateTime	$last_login = null

bool	$limited_access = false

bool	$no_courses = false

bool	$no_groups = false

int	$crs_grp = 0

int	$role = 0

array	$user_folder = null

array	$additional_fields = array()

array	$users = array()

string	$first_letter = ''

bool	$has_access = false

string	$authentication_method = ''

array	$default_fields

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning User query class. Put any complex that queries for a set of users into this class and keep ilObjUser "small".

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

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

Constructor & Destructor Documentation

◆ __construct()

ilUserQuery::__construct ( )

Definition at line 62 of file class.ilUserQuery.php.

63 {

64 }

Member Function Documentation

◆ getUdfFilter()

ilUserQuery::getUdfFilter ( )

Get udf filter.

Returns: array udf filter array

Definition at line 88 of file class.ilUserQuery.php.

References $udf_filter.

Referenced by query().

                                   : array // Missing array type.
     {
         return $this->udf_filter;
     }

Here is the caller graph for this function:

◆ getUserListData()

static ilUserQuery::getUserListData	(	string	$a_order_field,
		string	$a_order_dir,
		int	$a_offset,
		int	$a_limit,
		string	$a_string_filter = `""`,
		string	$a_activation_filter = `""`,
		?ilDateTime	$a_last_login_filter = `null`,
		bool	$a_limited_access_filter = `false`,
		bool	$a_no_courses_filter = `false`,
		int	$a_course_group_filter = `0`,
		int	$a_role_filter = `0`,
		array	$a_user_folder_filter = `null`,
		array	$a_additional_fields = `null`,
		array	$a_user_filter = `null`,
		string	$a_first_letter = `""`,
		string	$a_authentication_filter = `""`
	)

static

Get data for user administration list.

Deprecated:

Definition at line 551 of file class.ilUserQuery.php.

References $query.

Referenced by ilUserLPTableGUI\getItems(), ilAssignedUsersTableGUI\getItems(), ilGroupParticipantsTableGUI\parse(), ilLearningSequenceParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilSubscriberTableGUI\readSubscriberData(), and ilWaitingListTableGUI\readUserData().

      : array {
         $query = new ilUserQuery();
         $query->setOrderField($a_order_field);
         $query->setOrderDirection($a_order_dir);
         $query->setOffset($a_offset);
         $query->setLimit($a_limit);
         $query->setTextFilter($a_string_filter);
         $query->setActionFilter($a_activation_filter);
         $query->setLastLogin($a_last_login_filter);
         $query->setLimitedAccessFilter($a_limited_access_filter);
         $query->setNoCourseFilter($a_no_courses_filter);
         $query->setCourseGroupFilter($a_course_group_filter);
         $query->setRoleFilter($a_role_filter);
         $query->setUserFolder($a_user_folder_filter);
         $query->setAdditionalFields($a_additional_fields ?? []);
         $query->setUserFilter($a_user_filter ?? []);
         $query->setFirstLetterLastname($a_first_letter);
         $query->setAuthenticationFilter($a_authentication_filter);
         return $query->query();
     }

Here is the caller graph for this function:

◆ query()

ilUserQuery::query ( )

Query usr_data.

Returns: array ('cnt', 'set')

Definition at line 237 of file class.ilUserQuery.php.

References $DIC, Vendor\Package\$f, $id, $ilDB, $limit, $offset, $query, ilDateTime\_before(), ilUserDefinedFields\_getInstance(), ilObject\_lookupType(), ANONYMOUS_USER_ID, getUdfFilter(), IL_CAL_DATETIME, IL_CAL_DAY, IL_CAL_UNIX, ILIAS\Repository\int(), UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

                            : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
 
         $udf_fields = array();
         $usr_ids = [];
 
         $join = "";
 
         if (is_array($this->additional_fields)) {
             foreach ($this->additional_fields as $f) {
                 if (!in_array($f, $this->default_fields)) {
                     if ($f === "online_time") {
                         $this->default_fields[] = "ut_online.online_time";
                         $join = " LEFT JOIN ut_online ON (usr_data.usr_id = ut_online.usr_id) ";
                     } elseif (substr($f, 0, 4) === "udf_") {
                         $udf_fields[] = (int) substr($f, 4);
                     } else {
                         $this->default_fields[] = $f;
                     }
                 }
             }
         }
 
         // if udf fields are involved we need the definitions
         $udf_def = array();
         if (count($udf_fields) > 0) {
             $udf_def = ilUserDefinedFields::_getInstance()->getDefinitions();
         }
 
         // join udf table
         foreach ($udf_fields as $id) {
             $udf_table = ($udf_def[$id]["field_type"] != UDF_TYPE_WYSIWYG)
                 ? "udf_text"
                 : "udf_clob";
             $join .= " LEFT JOIN " . $udf_table . " ud_" . $id . " ON (ud_" . $id . ".field_id=" . $ilDB->quote($id) . " AND ud_" . $id . ".usr_id = usr_data.usr_id) ";
         }
 
         // count query
         $count_query = "SELECT count(usr_data.usr_id) cnt" .
             " FROM usr_data";
 
         $all_multi_fields = array("interests_general", "interests_help_offered", "interests_help_looking");
         $multi_fields = array();
 
         $sql_fields = array();
         foreach ($this->default_fields as $idx => $field) {
             if (!$field) {
                 continue;
             }
 
             if (in_array($field, $all_multi_fields)) {
                 $multi_fields[] = $field;
             } elseif (strpos($field, ".") === false) {
                 $sql_fields[] = "usr_data." . $field;
             } else {
                 $sql_fields[] = $field;
             }
         }
 
         // udf fields
         foreach ($udf_fields as $id) {
             $sql_fields[] = "ud_" . $id . ".value udf_" . $id;
         }
 
         // basic query
         $query = "SELECT " . implode(",", $sql_fields) .
             " FROM usr_data" .
             $join;
 
         $count_query .= " " . $join;
 
         // filter
         $query .= " WHERE usr_data.usr_id <> " . $ilDB->quote(ANONYMOUS_USER_ID, "integer");
 
         // User filter
         $count_query .= " WHERE 1 = 1 ";
         $count_user_filter = "usr_data.usr_id != " . $ilDB->quote(ANONYMOUS_USER_ID, "integer");
         if ($this->users and is_array(($this->users))) {
             $query .= ' AND ' . $ilDB->in('usr_data.usr_id', $this->users, false, 'integer');
             $count_user_filter = $ilDB->in('usr_data.usr_id', $this->users, false, 'integer');
         }
 
         $count_query .= " AND " . $count_user_filter . " ";
         $where = " AND";
 
         if ($this->first_letter != "") {
             $add = $where . " (" . $ilDB->upper($ilDB->substr("usr_data.lastname", 1, 1)) . " = " . $ilDB->upper($ilDB->quote($this->first_letter, "text")) . ") ";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         if ($this->text_filter != "") {         // email, name, login
             $add = $where . " (" . $ilDB->like("usr_data.login", "text", "%" . $this->text_filter . "%") . " " .
                 "OR " . $ilDB->like("usr_data.firstname", "text", "%" . $this->text_filter . "%") . " " .
                 "OR " . $ilDB->like("usr_data.lastname", "text", "%" . $this->text_filter . "%") . " " .
                 "OR " . $ilDB->like("usr_data.second_email", "text", "%" . $this->text_filter . "%") . " " .
                 "OR " . $ilDB->like("usr_data.email", "text", "%" . $this->text_filter . "%") . ") ";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         if ($this->activation != "") {          // activation
             if ($this->activation === "inactive") {
                 $add = $where . " usr_data.active = " . $ilDB->quote(0, "integer") . " ";
             } else {
                 $add = $where . " usr_data.active = " . $ilDB->quote(1, "integer") . " ";
             }
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         if ($this->last_login instanceof ilDateTime) {  // last login
             if (ilDateTime::_before($this->last_login, new ilDateTime(time() + (60 * 60 * 24), IL_CAL_UNIX), IL_CAL_DAY)) {
                 $add = $where . " usr_data.last_login < " .
                     $ilDB->quote($this->last_login->get(IL_CAL_DATETIME), "timestamp");
                 $query .= $add;
                 $count_query .= $add;
                 $where = " AND";
             }
         }
         if ($this->limited_access) {            // limited access
             $add = $where . " usr_data.time_limit_unlimited= " . $ilDB->quote(0, "integer");
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         // udf filter
         foreach ($this->getUdfFilter() as $k => $f) {
             if ($f != "") {
                 $udf_id = explode("_", $k)[1];
                 if ($udf_def[$udf_id]["field_type"] == UDF_TYPE_TEXT) {
                     $add = $where . " " . $ilDB->like("ud_" . $udf_id . ".value", "text", "%" . $f . "%");
                 } else {
                     $add = $where . " ud_" . $udf_id . ".value = " . $ilDB->quote($f, "text");
                 }
                 $query .= $add;
                 $count_query .= $add;
                 $where = " AND";
             }
         }
 
         if ($this->has_access) { //user is limited but has access
             $unlimited = "time_limit_unlimited = " . $ilDB->quote(1, 'integer');
             $from = "time_limit_from < " . $ilDB->quote(time(), 'integer');
             $until = "time_limit_until > " . $ilDB->quote(time(), 'integer');
 
             $add = $where . ' (' . $unlimited . ' OR (' . $from . ' AND ' . $until . '))';
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
         if ($this->no_courses) {                // no courses assigned
             $add = $where . " usr_data.usr_id NOT IN (" .
                 "SELECT DISTINCT ud.usr_id " .
                 "FROM usr_data ud join rbac_ua ON (ud.usr_id = rbac_ua.usr_id) " .
                 "JOIN object_data od ON (rbac_ua.rol_id = od.obj_id) " .
                 "JOIN rbac_fa ON (rbac_ua.rol_id = rbac_fa.rol_id) " .
                 "JOIN tree ON (rbac_fa.parent = tree.child) " .
                 "WHERE od.title LIKE 'il_crs_%' " .
                 "AND rbac_fa.assign = 'y' " .
                 "AND tree.tree > 0)";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
         if ($this->no_groups) {         // no groups assigned
             $add = $where . " usr_data.usr_id NOT IN (" .
                 "SELECT DISTINCT ud.usr_id " .
                 "FROM usr_data ud join rbac_ua ON (ud.usr_id = rbac_ua.usr_id) " .
                 "JOIN object_data od ON (rbac_ua.rol_id = od.obj_id) " .
                 "JOIN rbac_fa ON (rbac_ua.rol_id = rbac_fa.rol_id) " .
                 "JOIN tree ON (rbac_fa.parent = tree.child) " .
                 "WHERE od.title LIKE 'il_grp_%' " .
                 "AND rbac_fa.assign = 'y' " .
                 "AND tree.tree > 0)";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
         if ($this->crs_grp > 0) {               // members of course/group
             $cgtype = ilObject::_lookupType($this->crs_grp, true);
             $add = $where . " usr_data.usr_id IN (" .
                 "SELECT DISTINCT ud.usr_id " .
                 "FROM usr_data ud join rbac_ua ON (ud.usr_id = rbac_ua.usr_id) " .
                 "JOIN object_data od ON (rbac_ua.rol_id = od.obj_id) " .
                 "WHERE od.title = " . $ilDB->quote("il_" . $cgtype . "_member_" . $this->crs_grp, "text") . ")";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
         if ($this->role > 0) {          // global role
             $add = $where . " usr_data.usr_id IN (" .
                 "SELECT DISTINCT ud.usr_id " .
                 "FROM usr_data ud join rbac_ua ON (ud.usr_id = rbac_ua.usr_id) " .
                 "WHERE rbac_ua.rol_id = " . $ilDB->quote($this->role, "integer") . ")";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         if ($this->user_folder) {
             $add = $where . " " . $ilDB->in('usr_data.time_limit_owner', $this->user_folder, false, 'integer');
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         if ($this->authentication_method != "") {               // authentication
             $add = $where . " usr_data.auth_mode = " . $ilDB->quote($this->authentication_method, "text") . " ";
             $query .= $add;
             $count_query .= $add;
             $where = " AND";
         }
 
         // order by
         switch ($this->order_field) {
             case  "access_until":
                 if ($this->order_dir === "desc") {
                     $query .= " ORDER BY usr_data.active DESC, usr_data.time_limit_unlimited DESC, usr_data.time_limit_until DESC";
                 } else {
                     $query .= " ORDER BY usr_data.active ASC, usr_data.time_limit_unlimited ASC, usr_data.time_limit_until ASC";
                 }
                 break;
 
             case "online_time":
                 if ($this->order_dir === "desc") {
                     $query .= " ORDER BY ut_online.online_time DESC";
                 } else {
                     $query .= " ORDER BY ut_online.online_time ASC";
                 }
                 break;
 
             default:
                 if ($this->order_dir !== "asc" && $this->order_dir !== "desc") {
                     $this->order_dir = "asc";
                 }
                 if (substr($this->order_field, 0, 4) === "udf_") {
                     // #25311 check if order field is in field list
                     if (is_array($this->getUdfFilter()) && array_key_exists($this->order_field, $this->getUdfFilter())) {
                         $query .= " ORDER BY ud_" . ((int) substr($this->order_field, 4)) . ".value " . strtoupper($this->order_dir);
                     } else {
                         $query .= ' ORDER BY ' . self::DEFAULT_ORDER_FIELD . ' ' . strtoupper($this->order_dir);
                     }
                 } else {
                     if (!in_array($this->order_field, $this->default_fields)) {
                         $this->order_field = "login";
                     }
                     $query .= " ORDER BY usr_data." . $this->order_field . " " . strtoupper($this->order_dir);
                 }
                 break;
         }
 
         // count query
         $set = $ilDB->query($count_query);
         $cnt = 0;
         if ($rec = $ilDB->fetchAssoc($set)) {
             $cnt = $rec["cnt"];
         }
 
         $offset = $this->offset;
         $limit = $this->limit;
 
         // #9866: validate offset against rowcount
         if ($offset >= $cnt) {
             $offset = 0;
         }
 
         $ilDB->setLimit($limit, $offset);
 
         if (count($multi_fields)) {
             $usr_ids = array();
         }
 
         // set query
         $set = $ilDB->query($query);
         $result = array();
 
         while ($rec = $ilDB->fetchAssoc($set)) {
             $result[] = $rec;
             if (count($multi_fields)) {
                 $usr_ids[] = (int) $rec["usr_id"];
             }
         }
 
         // add multi-field-values to user-data
         if (count($multi_fields) && count($usr_ids)) {
             $usr_multi = array();
             $set = $ilDB->query("SELECT * FROM usr_data_multi" .
                 " WHERE " . $ilDB->in("usr_id", $usr_ids, "", "integer"));
             while ($row = $ilDB->fetchAssoc($set)) {
                 $usr_multi[(int) $row["usr_id"]][$row["field_id"]][] = $row["value"];
             }
             foreach ($result as $idx => $item) {
                 if (isset($usr_multi[$item["usr_id"]])) {
                     $result[$idx] = array_merge($item, $usr_multi[(int) $item["usr_id"]]);
                 }
             }
         }
         return array("cnt" => $cnt, "set" => $result);
     }

Here is the call graph for this function:

◆ setAccessFilter()

ilUserQuery::setAccessFilter ( bool $a_access )

set filter for user that are limited but has access

Definition at line 219 of file class.ilUserQuery.php.

                                                    : void
     {
         $this->has_access = $a_access;
     }

◆ setActionFilter()

ilUserQuery::setActionFilter ( string $a_activation )

Set activation filter 'active' or 'inactive' or empty.

Definition at line 134 of file class.ilUserQuery.php.

                                                          : void
     {
         $this->activation = $a_activation;
     }

◆ setAdditionalFields()

ilUserQuery::setAdditionalFields ( array $a_add )

Set additional fields (columns in usr_data or 'online_time')

Definition at line 195 of file class.ilUserQuery.php.

                                                      : void // Missing array type.
     {
         $this->additional_fields = $a_add;
     }

◆ setAuthenticationFilter()

ilUserQuery::setAuthenticationFilter ( string $a_authentication )

Set authentication filter.

Parameters

string $a_authentication 'default', 'local' or 'lti'

Definition at line 228 of file class.ilUserQuery.php.

                                                                      : void
     {
         $this->authentication_method = $a_authentication;
     }

◆ setCourseGroupFilter()

ilUserQuery::setCourseGroupFilter ( int $a_cg_id )

Set course / group filter object_id of course or group.

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

                                                       : void
     {
         $this->crs_grp = $a_cg_id;
     }

◆ setFirstLetterLastname()

ilUserQuery::setFirstLetterLastname ( string $a_fll )

set first letter lastname filter

Definition at line 211 of file class.ilUserQuery.php.

                                                          : void
     {
         $this->first_letter = $a_fll;
     }

◆ setLastLogin()

ilUserQuery::setLastLogin ( ilDateTime $dt = null )

Set last login filter.

Definition at line 142 of file class.ilUserQuery.php.

                                                        : void
     {
         $this->last_login = $dt;
     }

◆ setLimit()

ilUserQuery::setLimit ( int $a_limit )

Definition at line 117 of file class.ilUserQuery.php.

                                           : void
     {
         $this->limit = $a_limit;
     }

◆ setLimitedAccessFilter()

ilUserQuery::setLimitedAccessFilter ( bool $a_status )

Enable limited access filter.

Definition at line 150 of file class.ilUserQuery.php.

                                                           : void
     {
         $this->limited_access = $a_status;
     }

◆ setNoCourseFilter()

ilUserQuery::setNoCourseFilter ( bool $a_no_course )

Definition at line 155 of file class.ilUserQuery.php.

                                                         : void
     {
         $this->no_courses = $a_no_course;
     }

◆ setNoGroupFilter()

ilUserQuery::setNoGroupFilter ( bool $a_no_group )

Definition at line 160 of file class.ilUserQuery.php.

                                                       : void
     {
         $this->no_groups = $a_no_group;
     }

◆ setOffset()

ilUserQuery::setOffset ( int $a_offset )

Definition at line 112 of file class.ilUserQuery.php.

                                             : void
     {
         $this->offset = $a_offset;
     }

◆ setOrderDirection()

ilUserQuery::setOrderDirection ( string $a_dir )

Set order direction 'asc' or 'desc' Default is 'asc'.

Definition at line 107 of file class.ilUserQuery.php.

                                                     : void
     {
         $this->order_dir = $a_dir;
     }

◆ setOrderField()

ilUserQuery::setOrderField ( string $a_order )

Set order field (column in usr_data) Default order is 'login'.

Definition at line 97 of file class.ilUserQuery.php.

                                                   : void
     {
         $this->order_field = $a_order;
     }

◆ setRoleFilter()

ilUserQuery::setRoleFilter ( int $a_role_id )

Set role filter obj_id of role.

Definition at line 178 of file class.ilUserQuery.php.

                                                  : void
     {
         $this->role = $a_role_id;
     }

◆ setTextFilter()

ilUserQuery::setTextFilter ( string $a_filter )

Text (like) filter in login, firstname, lastname or email.

Definition at line 125 of file class.ilUserQuery.php.

                                                    : void
     {
         $this->text_filter = $a_filter;
     }

◆ setUdfFilter()

ilUserQuery::setUdfFilter ( array $a_val )

Set udf filter.

Parameters

array $a_val udf filter array

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

References ilUserDefinedFields\_getInstance().

                                               : void // Missing array type.
     {
         $valid_udfs = [];
 
         $definitions = \ilUserDefinedFields::_getInstance()->getDefinitions();
         foreach ($a_val as $udf_name => $udf_value) {
             [$udf_string, $udf_id] = explode('_', $udf_name);
             if (array_key_exists((int) $udf_id, $definitions)) {
                 $valid_udfs[$udf_name] = $udf_value;
             }
         }
         $this->udf_filter = $valid_udfs;
     }

Here is the call graph for this function:

◆ setUserFilter()

ilUserQuery::setUserFilter ( array $a_filter )

Array with user ids to query against.

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

                                                   : void // Missing array type.
     {
         $this->users = $a_filter;
     }

◆ setUserFolder()

ilUserQuery::setUserFolder ( ?array $a_fold_id )

Set user folder filter reference id of user folder or category (local user administration)

Definition at line 187 of file class.ilUserQuery.php.

                                                     : void // Missing array type.
     {
         $this->user_folder = $a_fold_id;
     }

Field Documentation

◆ $activation

string ilUserQuery::$activation = ''

private

Definition at line 33 of file class.ilUserQuery.php.

◆ $additional_fields

array ilUserQuery::$additional_fields = array()

private

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

◆ $authentication_method

string ilUserQuery::$authentication_method = ''

private

Definition at line 45 of file class.ilUserQuery.php.

◆ $crs_grp

int ilUserQuery::$crs_grp = 0

private

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

◆ $default_fields

array ilUserQuery::$default_fields

private

Initial value:

= array(
        "usr_id",
        "login",
        "firstname",
        "lastname",
        "email",
        "second_email",
        "time_limit_until",
        "time_limit_unlimited",
        "time_limit_owner",
        "last_login",
        "active"
    )

Definition at line 48 of file class.ilUserQuery.php.

◆ $first_letter

string ilUserQuery::$first_letter = ''

private

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

◆ $has_access

bool ilUserQuery::$has_access = false

private

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

◆ $last_login

ilDateTime ilUserQuery::$last_login = null

private

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

◆ $limit

int ilUserQuery::$limit = 50

private

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

Referenced by query().

◆ $limited_access

bool ilUserQuery::$limited_access = false

private

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

◆ $no_courses

bool ilUserQuery::$no_courses = false

private

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

◆ $no_groups

bool ilUserQuery::$no_groups = false

private

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

◆ $offset

int ilUserQuery::$offset = 0

private

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

Referenced by query().

◆ $order_dir

string ilUserQuery::$order_dir = 'asc'

private

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

◆ $order_field

string ilUserQuery::$order_field = self::DEFAULT_ORDER_FIELD

private

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

◆ $role

int ilUserQuery::$role = 0

private

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

◆ $text_filter

string ilUserQuery::$text_filter = ''

private

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

◆ $udf_filter

array ilUserQuery::$udf_filter = array()

protected

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

Referenced by getUdfFilter().

◆ $user_folder

array ilUserQuery::$user_folder = null

private

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

◆ $users

array ilUserQuery::$users = array()

private

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

◆ DEFAULT_ORDER_FIELD

const ilUserQuery::DEFAULT_ORDER_FIELD = 'login'

Definition at line 26 of file class.ilUserQuery.php.

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

Services/User/classes/class.ilUserQuery.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getUdfFilter()

◆ getUserListData()

◆ query()

◆ setAccessFilter()

◆ setActionFilter()

◆ setAdditionalFields()

◆ setAuthenticationFilter()

◆ setCourseGroupFilter()

◆ setFirstLetterLastname()

◆ setLastLogin()

◆ setLimit()

◆ setLimitedAccessFilter()

◆ setNoCourseFilter()

◆ setNoGroupFilter()

◆ setOffset()

◆ setOrderDirection()

◆ setOrderField()

◆ setRoleFilter()

◆ setTextFilter()

◆ setUdfFilter()

◆ setUserFilter()

◆ setUserFolder()

Field Documentation

◆ $activation

◆ $additional_fields

◆ $authentication_method

◆ $crs_grp

◆ $default_fields

◆ $first_letter

◆ $has_access

◆ $last_login

◆ $limit

◆ $limited_access

◆ $no_courses

◆ $no_groups

◆ $offset

◆ $order_dir

◆ $order_field

◆ $role

◆ $text_filter

◆ $udf_filter

◆ $user_folder

◆ $users

◆ DEFAULT_ORDER_FIELD