Collaboration diagram for ILIAS\User\Profile\DataQuery:

Public Member Functions
	__construct (private readonly \ilDBInterface $db, private readonly string $user_base_table_name, private readonly string $user_values_table_name, array $select_fields)

	withAdditionalAdditionalTableSelectField (string $field_name)

	withAdditionalDefaultTableSelectField (string $field_name)

	withAdditionalUdfField (Field $field)

	withAdditionalMultiField (string $field_name)

	withAdditionalJoin (string $join)

	withAdditionalWhere (string $where)

	withAdditionalMultiDataWhere (string $identifier, string\|array $value)

	withAdditionalTableOrder (string $order)

	withMultiDataTableOrder (string $order_field, string $direction)

	withDefaultTableOrderFields (array $order_fields, string $direction)

	withLimitedUsers (array $users)

	withJoinedMultiDataTable ()

	buildRecordsQueryString ()

	buildCntQueryString ()

	withAdditionalSelectAndJoinForUdfAndMultiValueFields ()

	explodeArrayValues (array $row)

Private Member Functions
	buildWhere ()

	buildJoinForMultiDataTable ()

Private Attributes
const string	ARRAY_SEPARATOR = '##!:!##'

const string	RECORDS_QUERY_INIT = 'SELECT '

string	$cnt_query_init

array	$multi_fields = []

array	$select_fields

array	$udf_fields = []

array	$join = []

array	$where = []

string	$order = ''

bool	$multi_data_table_joined = false

bool	$additional_fields_processed = false

Detailed Description

Definition at line 25 of file DataQuery.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\User\Profile\DataQuery::__construct	(	private readonly \ilDBInterface	$db,
		private readonly string	$user_base_table_name,
		private readonly string	$user_values_table_name,
		array	$select_fields
	)

Definition at line 41 of file DataQuery.php.

      {
        $this->cnt_query_init = 'SELECT COUNT(DISTINCT ' . $this->user_base_table_name
            . '.usr_id) cnt FROM ' . $this->user_base_table_name;
        $this->select_fields = array_map(
            fn(string $v): string => $this->user_base_table_name . '.' . $v,
            $select_fields
        );
    }

References ILIAS\User\Profile\DataQuery\$select_fields.

Member Function Documentation

◆ buildCntQueryString()

ILIAS\User\Profile\DataQuery::buildCntQueryString ( )

Definition at line 166 of file DataQuery.php.

                                         : string
    {
        return $this->cnt_query_init . PHP_EOL
            . implode(PHP_EOL, $this->join) . PHP_EOL
            . 'WHERE usr_data.usr_id <> ' . $this->db->quote(ANONYMOUS_USER_ID, \ilDBConstants::T_INTEGER) . PHP_EOL
            . $this->buildWhere();
    }

