ilMailAutoCompleteUserProvider Class Reference

Inheritance diagram for ilMailAutoCompleteUserProvider:

Collaboration diagram for ilMailAutoCompleteUserProvider:

Public Member Functions
	current ()
	key ()
	rewind ()
Public Member Functions inherited from ilMailAutoCompleteRecipientProvider
	__construct (protected string $quoted_term, protected string $term)
	valid ()
	next ()
	__destruct ()

Protected Member Functions
	getSelectPart ()
	getFromPart ()
	getWherePart (string $search_query)
	getOrderByPart ()
	getQueryConditionByFieldAndValue (string $field, $a_str)
	getFields ()

Additional Inherited Members
Protected Attributes inherited from ilMailAutoCompleteRecipientProvider
ilDBInterface	$db
ilDBStatement	$res = null
array	$data = null
int	$user_id = 0

Detailed Description

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

Member Function Documentation

current()

ilMailAutoCompleteUserProvider::current

(

)

Returns

array{login: string, firstname: string, lastname:string}

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

                             : array
    {
        return [
            'login' => $this->data['login'],
            'firstname' => $this->data['firstname'],
            'lastname' => $this->data['lastname'],
        ];
    }

getFields()

ilMailAutoCompleteUserProvider::getFields ( )

protected

Returns

string[]

Definition at line 176 of file class.ilMailAutoCompleteUserProvider.php.

                                  : array
    {
        $available_fields = [];
        foreach (['firstname', 'lastname'] as $field) {
            if (ilUserSearchOptions::_isEnabled($field)) {
                $available_fields[] = $field;
            }
        }
        return $available_fields;
    }

References ilUserSearchOptions\_isEnabled().

Referenced by getWherePart().

Here is the call graph for this function:

Here is the caller graph for this function:

getFromPart()

ilMailAutoCompleteUserProvider::getFromPart ( )

protected

Reimplemented in ilMailAutoCompleteBuddyRecipientsProvider.

Definition at line 89 of file class.ilMailAutoCompleteUserProvider.php.

                                    : string
    {
        $joins = [];
 
        $joins[] = '
                        LEFT JOIN usr_pref profpref
                        ON profpref.usr_id = usr_data.usr_id
                        AND profpref.keyword = ' . $this->db->quote('public_profile', 'text');
 
        $joins[] = '
                        LEFT JOIN usr_pref pubemail
                        ON pubemail.usr_id = usr_data.usr_id
                        AND pubemail.keyword = ' . $this->db->quote('public_email', 'text');
 
        return 'usr_data ' . implode(' ', $joins);
    }

Referenced by rewind().

Here is the caller graph for this function:

getOrderByPart()

ilMailAutoCompleteUserProvider::getOrderByPart ( )

protected

Definition at line 163 of file class.ilMailAutoCompleteUserProvider.php.

                                       : string
    {
        return 'login ASC';
    }

Referenced by rewind().

Here is the caller graph for this function:

getQueryConditionByFieldAndValue()

ilMailAutoCompleteUserProvider::getQueryConditionByFieldAndValue ( string  $field,   $a_str  )

protected

Definition at line 168 of file class.ilMailAutoCompleteUserProvider.php.

                                                                              : string
    {
        return $this->db->like($field, 'text', $a_str . '%');
    }

Referenced by getWherePart().

Here is the caller graph for this function:

getSelectPart()

ilMailAutoCompleteUserProvider::getSelectPart ( )

protected

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

                                      : string
    {
        $fields = [
            'login',
            sprintf(
                '(CASE WHEN (firstname IS NOT NULL AND (profpref.value = %s OR profpref.value = %s)) THEN firstname ELSE \'\' END) firstname',
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text')
            ),
            sprintf(
                '(CASE WHEN (lastname IS NOT NULL AND (profpref.value = %s OR profpref.value = %s)) THEN lastname ELSE \'\' END) lastname',
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text')
            ),
            sprintf(
                '(CASE WHEN (email IS NOT NULL AND (profpref.value = %s OR profpref.value = %s) ' .
                "AND pubemail.value = %s) THEN email ELSE '' END) email",
                $this->db->quote('y', 'text'),
                $this->db->quote('g', 'text'),
                $this->db->quote('y', 'text')
            ),
        ];
 
        $fields[] = 'profpref.value profile_value';
        $fields[] = 'pubemail.value email_value';
 
        return implode(', ', $fields);
    }

