User query class. More...

Collaboration diagram for ilUserQuery:

Public Member Functions
	setUdfFilter (array $filter_array)
	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 $user_folder_id)
	Set user folder filter reference id of user folder or category (local user administration) More...

	setAdditionalFields (array $additional_fields)
	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...

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 = []

Private Member Functions
	addOrderToQuery (DataQuery $query)

	addUdfFilterToQuery (DataQuery $query)

Private Attributes
const array	DEFAULT_MULTI_FIELDS

const array	DEFAULT_FIELDS

Language	$lng

ilDBInterface	$db

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 = []

array	$additional_fields = []

array	$users = []

string	$first_letter = ''

bool	$has_access = false

string	$authentication_method = ''

ProfileFieldsConfigurationRepository	$profile_fields_repository

ProfileDataRepository	$profile_data_repository

Detailed Description

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 32 of file class.ilUserQuery.php.

Member Function Documentation

◆ addOrderToQuery()

ilUserQuery::addOrderToQuery ( DataQuery $query )

private

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

                                                      : DataQuery
    {
        $direction = $this->order_dir === 'desc' ? 'DESC' : 'ASC';
        switch ($this->order_field) {
            case 'access_until':
                return $query->withDefaultTableOrderFields(
                    ['active', 'time_limit_unlimited', 'time_limit_until'],
                    $direction
                );
 
            case 'online_time':
                return $query->withAdditionalTableOrder("ORDER BY ut_online.online_time {$direction}");
 
            default:
                if (!in_array($this->order_field, array_merge(self::DEFAULT_FIELDS, $this->additional_fields))) {
                    $this->order_field = 'login';
                }
 
                if (in_array($this->order_field, self::DEFAULT_MULTI_FIELDS)
                    || str_starts_with($this->order_field, 'udf_')) {
                    return $query->withMultiDataTableOrder($this->order_field, $this->order_dir);
                }
 
                return $query->withDefaultTableOrderFields([$this->order_field], $this->order_dir);
        }
    }

References ILIAS\User\Profile\DataQuery\withAdditionalTableOrder(), ILIAS\User\Profile\DataQuery\withDefaultTableOrderFields(), and ILIAS\User\Profile\DataQuery\withMultiDataTableOrder().

Here is the call graph for this function:

◆ addUdfFilterToQuery()

ilUserQuery::addUdfFilterToQuery ( DataQuery $query )

private

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

                                                          : DataQuery
    {
        if ($this->getUdfFilter() === []) {
            return $query;
        }
 
        $udf_filter = $this->getUdfFilter();
        return array_reduce(
            array_keys(
                array_filter($udf_filter)
            ),
            fn(DataQuery $c, string $v): DataQuery => $c->withAdditionalMultiDataWhere(
                $v,
                $udf_filter[$v]
            ),
            $query->withJoinedMultiDataTable()
        );
    }

References $c, $udf_filter, getUdfFilter(), and ILIAS\User\Profile\DataQuery\withJoinedMultiDataTable().

Here is the call graph for this function:

◆ getUdfFilter()

ilUserQuery::getUdfFilter ( )

Get udf filter.

Returns: array udf filter array

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

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

References $udf_filter.

Referenced by addUdfFilterToQuery().

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 476 of file class.ilUserQuery.php.

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

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

Here is the caller graph for this function:

◆ setAccessFilter()

ilUserQuery::setAccessFilter ( bool $a_access )

set filter for user that are limited but has access

Definition at line 248 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 163 of file class.ilUserQuery.php.

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

◆ setAdditionalFields()

ilUserQuery::setAdditionalFields ( array $additional_fields )

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

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

                                                                 : void
    {
        $this->additional_fields = $additional_fields;
    }

References $additional_fields.

◆ setAuthenticationFilter()

ilUserQuery::setAuthenticationFilter ( string $a_authentication )

Set authentication filter.

Parameters

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

Definition at line 257 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 198 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 240 of file class.ilUserQuery.php.

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

◆ setLastLogin()

ilUserQuery::setLastLogin ( ?ilDateTime $dt = null )

Set last login filter.

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

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

◆ setLimit()

ilUserQuery::setLimit ( int $a_limit )

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

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

◆ setLimitedAccessFilter()

ilUserQuery::setLimitedAccessFilter ( bool $a_status )

Enable limited access filter.

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

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

◆ setNoCourseFilter()

ilUserQuery::setNoCourseFilter ( bool $a_no_course )

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

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

◆ setNoGroupFilter()

