ILIAS\Mail\RecipientSearch\SentMailsBasedProvider Class Reference

@phpstan-import-type AutoCompleteUserRecord from RecipientSearchProvider More...

Inheritance diagram for ILIAS\Mail\RecipientSearch\SentMailsBasedProvider:

Collaboration diagram for ILIAS\Mail\RecipientSearch\SentMailsBasedProvider:

Public Member Functions
	current ()
	key ()
	valid ()
	rewind ()
Public Member Functions inherited from ILIAS\Mail\RecipientSearch\RecipientSearchProvider
	__construct (protected string $quoted_term, protected string $term)
	valid ()
	next ()
	__destruct ()

Private Attributes
array	$users_stack = []

Additional Inherited Members
Protected Attributes inherited from ILIAS\Mail\RecipientSearch\RecipientSearchProvider
ilDBInterface	$db
ilDBStatement	$res = null
array	$data = null
int	$user_id = 0

Detailed Description

@phpstan-import-type AutoCompleteUserRecord from RecipientSearchProvider

Definition at line 26 of file SentMailsBasedProvider..php.

Member Function Documentation

current()

ILIAS\Mail\RecipientSearch\SentMailsBasedProvider::current

(

)

Returns

AutoCompleteUserRecord

Exceptions

OutOfBoundsException

Definition at line 35 of file SentMailsBasedProvider..php.

                             : array
    {
        if (\is_array($this->data) && !empty($this->data)) {
            return [
                'login' => $this->data['login'],
                'firstname' => '',
                'lastname' => '',
            ];
        }
 
        if ($this->users_stack !== []) {
            return [
                'login' => array_shift($this->users_stack),
                'firstname' => '',
                'lastname' => '',
            ];
        }
 
        throw new \OutOfBoundsException('No more users available');
    }

key()

ILIAS\Mail\RecipientSearch\SentMailsBasedProvider::key

(

)

Definition at line 56 of file SentMailsBasedProvider..php.

                         : string
    {
        if (\is_array($this->data) && !empty($this->data)) {
            return $this->data['login'];
        }
 
        if ($this->users_stack !== []) {
            return $this->users_stack[0]['login'];
        }
 
        return '';
    }

rewind()

ILIAS\Mail\RecipientSearch\SentMailsBasedProvider::rewind

(

)

Definition at line 99 of file SentMailsBasedProvider..php.

                            : void
    {
        if ($this->res !== null) {
            $this->db->free($this->res);
            $this->res = null;
        }
 
        $query = '
                        SELECT DISTINCT
                                mail.rcp_to login
                        FROM mail
                        WHERE ' . $this->db->like('mail.rcp_to', 'text', $this->quoted_term) . "
                        AND mail.rcp_to IS NOT NULL AND mail.rcp_to != ''
                        AND sender_id = " . $this->db->quote($this->user_id, 'integer') . '
                        AND mail.sender_id = mail.user_id';
 
        $this->res = $this->db->query($query);
    }

valid()

ILIAS\Mail\RecipientSearch\SentMailsBasedProvider::valid

(

)

Reimplemented from ILIAS\Mail\RecipientSearch\RecipientSearchProvider.

Definition at line 69 of file SentMailsBasedProvider..php.

                           : bool
    {
        $this->data = $this->db->fetchAssoc($this->res);
        if (\is_array($this->data) &&
            !empty($this->data) &&
            (
                strpos((string) $this->data['login'], ',') ||
                strpos((string) $this->data['login'], ';')
            )) {
            $parts = array_filter(
                array_map(
                    'trim',
                    preg_split('/[ ]*[;,][ ]*/', trim((string) $this->data['login']))
                )
            );
 
            foreach ($parts as $part) {
                if (\ilStr::strPos(\ilStr::strToLower($part), \ilStr::strToLower($this->term), 0) !== false) {
                    $this->users_stack[] = $part;
                }
            }
 
            if ($this->users_stack) {
                $this->data = null;
            }
        }
 
        return (\is_array($this->data) && !empty($this->data)) || $this->users_stack !== [];
    }

References $parts, ilStr\strPos(), and ilStr\strToLower().

Here is the call graph for this function:

Field Documentation

$users_stack

array ILIAS\Mail\RecipientSearch\SentMailsBasedProvider::$users_stack = []

private

Definition at line 29 of file SentMailsBasedProvider..php.

---

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

• components/ILIAS/Mail/classes/RecipientSearch/SentMailsBasedProvider..php