Referenced by rewind().

Here is the caller graph for this function:

getWherePart()

ilMailAutoCompleteUserProvider::getWherePart ( string  $search_query )

protected

Definition at line 106 of file class.ilMailAutoCompleteUserProvider.php.

                                                         : string
    {
        $outer_conditions = [];
        $outer_conditions[] = 'usr_data.usr_id != ' . $this->db->quote(ANONYMOUS_USER_ID, 'integer');
        $outer_conditions[] = 'usr_data.active != ' . $this->db->quote(0, 'integer');
 
        $field_conditions = [];
        foreach ($this->getFields() as $field) {
            $field_condition = $this->getQueryConditionByFieldAndValue($field, $search_query);
 
            if ('email' === $field) {
                // If privacy should be respected,
                // the profile setting of every user concerning the email address has to be
                // respected (in every user context, no matter if the user is 'logged in' or 'anonymous').
                $email_query = [];
                $email_query[] = $field_condition;
                $email_query[] = 'pubemail.value = ' . $this->db->quote('y', 'text');
                $field_conditions[] = '(' . implode(' AND ', $email_query) . ')';
            } else {
                $field_conditions[] = $field_condition;
            }
        }
 
        // If the current user context ist 'logged in' and privacy should be respected,
        // all fields >>>except the login<<<
        // should only be searchable if the users' profile is published (y oder g)
        // In 'anonymous' context we do not need this additional conditions,
        // because we checked the privacy setting in the condition above: profile = 'g'
        if ($field_conditions !== []) {
            $fields = '(' . implode(' OR ', $field_conditions) . ')';
 
            $field_conditions = ['(' . implode(' AND ', [
                $fields,
                $this->db->in('profpref.value', ['y', 'g'], false, 'text'),
            ]) . ')'];
        }
 
        // The login field must be searchable regardless (for 'logged in' users) of any privacy settings.
        // We handled the general condition for 'anonymous' context above: profile = 'g'
        $field_conditions[] = $this->getQueryConditionByFieldAndValue('login', $search_query);
 
        if (ilUserAccountSettings::getInstance()->isUserAccessRestricted()) {
            $outer_conditions[] = $this->db->in(
                'time_limit_owner',
                ilUserFilter::getInstance()->getFolderIds(),
                false,
                'integer'
            );
        }
 
        if ($field_conditions !== []) {
            $outer_conditions[] = '(' . implode(' OR ', $field_conditions) . ')';
        }
 
        return implode(' AND ', $outer_conditions);
    }

References ANONYMOUS_USER_ID, getFields(), ilUserAccountSettings\getInstance(), ilUserFilter\getInstance(), and getQueryConditionByFieldAndValue().

Referenced by rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

key()

ilMailAutoCompleteUserProvider::key

(

)

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

                         : string
    {
        return $this->data['login'];
    }

rewind()

ilMailAutoCompleteUserProvider::rewind

(

)

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

                            : void
    {
        if ($this->res !== null) {
            $this->db->free($this->res);
            $this->res = null;
        }
 
        $select_part = $this->getSelectPart();
        $where_part = $this->getWherePart($this->quoted_term);
        $order_by_part = $this->getOrderByPart();
        $query = implode(' ', [
            'SELECT ' . $select_part,
            'FROM ' . $this->getFromPart(),
            $where_part !== '' ? 'WHERE ' . $where_part : '',
            $order_by_part !== '' ? 'ORDER BY ' . $order_by_part : '',
        ]);
 
        $this->res = $this->db->query($query);
    }

References getFromPart(), getOrderByPart(), getSelectPart(), and getWherePart().

Here is the call graph for this function:

---

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

• components/ILIAS/Mail/classes/class.ilMailAutoCompleteUserProvider.php