ilUserQuery::setNoGroupFilter ( bool $a_no_group )

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

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

◆ setOffset()

ilUserQuery::setOffset ( int $a_offset )

Definition at line 141 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 136 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 126 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 207 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 154 of file class.ilUserQuery.php.

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

◆ setUdfFilter()

ilUserQuery::setUdfFilter ( array $filter_array )

Set udf filter.

Parameters

array $a_val udf filter array

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

                                                     : void // Missing array type.
    {
        $this->udf_filter = array_reduce(
            array_keys($filter_array),
            function (array $c, string $v) use ($filter_array): array {
                if ($filter_array[$v] === '') {
                    return $c;
                }
                $c[mb_substr($v, 4)] = $filter_array[$v];
                return $c;
            },
            []
        );
    }

References $c.

◆ setUserFilter()

ilUserQuery::setUserFilter ( array $a_filter )

Array with user ids to query against.

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

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

◆ setUserFolder()

ilUserQuery::setUserFolder ( ?array $user_folder_id )

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

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

                                                         : void
    {
        $this->user_folder = $user_folder_id ?? [];
    }

Field Documentation

◆ $activation

string ilUserQuery::$activation = ''

private

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

◆ $additional_fields

array ilUserQuery::$additional_fields = []

private

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

Referenced by setAdditionalFields().

◆ $authentication_method

string ilUserQuery::$authentication_method = ''

private

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

◆ $crs_grp

int ilUserQuery::$crs_grp = 0

private

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

◆ $db

ilDBInterface ilUserQuery::$db

private

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

◆ $first_letter

string ilUserQuery::$first_letter = ''

private

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

◆ $has_access

bool ilUserQuery::$has_access = false

private

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

◆ $last_login

ilDateTime ilUserQuery::$last_login = null

private

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

◆ $limit

int ilUserQuery::$limit = 50

private

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

◆ $limited_access

bool ilUserQuery::$limited_access = false

private

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

◆ $lng

Language ilUserQuery::$lng

private

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

◆ $no_courses

bool ilUserQuery::$no_courses = false

private

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

◆ $no_groups

bool ilUserQuery::$no_groups = false

private

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

◆ $offset

int ilUserQuery::$offset = 0

private

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

◆ $order_dir

string ilUserQuery::$order_dir = 'asc'

private

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

◆ $order_field

string ilUserQuery::$order_field = self::DEFAULT_ORDER_FIELD

private

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

◆ $profile_data_repository

ProfileDataRepository ilUserQuery::$profile_data_repository

private

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

◆ $profile_fields_repository

ProfileFieldsConfigurationRepository ilUserQuery::$profile_fields_repository

private

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

◆ $role

int ilUserQuery::$role = 0

private

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

◆ $text_filter

string ilUserQuery::$text_filter = ''

private

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

◆ $udf_filter

array ilUserQuery::$udf_filter = []

protected

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

Referenced by addUdfFilterToQuery(), and getUdfFilter().

◆ $user_folder

array ilUserQuery::$user_folder = []

private

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

◆ $users

array ilUserQuery::$users = []

private

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

◆ DEFAULT_FIELDS

const array ilUserQuery::DEFAULT_FIELDS

private

Initial value:

= [
        'usr_id',
        'login',
        'firstname',
        'lastname',
        'email',
        'second_email',
        'time_limit_until',
        'time_limit_unlimited',
        'time_limit_owner',
        'last_login',
        'active'
    ]

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

◆ DEFAULT_MULTI_FIELDS

const array ilUserQuery::DEFAULT_MULTI_FIELDS

private

Initial value:

= [
        'interests_general',
        'interests_help_offered',
        'interests_help_looking'
    ]

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

◆ DEFAULT_ORDER_FIELD

const ilUserQuery::DEFAULT_ORDER_FIELD = 'login'

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

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

components/ILIAS/User/classes/class.ilUserQuery.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addOrderToQuery()

◆ addUdfFilterToQuery()

◆ getUdfFilter()

◆ getUserListData()

◆ 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

◆ $db

◆ $first_letter

◆ $has_access

◆ $last_login

◆ $limit

◆ $limited_access

◆ $lng

◆ $no_courses

◆ $no_groups

◆ $offset

◆ $order_dir

◆ $order_field

◆ $profile_data_repository

◆ $profile_fields_repository

◆ $role

◆ $text_filter

◆ $udf_filter

◆ $user_folder

◆ $users

◆ DEFAULT_FIELDS

◆ DEFAULT_MULTI_FIELDS

◆ DEFAULT_ORDER_FIELD