References ANONYMOUS_USER_ID, ILIAS\User\Profile\DataQuery\buildWhere(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ buildJoinForMultiDataTable()

ILIAS\User\Profile\DataQuery::buildJoinForMultiDataTable ( )

private

Definition at line 227 of file DataQuery.php.

                                                 : string
    {
        return 'LEFT JOIN ' . $this->user_values_table_name . ' ON '
            . $this->user_values_table_name . '.usr_id = ' . $this->user_base_table_name . '.usr_id';
    }

Referenced by ILIAS\User\Profile\DataQuery\withAdditionalSelectAndJoinForUdfAndMultiValueFields(), and ILIAS\User\Profile\DataQuery\withJoinedMultiDataTable().

Here is the caller graph for this function:

◆ buildRecordsQueryString()

ILIAS\User\Profile\DataQuery::buildRecordsQueryString ( )

Definition at line 155 of file DataQuery.php.

                                             : string
    {
        return self::RECORDS_QUERY_INIT . implode(', ', $this->select_fields) . PHP_EOL
            . 'FROM usr_data' . PHP_EOL
            . implode(PHP_EOL, $this->join) . PHP_EOL
            . 'WHERE usr_data.usr_id <> ' . $this->db->quote(ANONYMOUS_USER_ID, \ilDBConstants::T_INTEGER) . PHP_EOL
            . $this->buildWhere()
            . 'GROUP BY ' . $this->user_base_table_name . '.usr_id' . PHP_EOL
            . $this->order;
    }

References ILIAS\User\Profile\DataQuery\$order, ANONYMOUS_USER_ID, ILIAS\User\Profile\DataQuery\buildWhere(), and ilDBConstants\T_INTEGER.

Referenced by ILIAS\User\Profile\DatabaseDataRepository\retrieveRecordsFromQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildWhere()

ILIAS\User\Profile\DataQuery::buildWhere ( )

private

Definition at line 219 of file DataQuery.php.

                                 : string
    {
        if ($this->where === []) {
            return '';
        }
        return 'AND ' . implode(PHP_EOL . 'AND ', $this->where) . PHP_EOL;
    }

Referenced by ILIAS\User\Profile\DataQuery\buildCntQueryString(), and ILIAS\User\Profile\DataQuery\buildRecordsQueryString().

Here is the caller graph for this function:

◆ explodeArrayValues()

ILIAS\User\Profile\DataQuery::explodeArrayValues ( array $row )

Definition at line 205 of file DataQuery.php.

                                                  : array
    {
        return array_map(
            static function (mixed $v): mixed {
                if (!is_string($v) || mb_stristr($v, self::ARRAY_SEPARATOR) === false) {
                    return $v;
                }
 
                return explode(self::ARRAY_SEPARATOR, $v);
            },
            $row
        );
    }

Referenced by ILIAS\User\Profile\DatabaseDataRepository\retrieveRecordsFromQuery().

Here is the caller graph for this function:

◆ withAdditionalAdditionalTableSelectField()

ILIAS\User\Profile\DataQuery::withAdditionalAdditionalTableSelectField ( string $field_name )

Definition at line 55 of file DataQuery.php.

                                                                                : self
    {
        $clone = clone $this;
        $clone->select_fields[] = $field_name;
        return $clone;
    }

◆ withAdditionalDefaultTableSelectField()

ILIAS\User\Profile\DataQuery::withAdditionalDefaultTableSelectField ( string $field_name )

Definition at line 62 of file DataQuery.php.

                                                                             : self
    {
        $clone = clone $this;
        $clone->select_fields[] = $this->user_base_table_name . '.' . $field_name;
        return $clone;
    }

◆ withAdditionalJoin()

ILIAS\User\Profile\DataQuery::withAdditionalJoin ( string $join )

Definition at line 83 of file DataQuery.php.

                                                    : self
    {
        $clone = clone $this;
        $clone->join[] = $join;
        return $clone;
    }

References ILIAS\User\Profile\DataQuery\$join.

◆ withAdditionalMultiDataWhere()

ILIAS\User\Profile\DataQuery::withAdditionalMultiDataWhere	(	string	$identifier,
		string\|array	$value
	)

Definition at line 97 of file DataQuery.php.

                                                                                         : self
    {
        if (is_array($value)) {
            $value_query = $this->db->in($this->user_values_table_name . '.value', $value, false, \ilDBConstants::T_TEXT);
        } else {
            $value_query = $this->db->like($this->user_values_table_name . '.value', \ilDBConstants::T_TEXT, "%{$value}%");
        }
        $clone = clone $this;
        $clone->where[] = $this->user_values_table_name . ".field_id = '{$identifier}' AND {$value_query}";
        return $clone;
    }

References ilDBConstants\T_TEXT.

◆ withAdditionalMultiField()

ILIAS\User\Profile\DataQuery::withAdditionalMultiField ( string $field_name )

Definition at line 76 of file DataQuery.php.

                                                                : self
    {
        $clone = clone $this;
        $clone->multi_fields[] = $field_name;
        return $clone;
    }

◆ withAdditionalSelectAndJoinForUdfAndMultiValueFields()

ILIAS\User\Profile\DataQuery::withAdditionalSelectAndJoinForUdfAndMultiValueFields ( )

Definition at line 174 of file DataQuery.php.

                                                                          : self
    {
        if ($this->additional_fields_processed
            || $this->multi_fields === [] && $this->udf_fields === []) {
            return $this;
        }
 
        $clone = clone $this;
        if (!$this->multi_data_table_joined) {
            $clone->join[] = $this->buildJoinForMultiDataTable();
            $clone->multi_data_table_joined = true;
        }
 
        foreach ($this->multi_fields as $field) {
            $clone->select_fields[] = 'GROUP_CONCAT(DISTINCT IF(' . $this->user_values_table_name
                . ".field_id = {$this->db->quote($field, \ilDBConstants::T_TEXT)}, "
                . $this->user_values_table_name . '.value, NULL) '
                . "SEPARATOR '" . self::ARRAY_SEPARATOR . "') `{$field}`";
        }
 
        foreach ($this->udf_fields as $field) {
            $clone->select_fields[] = 'GROUP_CONCAT(DISTINCT IF(' . $this->user_values_table_name
                . ".field_id = {$this->db->quote($field->getIdentifier(), \ilDBConstants::T_TEXT)}, "
                . $this->user_values_table_name . '.value, NULL) '
                . "SEPARATOR '" . self::ARRAY_SEPARATOR . "') `udf_{$field->getIdentifier()}`";
        }
 
        $clone->additional_fields_processed = true;
        return $clone;
    }

References ILIAS\User\Profile\DataQuery\buildJoinForMultiDataTable().

Here is the call graph for this function:

◆ withAdditionalTableOrder()

ILIAS\User\Profile\DataQuery::withAdditionalTableOrder ( string $order )

Definition at line 109 of file DataQuery.php.

                                                           : self
    {
        $clone = clone $this;
        $clone->order = $order;
        return $clone;
    }

References ILIAS\User\Profile\DataQuery\$order.

Referenced by ilUserQuery\addOrderToQuery().

Here is the caller graph for this function:

◆ withAdditionalUdfField()

ILIAS\User\Profile\DataQuery::withAdditionalUdfField ( Field $field )

Definition at line 69 of file DataQuery.php.

                                                        : self
    {
        $clone = clone $this;
        $clone->udf_fields[] = $field;
        return $clone;
    }

◆ withAdditionalWhere()

ILIAS\User\Profile\DataQuery::withAdditionalWhere ( string $where )

Definition at line 90 of file DataQuery.php.

                                                      : self
    {
        $clone = clone $this;
        $clone->where[] = $where;
        return $clone;
    }

References ILIAS\User\Profile\DataQuery\$where.

◆ withDefaultTableOrderFields()

ILIAS\User\Profile\DataQuery::withDefaultTableOrderFields	(	array	$order_fields,
		string	$direction
	)

Definition at line 123 of file DataQuery.php.

                                                                                       : self
    {
        $clone = clone $this;
        $clone->order = 'ORDER BY ' . implode(', ', array_reduce(
            $order_fields,
            function (array $c, string $v) use ($direction): array {
                $c[] = $this->user_base_table_name . ".`{$v}` {$direction}";
                return $c;
            },
            []
        ));
        return $clone;
    }

References $c.

Referenced by ilUserQuery\addOrderToQuery().

Here is the caller graph for this function:

◆ withJoinedMultiDataTable()

ILIAS\User\Profile\DataQuery::withJoinedMultiDataTable ( )

Definition at line 147 of file DataQuery.php.

                                              : self
    {
        $clone = clone $this;
        $clone->join[] = $this->buildJoinForMultiDataTable();
        $clone->multi_data_table_joined = true;
        return $clone;
    }

References ILIAS\User\Profile\DataQuery\buildJoinForMultiDataTable().

Referenced by ilUserQuery\addUdfFilterToQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withLimitedUsers()

ILIAS\User\Profile\DataQuery::withLimitedUsers ( array $users )

Definition at line 137 of file DataQuery.php.

                                                  : self
    {
        if ($users === []) {
            return $this;
        }
        $clone = clone $this;
        $clone->where[] = $this->db->in('usr_data.usr_id', $users, false, \ilDBConstants::T_INTEGER);
        return $clone;
    }

References ilDBConstants\T_INTEGER.

◆ withMultiDataTableOrder()

ILIAS\User\Profile\DataQuery::withMultiDataTableOrder	(	string	$order_field,
		string	$direction
	)

Definition at line 116 of file DataQuery.php.

                                                                                   : self
    {
        $clone = clone $this;
        $clone->order = "ORDER BY `{$order_field}` {$direction}";
        return $clone;
    }

Referenced by ilUserQuery\addOrderToQuery().

Here is the caller graph for this function:

Field Documentation

◆ $additional_fields_processed

bool ILIAS\User\Profile\DataQuery::$additional_fields_processed = false

private

Definition at line 39 of file DataQuery.php.

◆ $cnt_query_init

string ILIAS\User\Profile\DataQuery::$cnt_query_init

private

Definition at line 30 of file DataQuery.php.

◆ $join

array ILIAS\User\Profile\DataQuery::$join = []

private

Definition at line 35 of file DataQuery.php.

Referenced by ILIAS\User\Profile\DataQuery\withAdditionalJoin().

◆ $multi_data_table_joined

bool ILIAS\User\Profile\DataQuery::$multi_data_table_joined = false

private

Definition at line 38 of file DataQuery.php.

◆ $multi_fields

array ILIAS\User\Profile\DataQuery::$multi_fields = []

private

Definition at line 32 of file DataQuery.php.

◆ $order

string ILIAS\User\Profile\DataQuery::$order = ''

private

Definition at line 37 of file DataQuery.php.

Referenced by ILIAS\User\Profile\DataQuery\buildRecordsQueryString(), and ILIAS\User\Profile\DataQuery\withAdditionalTableOrder().

◆ $select_fields

array ILIAS\User\Profile\DataQuery::$select_fields

private

Definition at line 33 of file DataQuery.php.

Referenced by ILIAS\User\Profile\DataQuery\__construct().

◆ $udf_fields

array ILIAS\User\Profile\DataQuery::$udf_fields = []

private

Definition at line 34 of file DataQuery.php.

◆ $where

array ILIAS\User\Profile\DataQuery::$where = []

private

Definition at line 36 of file DataQuery.php.

Referenced by ILIAS\User\Profile\DataQuery\withAdditionalWhere().

◆ ARRAY_SEPARATOR

const string ILIAS\User\Profile\DataQuery::ARRAY_SEPARATOR = '##!:!##'

private

Definition at line 27 of file DataQuery.php.

◆ RECORDS_QUERY_INIT

const string ILIAS\User\Profile\DataQuery::RECORDS_QUERY_INIT = 'SELECT '

private

Definition at line 28 of file DataQuery.php.

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

components/ILIAS/User/src/Profile/DataQuery.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildCntQueryString()

◆ buildJoinForMultiDataTable()

◆ buildRecordsQueryString()

◆ buildWhere()

◆ explodeArrayValues()

◆ withAdditionalAdditionalTableSelectField()

◆ withAdditionalDefaultTableSelectField()

◆ withAdditionalJoin()

◆ withAdditionalMultiDataWhere()

◆ withAdditionalMultiField()

◆ withAdditionalSelectAndJoinForUdfAndMultiValueFields()

◆ withAdditionalTableOrder()

◆ withAdditionalUdfField()

◆ withAdditionalWhere()

◆ withDefaultTableOrderFields()

◆ withJoinedMultiDataTable()

◆ withLimitedUsers()

◆ withMultiDataTableOrder()

Field Documentation

◆ $additional_fields_processed

◆ $cnt_query_init

◆ $join

◆ $multi_data_table_joined

◆ $multi_fields

◆ $order

◆ $select_fields

◆ $udf_fields

◆ $where

◆ ARRAY_SEPARATOR

◆ RECORDS_QUERY_INIT